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