IMP logo
IMP Reference Guide  develop.36b5e40f34,2024/10/14
The Integrative Modeling Platform
example_config.h
1 // Autogenerated by ../../../../tmp/nightly-build-467/imp-20241014.develop.36b5e40f34/tools/build/setup_module.py
2 // from ../../../../tmp/nightly-build-467/imp-20241014.develop.36b5e40f34/tools/build/config_templates/header.h
3 // Do not edit - any changes will be lost!
4 
5 /*
6  * \file IMP/example/example_config.h
7  * \brief Provide macros to mark functions and classes as exported
8  * from a DLL/.so, and to set up namespaces
9  *
10  * When building the module, IMPEXAMPLE_EXPORTS should be defined, and when
11  * using the module externally, it should not be. Classes and functions
12  * declared in the module's headers should then be marked with
13  * IMPEXAMPLEEXPORT if they are intended to be part of the API and
14  * they are not defined entirely in a header.
15  *
16  * The Windows build environment requires applications to mark exports in
17  * this way; we use the same markings to set the visibility of ELF symbols
18  * if we have compiler support.
19  *
20  * All code in this module should live in the IMP::example namespace.
21  * This is simply achieved by wrapping things with the
22  * IMPEXAMPLE_BEGIN_NAMESPACE and IMPEXAMPLE_END_NAMESPACE macros.
23  * There are similar macros for module code that is designed to be for
24  * internal use only.
25  *
26  * Copyright 2007-2022 IMP Inventors. All rights reserved.
27  *
28  */
29 
30 #ifndef IMPEXAMPLE_CONFIG_H
31 #define IMPEXAMPLE_CONFIG_H
32 
33 #include <IMP/kernel_config.h>
34 #include <string>
35 
36 #ifdef _MSC_VER
37 #define NOMINMAX
38 
39 #ifdef IMPEXAMPLE_EXPORTS
40 #define IMPEXAMPLEEXPORT __declspec(dllexport)
41 #else // EXPORTS
42 #define IMPEXAMPLEEXPORT __declspec(dllimport)
43 #endif // EXPORTS
44 
45 #else // _MSC_VER
46 
47 #ifdef GCC_VISIBILITY
48 #define IMPEXAMPLEEXPORT __attribute__((visibility("default")))
49 #else // GCC_VISIBILITY
50 #define IMPEXAMPLEEXPORT
51 #endif // GCC_VISIBILITY
52 
53 #endif // _MSC_VER
54 
55 #if defined(_MSC_VER) && !defined(SWIG)
56 #ifdef IMPEXAMPLE_EXPORTS
57 
58 #define IMPEXAMPLE_EXPORT_TEMPLATE(name) \
59  template class __declspec(dllexport) name
60 
61 #else //EXPORTS
62 
63 #define IMPEXAMPLE_EXPORT_TEMPLATE(name) \
64  template class __declspec(dllimport) name
65 
66 #endif // EXPORTS
67 
68 #else // MSC and SWIG
69 #define IMPEXAMPLE_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
70 
71 #endif // MSC and SWIG
72 
73 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
74 
75 #define IMPEXAMPLE_BEGIN_NAMESPACE \
76  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{ namespace example {
77 
78 #define IMPEXAMPLE_END_NAMESPACE } } \
79 IMP_COMPILER_DISABLE_WARNINGS
80 
81 #define IMPEXAMPLE_BEGIN_INTERNAL_NAMESPACE IMPEXAMPLE_BEGIN_NAMESPACE \
82  namespace internal {
83 
84 #define IMPEXAMPLE_END_INTERNAL_NAMESPACE } IMPEXAMPLE_END_NAMESPACE
85 
86 #else // SWIG and DOXYGEN
87 #define IMPEXAMPLE_BEGIN_NAMESPACE namespace IMP{ namespace example {
88 
89 #define IMPEXAMPLE_END_NAMESPACE } }
90 
91 #define IMPEXAMPLE_BEGIN_INTERNAL_NAMESPACE IMPEXAMPLE_BEGIN_NAMESPACE\
92  namespace internal {
93 
94 #define IMPEXAMPLE_END_INTERNAL_NAMESPACE } IMPEXAMPLE_END_NAMESPACE
95 
96 #endif // SWIG AND DOXYGEN
97 
98 #define IMP_EXAMPLE_USE_IMP_ALGEBRA
99 #define IMP_EXAMPLE_HAS_IMP_ALGEBRA 1
100 #define IMP_EXAMPLE_USE_IMP_CGAL
101 #define IMP_EXAMPLE_HAS_IMP_CGAL 1
102 #define IMP_EXAMPLE_USE_IMP_DISPLAY
103 #define IMP_EXAMPLE_HAS_IMP_DISPLAY 1
104 #define IMP_EXAMPLE_USE_IMP_EM
105 #define IMP_EXAMPLE_HAS_IMP_EM 1
106 #define IMP_EXAMPLE_USE_IMP_ISD
107 #define IMP_EXAMPLE_HAS_IMP_ISD 1
108 #define IMP_EXAMPLE_USE_IMP_KERNEL
109 #define IMP_EXAMPLE_HAS_IMP_KERNEL 1
110 #define IMP_EXAMPLE_USE_IMP_RMF
111 #define IMP_EXAMPLE_HAS_IMP_RMF 1
112 #define IMP_EXAMPLE_USE_IMP_SAXS
113 #define IMP_EXAMPLE_HAS_IMP_SAXS 1
114 #define IMP_EXAMPLE_USE_IMP_SCORE_FUNCTOR
115 #define IMP_EXAMPLE_HAS_IMP_SCORE_FUNCTOR 1
116 #define IMP_EXAMPLE_USE_IMP_STATISTICS
117 #define IMP_EXAMPLE_HAS_IMP_STATISTICS 1
118 #define IMP_EXAMPLE_USE_BOOST_FILESYSTEM
119 #define IMP_EXAMPLE_HAS_BOOST_FILESYSTEM 1
120 #define IMP_EXAMPLE_USE_BOOST_GRAPH
121 #define IMP_EXAMPLE_HAS_BOOST_GRAPH 1
122 #define IMP_EXAMPLE_USE_BOOST_PROGRAMOPTIONS
123 #define IMP_EXAMPLE_HAS_BOOST_PROGRAMOPTIONS 1
124 #define IMP_EXAMPLE_USE_BOOST_RANDOM
125 #define IMP_EXAMPLE_HAS_BOOST_RANDOM 1
126 #define IMP_EXAMPLE_USE_BOOST_REGEX
127 #define IMP_EXAMPLE_HAS_BOOST_REGEX 1
128 #define IMP_EXAMPLE_USE_BOOST_SYSTEM
129 #define IMP_EXAMPLE_HAS_BOOST_SYSTEM 1
130 #define IMP_EXAMPLE_USE_CGAL
131 #define IMP_EXAMPLE_HAS_CGAL 1
132 #define IMP_EXAMPLE_USE_HDF5
133 #define IMP_EXAMPLE_HAS_HDF5 1
134 #define IMP_EXAMPLE_USE_NUMPY
135 #define IMP_EXAMPLE_HAS_NUMPY 1
136 #define IMP_EXAMPLE_USE_RMF
137 #define IMP_EXAMPLE_HAS_RMF 1
138 #define IMP_EXAMPLE_USE_PYTHON_IHM
139 #define IMP_EXAMPLE_HAS_PYTHON_IHM 1
140 #define IMP_EXAMPLE_NO_EXAMPLEDEPENDENCY
141 #define IMP_EXAMPLE_HAS_EXAMPLEDEPENDENCY 0
142 
143 // functions are defined explicitly for SWIG
144 namespace IMP{ namespace example {
145 /** \name Standard module functions
146  All \imp modules have a set of standard functions to help get information
147  about the module and about files associated with the module.
148  @{
149  */
150 #if !defined(SWIG)
151  IMPEXAMPLEEXPORT std::string get_module_version();
152 #endif
153 
154 #if !defined(SWIG)
155  // SWIG will whine about duplicate definitions of function
156  inline std::string get_module_name() { return "IMP::example"; }
157 #endif
158 
159  //! Return the full path to one of this module's data files
160  /** To read the data file "data_library" that was placed in the \c data
161  directory of this module, do something like
162  \code
163  std::ifstream in(IMP::example::get_data_path("data_library"));
164  \endcode
165  This will ensure that the code works both when IMP is installed or
166  if used via the \c setup_environment.sh script.
167 
168  \note Each module has its own data directory, so be sure to use
169  this function from the correct module.
170  */
171 #if !defined(SWIG)
172  IMPEXAMPLEEXPORT std::string get_data_path(std::string file_name);
173 #endif
174 
175  //! Return the full path to one of this module's example files
176  /** To read the example file "example_protein.pdb" that was placed
177  in the \c examples directory of this module, do something like
178  \code
179  std::ifstream in(IMP::example::get_example_path("example_protein.pdb"));
180  \endcode
181  This will ensure that the code works both when IMP is installed or
182  if used via the \c setup_environment.sh script.
183 
184  \note Each module has its own example directory, so be sure to use
185  this function from the correct module.
186  */
187 #if !defined(SWIG)
188  IMPEXAMPLEEXPORT std::string get_example_path(std::string file_name);
189 #endif
190  /** @} */
191 
192 
193 } } //namespace
194 
195 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
196 
197 #include <IMP/Showable.h>
198 #include <IMP/hash.h>
199 
200 namespace IMP{ namespace example {
201 using ::IMP::Showable;
202 using ::IMP::operator<<;
203 using ::IMP::hash_value;
204 } } // namespace
205 namespace IMP{ namespace example { namespace internal {
206 using ::IMP::Showable;
207 using ::IMP::operator<<;
208 using ::IMP::hash_value;
209 } } } // namespace
210 
211 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
212 
213 
214 #include <IMP/compiler_macros.h>
215 
216 #endif /* IMPEXAMPLE_CONFIG_H */
217 
218 // Here so it is always parsed
219 
220 #ifdef IMPEXAMPLE_DEPRECATED_HEADER
221 #undef IMPEXAMPLE_DEPRECATED_HEADER
222 #undef IMPEXAMPLE_DEPRECATED_VALUE_DEF
223 #undef IMPEXAMPLE_DEPRECATED_VALUE_DECL
224 #undef IMPEXAMPLE_DEPRECATED_OBJECT_DEF
225 #undef IMPEXAMPLE_DEPRECATED_OBJECT_DECL
226 #undef IMPEXAMPLE_DEPRECATED_FUNCTION_DEF
227 #undef IMPEXAMPLE_DEPRECATED_FUNCTION_DECL
228 #undef IMPEXAMPLE_DEPRECATED_METHOD_DEF
229 #undef IMPEXAMPLE_DEPRECATED_METHOD_DECL
230 #undef IMPEXAMPLE_DEPRECATED_MACRO
231 #undef IMPEXAMPLE_SHOW_WARNINGS
232 #endif
233 
234 // the central modules we can update easily, so don't warn in them
235 #if defined( IMPEXAMPLE_COMPILATION) \
236  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
237  || defined( IMPEXAMPLE_ALL) || defined(IMP_DOXYGEN) \
238  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
239  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
240  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
241  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
242  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
243  || defined(IMPGSL_COMPILATION)
244 #define IMPEXAMPLE_SHOW_WARNINGS 0
245 #else
246 #define IMPEXAMPLE_SHOW_WARNINGS 1
247 #endif
248 
249 // suppress header warnings with all header, SWIG wrapper and in the module
250 #if IMPEXAMPLE_SHOW_WARNINGS
251 #define IMPEXAMPLE_DEPRECATED_HEADER(version, help_message) \
252  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
253 #define IMPEXAMPLE_DEPRECATED_VALUE_DECL(version) \
254  IMP_DEPRECATED_ATTRIBUTE
255 #define IMPEXAMPLE_DEPRECATED_OBJECT_DECL(version) \
256  IMP_DEPRECATED_ATTRIBUTE
257 #define IMPEXAMPLE_DEPRECATED_FUNCTION_DECL(version) \
258  IMP_DEPRECATED_ATTRIBUTE
259 #define IMPEXAMPLE_DEPRECATED_METHOD_DECL(version) \
260  IMP_DEPRECATED_ATTRIBUTE
261 
262 #else //IMPEXAMPLE_SHOW_WARNINGS
263 /** See [deprecation support](@ref deprecation). */
264 #define IMPEXAMPLE_DEPRECATED_HEADER(version, help_message) \
265 /** See [deprecation support](@ref deprecation). */
266 #define IMPEXAMPLE_DEPRECATED_VALUE_DECL(version)
267 /** See [deprecation support](@ref deprecation). */
268 #define IMPEXAMPLE_DEPRECATED_OBJECT_DECL(version)
269 /** See [deprecation support](@ref deprecation). */
270 #define IMPEXAMPLE_DEPRECATED_FUNCTION_DECL(version)
271 /** See [deprecation support](@ref deprecation). */
272 #define IMPEXAMPLE_DEPRECATED_METHOD_DECL(version)
273 
274 #endif // IMPEXAMPLE_SHOW_WARNINGS
275 
276 // only warn about it in the all inclusion to cut down on copies
277 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
278  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
279  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
280  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
281  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
282  || defined(IMPSCOREFUNCTOR_COMPILATION)
283 /** See [deprecation support](@ref deprecation). */
284 #define IMPEXAMPLE_DEPRECATED_MACRO(version, message)
285 
286 #else
287 #define IMPEXAMPLE_DEPRECATED_MACRO(version, message) \
288  IMP_DEPRECATED_MACRO(version, message)
289 #endif
290 
291 /** See [deprecation support](@ref deprecation). */
292 #define IMPEXAMPLE_DEPRECATED_VALUE_DEF(version, message) \
293  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
294 
295 /** See [deprecation support](@ref deprecation). */
296 #define IMPEXAMPLE_DEPRECATED_OBJECT_DEF(version, message) \
297  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
298 
299 /** See [deprecation support](@ref deprecation). */
300 #define IMPEXAMPLE_DEPRECATED_FUNCTION_DEF(version, message) \
301  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
302 
303 /** See [deprecation support](@ref deprecation). */
304 #define IMPEXAMPLE_DEPRECATED_METHOD_DEF(version, message) \
305  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
306 
307 
308 #include <IMP/compiler_macros.h>
309 
310 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
311 IMP_COMPILER_ENABLE_WARNINGS
312 #define IMP_EXECUTABLE_WARNINGS
313 #endif
Helper functions for implementing hashes.
Helper class to aid in output of IMP classes to streams.
std::string get_module_version()
Return the version of this module, as a string.
Various compiler workarounds.
std::string get_example_path(std::string file_name)
Return the full path to one of this module's example files.
std::string get_data_path(std::string file_name)
Return the full path to one of this module's data files.