IMP logo
IMP Reference Guide  2.21.0
The Integrative Modeling Platform
version 2.21.0
em2d_config.h
1 // Autogenerated by ../../../../tmp/nightly-build-83334/imp-2.21.0/tools/build/setup_module.py
2 // from ../../../../tmp/nightly-build-83334/imp-2.21.0/tools/build/config_templates/header.h
3 // Do not edit - any changes will be lost!
4 
5 /*
6  * \file IMP/em2d/em2d_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, IMPEM2D_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  * IMPEM2DEXPORT 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::em2d namespace.
21  * This is simply achieved by wrapping things with the
22  * IMPEM2D_BEGIN_NAMESPACE and IMPEM2D_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 IMPEM2D_CONFIG_H
31 #define IMPEM2D_CONFIG_H
32 
33 #include <IMP/kernel_config.h>
34 #include <string>
35 
36 #ifdef _MSC_VER
37 #define NOMINMAX
38 
39 #ifdef IMPEM2D_EXPORTS
40 #define IMPEM2DEXPORT __declspec(dllexport)
41 #else // EXPORTS
42 #define IMPEM2DEXPORT __declspec(dllimport)
43 #endif // EXPORTS
44 
45 #else // _MSC_VER
46 
47 #ifdef GCC_VISIBILITY
48 #define IMPEM2DEXPORT __attribute__((visibility("default")))
49 #else // GCC_VISIBILITY
50 #define IMPEM2DEXPORT
51 #endif // GCC_VISIBILITY
52 
53 #endif // _MSC_VER
54 
55 #if defined(_MSC_VER) && !defined(SWIG)
56 #ifdef IMPEM2D_EXPORTS
57 
58 #define IMPEM2D_EXPORT_TEMPLATE(name) \
59  template class __declspec(dllexport) name
60 
61 #else //EXPORTS
62 
63 #define IMPEM2D_EXPORT_TEMPLATE(name) \
64  template class __declspec(dllimport) name
65 
66 #endif // EXPORTS
67 
68 #else // MSC and SWIG
69 #define IMPEM2D_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
70 
71 #endif // MSC and SWIG
72 
73 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
74 
75 #define IMPEM2D_BEGIN_NAMESPACE \
76  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{ namespace em2d {
77 
78 #define IMPEM2D_END_NAMESPACE } } \
79 IMP_COMPILER_DISABLE_WARNINGS
80 
81 #define IMPEM2D_BEGIN_INTERNAL_NAMESPACE IMPEM2D_BEGIN_NAMESPACE \
82  namespace internal {
83 
84 #define IMPEM2D_END_INTERNAL_NAMESPACE } IMPEM2D_END_NAMESPACE
85 
86 #else // SWIG and DOXYGEN
87 #define IMPEM2D_BEGIN_NAMESPACE namespace IMP{ namespace em2d {
88 
89 #define IMPEM2D_END_NAMESPACE } }
90 
91 #define IMPEM2D_BEGIN_INTERNAL_NAMESPACE IMPEM2D_BEGIN_NAMESPACE\
92  namespace internal {
93 
94 #define IMPEM2D_END_INTERNAL_NAMESPACE } IMPEM2D_END_NAMESPACE
95 
96 #endif // SWIG AND DOXYGEN
97 
98 #define IMP_EM2D_USE_IMP_CGAL
99 #define IMP_EM2D_HAS_IMP_CGAL 1
100 #define IMP_EM2D_USE_IMP_ISD
101 #define IMP_EM2D_HAS_IMP_ISD 1
102 #define IMP_EM2D_USE_IMP_KERNEL
103 #define IMP_EM2D_HAS_IMP_KERNEL 1
104 #define IMP_EM2D_USE_IMP_RMF
105 #define IMP_EM2D_HAS_IMP_RMF 1
106 #define IMP_EM2D_USE_IMP_SAXS
107 #define IMP_EM2D_HAS_IMP_SAXS 1
108 #define IMP_EM2D_USE_IMP_SCORE_FUNCTOR
109 #define IMP_EM2D_HAS_IMP_SCORE_FUNCTOR 1
110 #define IMP_EM2D_USE_IMP_STATISTICS
111 #define IMP_EM2D_HAS_IMP_STATISTICS 1
112 #define IMP_EM2D_USE_BOOST_GRAPH
113 #define IMP_EM2D_HAS_BOOST_GRAPH 1
114 #define IMP_EM2D_USE_BOOST_RANDOM
115 #define IMP_EM2D_HAS_BOOST_RANDOM 1
116 #define IMP_EM2D_USE_BOOST_REGEX
117 #define IMP_EM2D_HAS_BOOST_REGEX 1
118 #define IMP_EM2D_USE_BOOST_SYSTEM
119 #define IMP_EM2D_HAS_BOOST_SYSTEM 1
120 #define IMP_EM2D_USE_CGAL
121 #define IMP_EM2D_HAS_CGAL 1
122 #define IMP_EM2D_USE_GSL
123 #define IMP_EM2D_HAS_GSL 1
124 #define IMP_EM2D_USE_HDF5
125 #define IMP_EM2D_HAS_HDF5 1
126 #define IMP_EM2D_USE_NUMPY
127 #define IMP_EM2D_HAS_NUMPY 1
128 #define IMP_EM2D_USE_OPENCV3
129 #define IMP_EM2D_HAS_OPENCV3 1
130 #define IMP_EM2D_USE_RMF
131 #define IMP_EM2D_HAS_RMF 1
132 #define IMP_EM2D_USE_PYTHON_IHM
133 #define IMP_EM2D_HAS_PYTHON_IHM 1
134 #define IMP_EM2D_NO_OPENCV21
135 #define IMP_EM2D_HAS_OPENCV21 0
136 #define IMP_EM2D_NO_OPENCV22
137 #define IMP_EM2D_HAS_OPENCV22 0
138 
139 // functions are defined explicitly for SWIG
140 namespace IMP{ namespace em2d {
141 /** \name Standard module functions
142  All \imp modules have a set of standard functions to help get information
143  about the module and about files associated with the module.
144  @{
145  */
146 #if !defined(SWIG)
147  IMPEM2DEXPORT std::string get_module_version();
148 #endif
149 
150 #if !defined(SWIG)
151  // SWIG will whine about duplicate definitions of function
152  inline std::string get_module_name() { return "IMP::em2d"; }
153 #endif
154 
155  //! Return the full path to one of this module's data files
156  /** To read the data file "data_library" that was placed in the \c data
157  directory of this module, do something like
158  \code
159  std::ifstream in(IMP::em2d::get_data_path("data_library"));
160  \endcode
161  This will ensure that the code works both when IMP is installed or
162  if used via the \c setup_environment.sh script.
163 
164  \note Each module has its own data directory, so be sure to use
165  this function from the correct module.
166  */
167 #if !defined(SWIG)
168  IMPEM2DEXPORT std::string get_data_path(std::string file_name);
169 #endif
170 
171  //! Return the full path to one of this module's example files
172  /** To read the example file "example_protein.pdb" that was placed
173  in the \c examples directory of this module, do something like
174  \code
175  std::ifstream in(IMP::em2d::get_example_path("example_protein.pdb"));
176  \endcode
177  This will ensure that the code works both when IMP is installed or
178  if used via the \c setup_environment.sh script.
179 
180  \note Each module has its own example directory, so be sure to use
181  this function from the correct module.
182  */
183 #if !defined(SWIG)
184  IMPEM2DEXPORT std::string get_example_path(std::string file_name);
185 #endif
186  /** @} */
187 
188 
189 } } //namespace
190 
191 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
192 
193 #include <IMP/Showable.h>
194 #include <IMP/hash.h>
195 
196 namespace IMP{ namespace em2d {
197 using ::IMP::Showable;
198 using ::IMP::operator<<;
199 using ::IMP::hash_value;
200 } } // namespace
201 namespace IMP{ namespace em2d { namespace internal {
202 using ::IMP::Showable;
203 using ::IMP::operator<<;
204 using ::IMP::hash_value;
205 } } } // namespace
206 
207 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
208 
209 
210 #include <IMP/compiler_macros.h>
211 
212 #endif /* IMPEM2D_CONFIG_H */
213 
214 // Here so it is always parsed
215 
216 #ifdef IMPEM2D_DEPRECATED_HEADER
217 #undef IMPEM2D_DEPRECATED_HEADER
218 #undef IMPEM2D_DEPRECATED_VALUE_DEF
219 #undef IMPEM2D_DEPRECATED_VALUE_DECL
220 #undef IMPEM2D_DEPRECATED_OBJECT_DEF
221 #undef IMPEM2D_DEPRECATED_OBJECT_DECL
222 #undef IMPEM2D_DEPRECATED_FUNCTION_DEF
223 #undef IMPEM2D_DEPRECATED_FUNCTION_DECL
224 #undef IMPEM2D_DEPRECATED_METHOD_DEF
225 #undef IMPEM2D_DEPRECATED_METHOD_DECL
226 #undef IMPEM2D_DEPRECATED_MACRO
227 #undef IMPEM2D_SHOW_WARNINGS
228 #endif
229 
230 // the central modules we can update easily, so don't warn in them
231 #if defined( IMPEM2D_COMPILATION) \
232  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
233  || defined( IMPEM2D_ALL) || defined(IMP_DOXYGEN) \
234  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
235  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
236  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
237  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
238  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
239  || defined(IMPGSL_COMPILATION)
240 #define IMPEM2D_SHOW_WARNINGS 0
241 #else
242 #define IMPEM2D_SHOW_WARNINGS 1
243 #endif
244 
245 // suppress header warnings with all header, SWIG wrapper and in the module
246 #if IMPEM2D_SHOW_WARNINGS
247 #define IMPEM2D_DEPRECATED_HEADER(version, help_message) \
248  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
249 #define IMPEM2D_DEPRECATED_VALUE_DECL(version) \
250  IMP_DEPRECATED_ATTRIBUTE
251 #define IMPEM2D_DEPRECATED_OBJECT_DECL(version) \
252  IMP_DEPRECATED_ATTRIBUTE
253 #define IMPEM2D_DEPRECATED_FUNCTION_DECL(version) \
254  IMP_DEPRECATED_ATTRIBUTE
255 #define IMPEM2D_DEPRECATED_METHOD_DECL(version) \
256  IMP_DEPRECATED_ATTRIBUTE
257 
258 #else //IMPEM2D_SHOW_WARNINGS
259 /** See [deprecation support](@ref deprecation). */
260 #define IMPEM2D_DEPRECATED_HEADER(version, help_message) \
261 /** See [deprecation support](@ref deprecation). */
262 #define IMPEM2D_DEPRECATED_VALUE_DECL(version)
263 /** See [deprecation support](@ref deprecation). */
264 #define IMPEM2D_DEPRECATED_OBJECT_DECL(version)
265 /** See [deprecation support](@ref deprecation). */
266 #define IMPEM2D_DEPRECATED_FUNCTION_DECL(version)
267 /** See [deprecation support](@ref deprecation). */
268 #define IMPEM2D_DEPRECATED_METHOD_DECL(version)
269 
270 #endif // IMPEM2D_SHOW_WARNINGS
271 
272 // only warn about it in the all inclusion to cut down on copies
273 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
274  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
275  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
276  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
277  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
278  || defined(IMPSCOREFUNCTOR_COMPILATION)
279 /** See [deprecation support](@ref deprecation). */
280 #define IMPEM2D_DEPRECATED_MACRO(version, message)
281 
282 #else
283 #define IMPEM2D_DEPRECATED_MACRO(version, message) \
284  IMP_DEPRECATED_MACRO(version, message)
285 #endif
286 
287 /** See [deprecation support](@ref deprecation). */
288 #define IMPEM2D_DEPRECATED_VALUE_DEF(version, message) \
289  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
290 
291 /** See [deprecation support](@ref deprecation). */
292 #define IMPEM2D_DEPRECATED_OBJECT_DEF(version, message) \
293  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
294 
295 /** See [deprecation support](@ref deprecation). */
296 #define IMPEM2D_DEPRECATED_FUNCTION_DEF(version, message) \
297  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
298 
299 /** See [deprecation support](@ref deprecation). */
300 #define IMPEM2D_DEPRECATED_METHOD_DEF(version, message) \
301  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
302 
303 
304 #include <IMP/compiler_macros.h>
305 
306 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
307 IMP_COMPILER_ENABLE_WARNINGS
308 #define IMP_EXECUTABLE_WARNINGS
309 #endif
IMP::em2d::get_data_path
std::string get_data_path(std::string file_name)
Return the full path to one of this module's data files.
IMP::em2d::get_example_path
std::string get_example_path(std::string file_name)
Return the full path to one of this module's example files.
hash.h
Helper functions for implementing hashes.
Showable.h
Helper class to aid in output of IMP classes to streams.
IMP::em2d::get_module_version
std::string get_module_version()
Return the version of this module, as a string.
Definition: EMageFit/__init__.py:5
compiler_macros.h
Various compiler workarounds.