IMP logo
IMP Reference Guide  2.8.0
The Integrative Modeling Platform
pmi_config.h
1 // Autogenerated by ../../../../tmp/nightly-build-97111/imp-2.8.0/tools/build/setup_module.py
2 // from ../../../../tmp/nightly-build-97111/imp-2.8.0/tools/build/config_templates/header.h
3 // Do not edit - any changes will be lost!
4 
5 /*
6  * \file IMP/pmi/pmi_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, IMPPMI_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  * IMPPMIEXPORT 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::pmi namespace.
21  * This is simply achieved by wrapping things with the
22  * IMPPMI_BEGIN_NAMESPACE and IMPPMI_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-2017 IMP Inventors. All rights reserved.
27  *
28  */
29 
30 #ifndef IMPPMI_CONFIG_H
31 #define IMPPMI_CONFIG_H
32 
33 #include <IMP/kernel_config.h>
34 #include <string>
35 
36 #ifdef _MSC_VER
37 #define NOMINMAX
38 
39 #ifdef IMPPMI_EXPORTS
40 #define IMPPMIEXPORT __declspec(dllexport)
41 #else // EXPORTS
42 #define IMPPMIEXPORT __declspec(dllimport)
43 #endif // EXPORTS
44 
45 #else // _MSC_VER
46 
47 #ifdef GCC_VISIBILITY
48 #define IMPPMIEXPORT __attribute__((visibility("default")))
49 #else // GCC_VISIBILITY
50 #define IMPPMIEXPORT
51 #endif // GCC_VISIBILITY
52 
53 #endif // _MSC_VER
54 
55 #if defined(_MSC_VER) && !defined(SWIG)
56 #ifdef IMPPMI_EXPORTS
57 
58 #define IMPPMI_EXPORT_TEMPLATE(name) \
59  template class __declspec(dllexport) name
60 
61 #else //EXPORTS
62 
63 #define IMPPMI_EXPORT_TEMPLATE(name) \
64  template class __declspec(dllimport) name
65 
66 #endif // EXPORTS
67 
68 #else // MSC and SWIG
69 #define IMPPMI_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
70 
71 #endif // MSC and SWIG
72 
73 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
74 
75 #define IMPPMI_BEGIN_NAMESPACE \
76  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{ namespace pmi {
77 
78 #define IMPPMI_END_NAMESPACE } } \
79 IMP_COMPILER_DISABLE_WARNINGS
80 
81 #define IMPPMI_BEGIN_INTERNAL_NAMESPACE IMPPMI_BEGIN_NAMESPACE \
82  namespace internal {
83 
84 #define IMPPMI_END_INTERNAL_NAMESPACE } IMPPMI_END_NAMESPACE
85 
86 #else // SWIG and DOXYGEN
87 #define IMPPMI_BEGIN_NAMESPACE namespace IMP{ namespace pmi {
88 
89 #define IMPPMI_END_NAMESPACE } }
90 
91 #define IMPPMI_BEGIN_INTERNAL_NAMESPACE IMPPMI_BEGIN_NAMESPACE\
92  namespace internal {
93 
94 #define IMPPMI_END_INTERNAL_NAMESPACE } IMPPMI_END_NAMESPACE
95 
96 #endif // SWIG AND DOXYGEN
97 
98 #define IMP_PMI_USE_IMP_ALGEBRA
99 #define IMP_PMI_HAS_IMP_ALGEBRA 1
100 #define IMP_PMI_USE_IMP_ATOM
101 #define IMP_PMI_HAS_IMP_ATOM 1
102 #define IMP_PMI_USE_IMP_CGAL
103 #define IMP_PMI_HAS_IMP_CGAL 1
104 #define IMP_PMI_USE_IMP_DISPLAY
105 #define IMP_PMI_HAS_IMP_DISPLAY 1
106 #define IMP_PMI_USE_IMP_EM
107 #define IMP_PMI_HAS_IMP_EM 1
108 #define IMP_PMI_USE_IMP_KERNEL
109 #define IMP_PMI_HAS_IMP_KERNEL 1
110 #define IMP_PMI_USE_IMP_SAXS
111 #define IMP_PMI_HAS_IMP_SAXS 1
112 #define IMP_PMI_USE_IMP_SCORE_FUNCTOR
113 #define IMP_PMI_HAS_IMP_SCORE_FUNCTOR 1
114 #define IMP_PMI_USE_IMP_STATISTICS
115 #define IMP_PMI_HAS_IMP_STATISTICS 1
116 #define IMP_PMI_USE_BOOST_FILESYSTEM
117 #define IMP_PMI_HAS_BOOST_FILESYSTEM 1
118 #define IMP_PMI_USE_BOOST_PROGRAMOPTIONS
119 #define IMP_PMI_HAS_BOOST_PROGRAMOPTIONS 1
120 #define IMP_PMI_USE_BOOST_RANDOM
121 #define IMP_PMI_HAS_BOOST_RANDOM 1
122 #define IMP_PMI_USE_BOOST_REGEX
123 #define IMP_PMI_HAS_BOOST_REGEX 1
124 #define IMP_PMI_USE_BOOST_SYSTEM
125 #define IMP_PMI_HAS_BOOST_SYSTEM 1
126 #define IMP_PMI_USE_CGAL
127 #define IMP_PMI_HAS_CGAL 1
128 #define IMP_PMI_USE_HDF5
129 #define IMP_PMI_HAS_HDF5 1
130 
131 // functions are defined explicitly for SWIG
132 namespace IMP{ namespace pmi {
133 /** \name Standard module functions
134  All \imp modules have a set of standard functions to help get information
135  about the module and about files associated with the module.
136  @{
137  */
138 #if !defined(SWIG)
139  IMPPMIEXPORT std::string get_module_version();
140 #endif
141 
142 #if !defined(SWIG)
143  // SWIG will whine about duplicate definitions of function
144  inline std::string get_module_name() { return "IMP::pmi"; }
145 #endif
146 
147  //! Return the full path to one of this module's data files
148  /** To read the data file "data_library" that was placed in the \c data
149  directory of this module, do something like
150  \code
151  std::ifstream in(IMP::pmi::get_data_path("data_library"));
152  \endcode
153  This will ensure that the code works both when IMP is installed or
154  if used via the \c setup_environment.sh script.
155 
156  \note Each module has its own data directory, so be sure to use
157  this function from the correct module.
158  */
159 #if !defined(SWIG)
160  IMPPMIEXPORT std::string get_data_path(std::string file_name);
161 #endif
162 
163  //! Return the full path to one of this module's example files
164  /** To read the example file "example_protein.pdb" that was placed
165  in the \c examples directory of this module, do something like
166  \code
167  std::ifstream in(IMP::pmi::get_example_path("example_protein.pdb"));
168  \endcode
169  This will ensure that the code works both when IMP is installed or
170  if used via the \c setup_environment.sh script.
171 
172  \note Each module has its own example directory, so be sure to use
173  this function from the correct module.
174  */
175 #if !defined(SWIG)
176  IMPPMIEXPORT std::string get_example_path(std::string file_name);
177 #endif
178  /** @} */
179 
180 
181 } } //namespace
182 
183 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
184 
185 #include <IMP/Showable.h>
186 #include <IMP/hash.h>
187 
188 namespace IMP{ namespace pmi {
189 using ::IMP::Showable;
190 using ::IMP::operator<<;
191 using ::IMP::hash_value;
192 } } // namespace
193 namespace IMP{ namespace pmi { namespace internal {
194 using ::IMP::Showable;
195 using ::IMP::operator<<;
196 using ::IMP::hash_value;
197 } } } // namespace
198 
199 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
200 
201 
202 #include <IMP/compiler_macros.h>
203 
204 #endif /* IMPPMI_CONFIG_H */
205 
206 // Here so it is always parsed
207 
208 #ifdef IMPPMI_DEPRECATED_HEADER
209 #undef IMPPMI_DEPRECATED_HEADER
210 #undef IMPPMI_DEPRECATED_VALUE_DEF
211 #undef IMPPMI_DEPRECATED_VALUE_DECL
212 #undef IMPPMI_DEPRECATED_OBJECT_DEF
213 #undef IMPPMI_DEPRECATED_OBJECT_DECL
214 #undef IMPPMI_DEPRECATED_FUNCTION_DEF
215 #undef IMPPMI_DEPRECATED_FUNCTION_DECL
216 #undef IMPPMI_DEPRECATED_METHOD_DEF
217 #undef IMPPMI_DEPRECATED_METHOD_DECL
218 #undef IMPPMI_DEPRECATED_MACRO
219 #undef IMPPMI_SHOW_WARNINGS
220 #endif
221 
222 // the central modules we can update easily, so don't warn in them
223 #if defined( IMPPMI_COMPILATION) \
224  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
225  || defined( IMPPMI_ALL) || defined(IMP_DOXYGEN) \
226  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
227  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
228  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
229  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
230  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
231  || defined(IMPGSL_COMPILATION)
232 #define IMPPMI_SHOW_WARNINGS 0
233 #else
234 #define IMPPMI_SHOW_WARNINGS 1
235 #endif
236 
237 // suppress header warnings with all header, SWIG wrapper and in the module
238 #if IMPPMI_SHOW_WARNINGS
239 #define IMPPMI_DEPRECATED_HEADER(version, help_message) \
240  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
241 #define IMPPMI_DEPRECATED_VALUE_DECL(version) \
242  IMP_DEPRECATED_ATTRIBUTE
243 #define IMPPMI_DEPRECATED_OBJECT_DECL(version) \
244  IMP_DEPRECATED_ATTRIBUTE
245 #define IMPPMI_DEPRECATED_FUNCTION_DECL(version) \
246  IMP_DEPRECATED_ATTRIBUTE
247 #define IMPPMI_DEPRECATED_METHOD_DECL(version) \
248  IMP_DEPRECATED_ATTRIBUTE
249 
250 #else //IMPPMI_SHOW_WARNINGS
251 /** See [deprecation support](@ref deprecation). */
252 #define IMPPMI_DEPRECATED_HEADER(version, help_message) \
253 /** See [deprecation support](@ref deprecation). */
254 #define IMPPMI_DEPRECATED_VALUE_DECL(version)
255 /** See [deprecation support](@ref deprecation). */
256 #define IMPPMI_DEPRECATED_OBJECT_DECL(version)
257 /** See [deprecation support](@ref deprecation). */
258 #define IMPPMI_DEPRECATED_FUNCTION_DECL(version)
259 /** See [deprecation support](@ref deprecation). */
260 #define IMPPMI_DEPRECATED_METHOD_DECL(version)
261 
262 #endif // IMPPMI_SHOW_WARNINGS
263 
264 // only warn about it in the all inclusion to cut down on copies
265 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
266  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
267  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
268  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
269  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
270  || defined(IMPSCOREFUNCTOR_COMPILATION)
271 /** See [deprecation support](@ref deprecation). */
272 #define IMPPMI_DEPRECATED_MACRO(version, message)
273 
274 #else
275 #define IMPPMI_DEPRECATED_MACRO(version, message) \
276  IMP_DEPRECATED_MACRO(version, message)
277 #endif
278 
279 /** See [deprecation support](@ref deprecation). */
280 #define IMPPMI_DEPRECATED_VALUE_DEF(version, message) \
281  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
282 
283 /** See [deprecation support](@ref deprecation). */
284 #define IMPPMI_DEPRECATED_OBJECT_DEF(version, message) \
285  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
286 
287 /** See [deprecation support](@ref deprecation). */
288 #define IMPPMI_DEPRECATED_FUNCTION_DEF(version, message) \
289  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
290 
291 /** See [deprecation support](@ref deprecation). */
292 #define IMPPMI_DEPRECATED_METHOD_DEF(version, message) \
293  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
294 
295 
296 #include <IMP/compiler_macros.h>
297 
298 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
299 IMP_COMPILER_ENABLE_WARNINGS
300 #define IMP_EXECUTABLE_WARNINGS
301 #endif
IO support.
std::string get_data_path(std::string file_name)
Return the full path to one of this module's data files.
IO support.
std::string get_example_path(std::string file_name)
Return the full path to one of this module's example files.
Various compiler workarounds.