IMP  2.3.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 functions
133  All \imp modules have a set of standard functions 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  //! Return the full path to installed data
147  /** Each module has its own data directory, so be sure to use
148  the version of this function in the correct module. To read
149  the data file "data_library" that was placed in the \c data
150  directory of module "mymodule", do something like
151  \code
152  std::ifstream in(IMP::mymodule::get_data_path("data_library"));
153  \endcode
154  This will ensure that the code works when \imp is installed or
155  used via the \c setup_environment.sh script.
156  */
157 #if !defined(SWIG)
158  IMPEM2DEXPORT std::string get_data_path(std::string file_name);
159 #endif
160 
161  //! Return the path to installed example data for this module
162  /** Each module has its own example directory, so be sure to use
163  the version of this function in the correct module. For example
164  to read the file \c example_protein.pdb located in the
165  \c examples directory of the IMP::atom module, do
166  \code
167  IMP::atom::read_pdb(IMP::atom::get_example_path("example_protein.pdb",
168  model));
169  \endcode
170  This will ensure that the code works when \imp is installed or
171  used via the \c setup_environment.sh script.
172  */
173 #if !defined(SWIG)
174  IMPEM2DEXPORT std::string get_example_path(std::string file_name);
175 #endif
176  /** @} */
177 
178 
179  }
180 } //namespace
181 
182 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
183 
184 #include <IMP/base/Showable.h>
185 #include <IMP/base/hash.h>
186 
187 namespace IMP { namespace em2d {
188 using ::IMP::base::Showable;
189 using ::IMP::base::operator<<;
190 using ::IMP::base::hash_value;
191 } } // namespace
192 namespace IMP { namespace em2d { namespace internal {
193 using ::IMP::base::Showable;
194 using ::IMP::base::operator<<;
195 using ::IMP::base::hash_value;
196 } } } // namespace
197 
198 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
199 
200 
201 #include <IMP/base/compiler_macros.h>
202 
203 #endif /* IMPEM2D_CONFIG_H */
204 
205 // Here so it is always parsed
206 
207 #ifdef IMPEM2D_DEPRECATED_HEADER
208 #undef IMPEM2D_DEPRECATED_HEADER
209 #undef IMPEM2D_DEPRECATED_VALUE_DEF
210 #undef IMPEM2D_DEPRECATED_VALUE_DECL
211 #undef IMPEM2D_DEPRECATED_OBJECT_DEF
212 #undef IMPEM2D_DEPRECATED_OBJECT_DECL
213 #undef IMPEM2D_DEPRECATED_FUNCTION_DEF
214 #undef IMPEM2D_DEPRECATED_FUNCTION_DECL
215 #undef IMPEM2D_DEPRECATED_METHOD_DEF
216 #undef IMPEM2D_DEPRECATED_METHOD_DECL
217 #undef IMPEM2D_DEPRECATED_MACRO
218 #undef IMPEM2D_SHOW_WARNINGS
219 #endif
220 
221 // the central modules we can update easily, so don't warn in them
222 #if defined( IMPEM2D_COMPILATION) \
223  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
224  || defined( IMPEM2D_ALL) || defined(IMP_DOXYGEN) \
225  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
226  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
227  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
228  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
229  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
230  || defined(IMPGSL_COMPILATION)
231 #define IMPEM2D_SHOW_WARNINGS 0
232 #else
233 #define IMPEM2D_SHOW_WARNINGS 1
234 #endif
235 
236 // suppress header warnings with all header, SWIG wrapper and in the module
237 #if IMPEM2D_SHOW_WARNINGS
238 #define IMPEM2D_DEPRECATED_HEADER(version, help_message) \
239  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
240 #define IMPEM2D_DEPRECATED_VALUE_DECL(version) \
241  IMP_DEPRECATED_ATTRIBUTE
242 #define IMPEM2D_DEPRECATED_OBJECT_DECL(version) \
243  IMP_DEPRECATED_ATTRIBUTE
244 #define IMPEM2D_DEPRECATED_FUNCTION_DECL(version) \
245  IMP_DEPRECATED_ATTRIBUTE
246 #define IMPEM2D_DEPRECATED_METHOD_DECL(version) \
247  IMP_DEPRECATED_ATTRIBUTE
248 
249 #else //IMPEM2D_SHOW_WARNINGS
250 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
251 #define IMPEM2D_DEPRECATED_HEADER(version, help_message) \
252 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
253 #define IMPEM2D_DEPRECATED_VALUE_DECL(version)
254 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
255 #define IMPEM2D_DEPRECATED_OBJECT_DECL(version)
256 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
257 #define IMPEM2D_DEPRECATED_FUNCTION_DECL(version)
258 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
259 #define IMPEM2D_DEPRECATED_METHOD_DECL(version)
260 
261 #endif // IMPEM2D_SHOW_WARNINGS
262 
263 // only warn about it in the all inclusion to cut down on copies
264 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
265  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
266  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
267  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
268  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
269  || defined(IMPSCOREFUNCTOR_COMPILATION)
270 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
271 #define IMPEM2D_DEPRECATED_MACRO(version, message)
272 
273 #else
274 #define IMPEM2D_DEPRECATED_MACRO(version, message) \
275  IMP_DEPRECATED_MACRO(version, message)
276 #endif
277 
278 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
279 #define IMPEM2D_DEPRECATED_VALUE_DEF(version, message) \
280  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
281 
282 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
283 #define IMPEM2D_DEPRECATED_OBJECT_DEF(version, message) \
284  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
285 
286 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
287 #define IMPEM2D_DEPRECATED_FUNCTION_DEF(version, message) \
288  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
289 
290 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
291 #define IMPEM2D_DEPRECATED_METHOD_DEF(version, message) \
292  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
293 
294 
295 #include <IMP/base/compiler_macros.h>
296 
297 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
298 IMP_COMPILER_ENABLE_WARNINGS
299 #define IMP_EXECUTABLE_WARNINGS
300 #endif
IMP::em2d::get_data_path
std::string get_data_path(std::string file_name)
Return the full path to installed data.
IMP::em2d::get_example_path
std::string get_example_path(std::string file_name)
Return the path to installed example data for this module.
hash.h
IO support.
Showable.h
IO support.
compiler_macros.h
Various compiler workarounds.