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