IMP logo
IMP Reference Guide  develop.97bab1d8fd,2021/09/21
The Integrative Modeling Platform
spb_config.h
1 // Autogenerated by ../../../../tmp/nightly-build-318/imp-20210921.develop.97bab1d8fd/tools/build/setup_module.py
2 // from ../../../../tmp/nightly-build-318/imp-20210921.develop.97bab1d8fd/tools/build/config_templates/header.h
3 // Do not edit - any changes will be lost!
4 
5 /*
6  * \file IMP/spb/spb_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, IMPSPB_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  * IMPSPBEXPORT 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::spb namespace.
21  * This is simply achieved by wrapping things with the
22  * IMPSPB_BEGIN_NAMESPACE and IMPSPB_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-2021 IMP Inventors. All rights reserved.
27  *
28  */
29 
30 #ifndef IMPSPB_CONFIG_H
31 #define IMPSPB_CONFIG_H
32 
33 #include <IMP/kernel_config.h>
34 #include <string>
35 
36 #ifdef _MSC_VER
37 #define NOMINMAX
38 
39 #ifdef IMPSPB_EXPORTS
40 #define IMPSPBEXPORT __declspec(dllexport)
41 #else // EXPORTS
42 #define IMPSPBEXPORT __declspec(dllimport)
43 #endif // EXPORTS
44 
45 #else // _MSC_VER
46 
47 #ifdef GCC_VISIBILITY
48 #define IMPSPBEXPORT __attribute__((visibility("default")))
49 #else // GCC_VISIBILITY
50 #define IMPSPBEXPORT
51 #endif // GCC_VISIBILITY
52 
53 #endif // _MSC_VER
54 
55 #if defined(_MSC_VER) && !defined(SWIG)
56 #ifdef IMPSPB_EXPORTS
57 
58 #define IMPSPB_EXPORT_TEMPLATE(name) \
59  template class __declspec(dllexport) name
60 
61 #else //EXPORTS
62 
63 #define IMPSPB_EXPORT_TEMPLATE(name) \
64  template class __declspec(dllimport) name
65 
66 #endif // EXPORTS
67 
68 #else // MSC and SWIG
69 #define IMPSPB_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
70 
71 #endif // MSC and SWIG
72 
73 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
74 
75 #define IMPSPB_BEGIN_NAMESPACE \
76  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{ namespace spb {
77 
78 #define IMPSPB_END_NAMESPACE } } \
79 IMP_COMPILER_DISABLE_WARNINGS
80 
81 #define IMPSPB_BEGIN_INTERNAL_NAMESPACE IMPSPB_BEGIN_NAMESPACE \
82  namespace internal {
83 
84 #define IMPSPB_END_INTERNAL_NAMESPACE } IMPSPB_END_NAMESPACE
85 
86 #else // SWIG and DOXYGEN
87 #define IMPSPB_BEGIN_NAMESPACE namespace IMP{ namespace spb {
88 
89 #define IMPSPB_END_NAMESPACE } }
90 
91 #define IMPSPB_BEGIN_INTERNAL_NAMESPACE IMPSPB_BEGIN_NAMESPACE\
92  namespace internal {
93 
94 #define IMPSPB_END_INTERNAL_NAMESPACE } IMPSPB_END_NAMESPACE
95 
96 #endif // SWIG AND DOXYGEN
97 
98 #define IMP_SPB_USE_IMP_ALGEBRA
99 #define IMP_SPB_HAS_IMP_ALGEBRA 1
100 #define IMP_SPB_USE_IMP_CGAL
101 #define IMP_SPB_HAS_IMP_CGAL 1
102 #define IMP_SPB_USE_IMP_DISPLAY
103 #define IMP_SPB_HAS_IMP_DISPLAY 1
104 #define IMP_SPB_USE_IMP_DOMINO
105 #define IMP_SPB_HAS_IMP_DOMINO 1
106 #define IMP_SPB_USE_IMP_EM
107 #define IMP_SPB_HAS_IMP_EM 1
108 #define IMP_SPB_USE_IMP_GSL
109 #define IMP_SPB_HAS_IMP_GSL 1
110 #define IMP_SPB_USE_IMP_KERNEL
111 #define IMP_SPB_HAS_IMP_KERNEL 1
112 #define IMP_SPB_USE_IMP_SCORE_FUNCTOR
113 #define IMP_SPB_HAS_IMP_SCORE_FUNCTOR 1
114 #define IMP_SPB_USE_BOOST_FILESYSTEM
115 #define IMP_SPB_HAS_BOOST_FILESYSTEM 1
116 #define IMP_SPB_USE_BOOST_GRAPH
117 #define IMP_SPB_HAS_BOOST_GRAPH 1
118 #define IMP_SPB_USE_BOOST_PROGRAMOPTIONS
119 #define IMP_SPB_HAS_BOOST_PROGRAMOPTIONS 1
120 #define IMP_SPB_USE_BOOST_RANDOM
121 #define IMP_SPB_HAS_BOOST_RANDOM 1
122 #define IMP_SPB_USE_BOOST_REGEX
123 #define IMP_SPB_HAS_BOOST_REGEX 1
124 #define IMP_SPB_USE_BOOST_SYSTEM
125 #define IMP_SPB_HAS_BOOST_SYSTEM 1
126 #define IMP_SPB_USE_CGAL
127 #define IMP_SPB_HAS_CGAL 1
128 #define IMP_SPB_USE_FFTW3
129 #define IMP_SPB_HAS_FFTW3 1
130 #define IMP_SPB_USE_GSL
131 #define IMP_SPB_HAS_GSL 1
132 #define IMP_SPB_USE_HDF5
133 #define IMP_SPB_HAS_HDF5 1
134 #define IMP_SPB_USE_MPI
135 #define IMP_SPB_HAS_MPI 1
136 #define IMP_SPB_USE_NUMPY
137 #define IMP_SPB_HAS_NUMPY 1
138 #define IMP_SPB_USE_OPENCV22
139 #define IMP_SPB_HAS_OPENCV22 1
140 #define IMP_SPB_USE_RMF
141 #define IMP_SPB_HAS_RMF 1
142 #define IMP_SPB_USE_PYTHON_IHM
143 #define IMP_SPB_HAS_PYTHON_IHM 1
144 
145 // functions are defined explicitly for SWIG
146 namespace IMP{ namespace spb {
147 /** \name Standard module functions
148  All \imp modules have a set of standard functions to help get information
149  about the module and about files associated with the module.
150  @{
151  */
152 #if !defined(SWIG)
153  IMPSPBEXPORT std::string get_module_version();
154 #endif
155 
156 #if !defined(SWIG)
157  // SWIG will whine about duplicate definitions of function
158  inline std::string get_module_name() { return "IMP::spb"; }
159 #endif
160 
161  //! Return the full path to one of this module's data files
162  /** To read the data file "data_library" that was placed in the \c data
163  directory of this module, do something like
164  \code
165  std::ifstream in(IMP::spb::get_data_path("data_library"));
166  \endcode
167  This will ensure that the code works both when IMP is installed or
168  if used via the \c setup_environment.sh script.
169 
170  \note Each module has its own data directory, so be sure to use
171  this function from the correct module.
172  */
173 #if !defined(SWIG)
174  IMPSPBEXPORT std::string get_data_path(std::string file_name);
175 #endif
176 
177  //! Return the full path to one of this module's example files
178  /** To read the example file "example_protein.pdb" that was placed
179  in the \c examples directory of this module, do something like
180  \code
181  std::ifstream in(IMP::spb::get_example_path("example_protein.pdb"));
182  \endcode
183  This will ensure that the code works both when IMP is installed or
184  if used via the \c setup_environment.sh script.
185 
186  \note Each module has its own example directory, so be sure to use
187  this function from the correct module.
188  */
189 #if !defined(SWIG)
190  IMPSPBEXPORT std::string get_example_path(std::string file_name);
191 #endif
192  /** @} */
193 
194 
195 } } //namespace
196 
197 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
198 
199 #include <IMP/Showable.h>
200 #include <IMP/hash.h>
201 
202 namespace IMP{ namespace spb {
203 using ::IMP::Showable;
204 using ::IMP::operator<<;
205 using ::IMP::hash_value;
206 } } // namespace
207 namespace IMP{ namespace spb { namespace internal {
208 using ::IMP::Showable;
209 using ::IMP::operator<<;
210 using ::IMP::hash_value;
211 } } } // namespace
212 
213 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
214 
215 
216 #include <IMP/compiler_macros.h>
217 
218 #endif /* IMPSPB_CONFIG_H */
219 
220 // Here so it is always parsed
221 
222 #ifdef IMPSPB_DEPRECATED_HEADER
223 #undef IMPSPB_DEPRECATED_HEADER
224 #undef IMPSPB_DEPRECATED_VALUE_DEF
225 #undef IMPSPB_DEPRECATED_VALUE_DECL
226 #undef IMPSPB_DEPRECATED_OBJECT_DEF
227 #undef IMPSPB_DEPRECATED_OBJECT_DECL
228 #undef IMPSPB_DEPRECATED_FUNCTION_DEF
229 #undef IMPSPB_DEPRECATED_FUNCTION_DECL
230 #undef IMPSPB_DEPRECATED_METHOD_DEF
231 #undef IMPSPB_DEPRECATED_METHOD_DECL
232 #undef IMPSPB_DEPRECATED_MACRO
233 #undef IMPSPB_SHOW_WARNINGS
234 #endif
235 
236 // the central modules we can update easily, so don't warn in them
237 #if defined( IMPSPB_COMPILATION) \
238  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
239  || defined( IMPSPB_ALL) || defined(IMP_DOXYGEN) \
240  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
241  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
242  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
243  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
244  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
245  || defined(IMPGSL_COMPILATION)
246 #define IMPSPB_SHOW_WARNINGS 0
247 #else
248 #define IMPSPB_SHOW_WARNINGS 1
249 #endif
250 
251 // suppress header warnings with all header, SWIG wrapper and in the module
252 #if IMPSPB_SHOW_WARNINGS
253 #define IMPSPB_DEPRECATED_HEADER(version, help_message) \
254  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
255 #define IMPSPB_DEPRECATED_VALUE_DECL(version) \
256  IMP_DEPRECATED_ATTRIBUTE
257 #define IMPSPB_DEPRECATED_OBJECT_DECL(version) \
258  IMP_DEPRECATED_ATTRIBUTE
259 #define IMPSPB_DEPRECATED_FUNCTION_DECL(version) \
260  IMP_DEPRECATED_ATTRIBUTE
261 #define IMPSPB_DEPRECATED_METHOD_DECL(version) \
262  IMP_DEPRECATED_ATTRIBUTE
263 
264 #else //IMPSPB_SHOW_WARNINGS
265 /** See [deprecation support](@ref deprecation). */
266 #define IMPSPB_DEPRECATED_HEADER(version, help_message) \
267 /** See [deprecation support](@ref deprecation). */
268 #define IMPSPB_DEPRECATED_VALUE_DECL(version)
269 /** See [deprecation support](@ref deprecation). */
270 #define IMPSPB_DEPRECATED_OBJECT_DECL(version)
271 /** See [deprecation support](@ref deprecation). */
272 #define IMPSPB_DEPRECATED_FUNCTION_DECL(version)
273 /** See [deprecation support](@ref deprecation). */
274 #define IMPSPB_DEPRECATED_METHOD_DECL(version)
275 
276 #endif // IMPSPB_SHOW_WARNINGS
277 
278 // only warn about it in the all inclusion to cut down on copies
279 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
280  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
281  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
282  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
283  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
284  || defined(IMPSCOREFUNCTOR_COMPILATION)
285 /** See [deprecation support](@ref deprecation). */
286 #define IMPSPB_DEPRECATED_MACRO(version, message)
287 
288 #else
289 #define IMPSPB_DEPRECATED_MACRO(version, message) \
290  IMP_DEPRECATED_MACRO(version, message)
291 #endif
292 
293 /** See [deprecation support](@ref deprecation). */
294 #define IMPSPB_DEPRECATED_VALUE_DEF(version, message) \
295  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
296 
297 /** See [deprecation support](@ref deprecation). */
298 #define IMPSPB_DEPRECATED_OBJECT_DEF(version, message) \
299  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
300 
301 /** See [deprecation support](@ref deprecation). */
302 #define IMPSPB_DEPRECATED_FUNCTION_DEF(version, message) \
303  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
304 
305 /** See [deprecation support](@ref deprecation). */
306 #define IMPSPB_DEPRECATED_METHOD_DEF(version, message) \
307  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
308 
309 
310 #include <IMP/compiler_macros.h>
311 
312 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
313 IMP_COMPILER_ENABLE_WARNINGS
314 #define IMP_EXECUTABLE_WARNINGS
315 #endif
Helper functions for implementing hashes.
Helper class to aid in output of IMP classes to streams.
std::string get_data_path(std::string file_name)
Return the full path to one of this module's data files.
std::string get_example_path(std::string file_name)
Return the full path to one of this module's example files.
Various compiler workarounds.
std::string get_module_version()
Return the version of this module, as a string.