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