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