IMP  2.4.0
The Integrative Modeling Platform
integrative_docking_config.h
1 /*
2  * \file IMP/integrative_docking/integrative_docking_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, IMPINTEGRATIVEDOCKING_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  * IMPINTEGRATIVEDOCKINGEXPORT 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::integrative_docking namespace.
17  * This is simply achieved by wrapping things with the
18  * IMPINTEGRATIVEDOCKING_BEGIN_NAMESPACE and IMPINTEGRATIVEDOCKING_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-2015 IMP Inventors. All rights reserved.
26  *
27  */
28 
29 #ifndef IMPINTEGRATIVEDOCKING_CONFIG_H
30 #define IMPINTEGRATIVEDOCKING_CONFIG_H
31 
32 #include <IMP/base/base_config.h>
33 #include <string>
34 
35 #ifdef _MSC_VER
36 
37 #ifdef IMPINTEGRATIVEDOCKING_EXPORTS
38 #define IMPINTEGRATIVEDOCKINGEXPORT __declspec(dllexport)
39 #else // EXPORTS
40 #define IMPINTEGRATIVEDOCKINGEXPORT __declspec(dllimport)
41 #endif // EXPORTS
42 
43 #else // _MSC_VER
44 
45 #ifdef GCC_VISIBILITY
46 #define IMPINTEGRATIVEDOCKINGEXPORT __attribute__((visibility("default")))
47 #else // GCC_VISIBILITY
48 #define IMPINTEGRATIVEDOCKINGEXPORT
49 #endif // GCC_VISIBILITY
50 
51 #endif // _MSC_VER
52 
53 #if defined(_MSC_VER) && !defined(SWIG)
54 #ifdef IMPINTEGRATIVEDOCKING_EXPORTS
55 
56 #define IMPINTEGRATIVEDOCKING_EXPORT_TEMPLATE(name) \
57  template class __declspec(dllexport) name
58 
59 #else //EXPORTS
60 
61 #define IMPINTEGRATIVEDOCKING_EXPORT_TEMPLATE(name) \
62  template class __declspec(dllimport) name
63 
64 #endif // EXPORTS
65 
66 #else // MSC and SWIG
67 #define IMPINTEGRATIVEDOCKING_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
68 
69 #endif // MSC and SWIG
70 
71 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
72 
73 #define IMPINTEGRATIVEDOCKING_BEGIN_NAMESPACE \
74  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{namespace integrative_docking {
75 
76 #define IMPINTEGRATIVEDOCKING_END_NAMESPACE } } \
77 IMP_COMPILER_DISABLE_WARNINGS
78 
79 #define IMPINTEGRATIVEDOCKING_BEGIN_INTERNAL_NAMESPACE IMPINTEGRATIVEDOCKING_BEGIN_NAMESPACE \
80  namespace internal {
81 
82 #define IMPINTEGRATIVEDOCKING_END_INTERNAL_NAMESPACE } IMPINTEGRATIVEDOCKING_END_NAMESPACE
83 
84 #else // SWIG and DOXYGEN
85 #define IMPINTEGRATIVEDOCKING_BEGIN_NAMESPACE namespace IMP{namespace integrative_docking {
86 
87 #define IMPINTEGRATIVEDOCKING_END_NAMESPACE } }
88 
89 #define IMPINTEGRATIVEDOCKING_BEGIN_INTERNAL_NAMESPACE IMPINTEGRATIVEDOCKING_BEGIN_NAMESPACE\
90  namespace internal {
91 
92 #define IMPINTEGRATIVEDOCKING_END_INTERNAL_NAMESPACE } IMPINTEGRATIVEDOCKING_END_NAMESPACE
93 
94 #endif // SWIG AND DOXYGEN
95 
96 #define IMP_INTEGRATIVE_DOCKING_USE_IMP_ALGEBRA
97 #define IMP_INTEGRATIVE_DOCKING_HAS_IMP_ALGEBRA 1
98 #define IMP_INTEGRATIVE_DOCKING_USE_IMP_ATOM
99 #define IMP_INTEGRATIVE_DOCKING_HAS_IMP_ATOM 1
100 #define IMP_INTEGRATIVE_DOCKING_USE_IMP_BASE
101 #define IMP_INTEGRATIVE_DOCKING_HAS_IMP_BASE 1
102 #define IMP_INTEGRATIVE_DOCKING_USE_IMP_CGAL
103 #define IMP_INTEGRATIVE_DOCKING_HAS_IMP_CGAL 1
104 #define IMP_INTEGRATIVE_DOCKING_USE_IMP_CONTAINER
105 #define IMP_INTEGRATIVE_DOCKING_HAS_IMP_CONTAINER 1
106 #define IMP_INTEGRATIVE_DOCKING_USE_IMP_CORE
107 #define IMP_INTEGRATIVE_DOCKING_HAS_IMP_CORE 1
108 #define IMP_INTEGRATIVE_DOCKING_USE_IMP_DISPLAY
109 #define IMP_INTEGRATIVE_DOCKING_HAS_IMP_DISPLAY 1
110 #define IMP_INTEGRATIVE_DOCKING_USE_IMP_DOMINO
111 #define IMP_INTEGRATIVE_DOCKING_HAS_IMP_DOMINO 1
112 #define IMP_INTEGRATIVE_DOCKING_USE_IMP_GSL
113 #define IMP_INTEGRATIVE_DOCKING_HAS_IMP_GSL 1
114 #define IMP_INTEGRATIVE_DOCKING_USE_IMP_KERNEL
115 #define IMP_INTEGRATIVE_DOCKING_HAS_IMP_KERNEL 1
116 #define IMP_INTEGRATIVE_DOCKING_USE_IMP_RMF
117 #define IMP_INTEGRATIVE_DOCKING_HAS_IMP_RMF 1
118 #define IMP_INTEGRATIVE_DOCKING_USE_IMP_SCORE_FUNCTOR
119 #define IMP_INTEGRATIVE_DOCKING_HAS_IMP_SCORE_FUNCTOR 1
120 #define IMP_INTEGRATIVE_DOCKING_USE_IMP_STATISTICS
121 #define IMP_INTEGRATIVE_DOCKING_HAS_IMP_STATISTICS 1
122 #define IMP_INTEGRATIVE_DOCKING_USE_BOOST_FILESYSTEM
123 #define IMP_INTEGRATIVE_DOCKING_HAS_BOOST_FILESYSTEM 1
124 #define IMP_INTEGRATIVE_DOCKING_USE_BOOST_GRAPH
125 #define IMP_INTEGRATIVE_DOCKING_HAS_BOOST_GRAPH 1
126 #define IMP_INTEGRATIVE_DOCKING_USE_BOOST_RANDOM
127 #define IMP_INTEGRATIVE_DOCKING_HAS_BOOST_RANDOM 1
128 #define IMP_INTEGRATIVE_DOCKING_USE_BOOST_REGEX
129 #define IMP_INTEGRATIVE_DOCKING_HAS_BOOST_REGEX 1
130 #define IMP_INTEGRATIVE_DOCKING_USE_BOOST_SYSTEM
131 #define IMP_INTEGRATIVE_DOCKING_HAS_BOOST_SYSTEM 1
132 #define IMP_INTEGRATIVE_DOCKING_USE_CGAL
133 #define IMP_INTEGRATIVE_DOCKING_HAS_CGAL 1
134 #define IMP_INTEGRATIVE_DOCKING_USE_FFTW3
135 #define IMP_INTEGRATIVE_DOCKING_HAS_FFTW3 1
136 #define IMP_INTEGRATIVE_DOCKING_USE_GSL
137 #define IMP_INTEGRATIVE_DOCKING_HAS_GSL 1
138 #define IMP_INTEGRATIVE_DOCKING_USE_HDF5
139 #define IMP_INTEGRATIVE_DOCKING_HAS_HDF5 1
140 #define IMP_INTEGRATIVE_DOCKING_USE_OPENCV22
141 #define IMP_INTEGRATIVE_DOCKING_HAS_OPENCV22 1
142 #define IMP_INTEGRATIVE_DOCKING_USE_RMF
143 #define IMP_INTEGRATIVE_DOCKING_HAS_RMF 1
144 
145 // functions are defined explicitly for SWIG
146 namespace IMP {
147  namespace integrative_docking {
148 /** \name Standard module functions
149  All \imp modules have a set of standard functions to help get information
150  about the module and about files associated with the module.
151  @{
152  */
153 #if !defined(SWIG)
154  IMPINTEGRATIVEDOCKINGEXPORT std::string get_module_version();
155 #endif
156 
157 #if !defined(SWIG)
158  // SWIG will whine about duplicate definitions of function
159  inline std::string get_module_name() { return "IMP::integrative_docking"; }
160 #endif
161 
162  //! Return the full path to installed data
163  /** Each module has its own data directory, so be sure to use
164  the version of this function in the correct module. To read
165  the data file "data_library" that was placed in the \c data
166  directory of module "mymodule", do something like
167  \code
168  std::ifstream in(IMP::mymodule::get_data_path("data_library"));
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  IMPINTEGRATIVEDOCKINGEXPORT std::string get_data_path(std::string file_name);
175 #endif
176 
177  //! Return the path to installed example data for this module
178  /** Each module has its own example directory, so be sure to use
179  the version of this function in the correct module. For example
180  to read the file \c example_protein.pdb located in the
181  \c examples directory of the IMP::atom module, do
182  \code
183  IMP::atom::read_pdb(IMP::atom::get_example_path("example_protein.pdb",
184  model));
185  \endcode
186  This will ensure that the code works when \imp is installed or
187  used via the \c setup_environment.sh script.
188  */
189 #if !defined(SWIG)
190  IMPINTEGRATIVEDOCKINGEXPORT std::string get_example_path(std::string file_name);
191 #endif
192  /** @} */
193 
194 
195  }
196 } //namespace
197 
198 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
199 
200 #include <IMP/base/Showable.h>
201 #include <IMP/base/hash.h>
202 
203 namespace IMP { namespace integrative_docking {
204 using ::IMP::base::Showable;
205 using ::IMP::base::operator<<;
206 using ::IMP::base::hash_value;
207 } } // namespace
208 namespace IMP { namespace integrative_docking { namespace internal {
209 using ::IMP::base::Showable;
210 using ::IMP::base::operator<<;
211 using ::IMP::base::hash_value;
212 } } } // namespace
213 
214 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
215 
216 
218 
219 #endif /* IMPINTEGRATIVEDOCKING_CONFIG_H */
220 
221 // Here so it is always parsed
222 
223 #ifdef IMPINTEGRATIVEDOCKING_DEPRECATED_HEADER
224 #undef IMPINTEGRATIVEDOCKING_DEPRECATED_HEADER
225 #undef IMPINTEGRATIVEDOCKING_DEPRECATED_VALUE_DEF
226 #undef IMPINTEGRATIVEDOCKING_DEPRECATED_VALUE_DECL
227 #undef IMPINTEGRATIVEDOCKING_DEPRECATED_OBJECT_DEF
228 #undef IMPINTEGRATIVEDOCKING_DEPRECATED_OBJECT_DECL
229 #undef IMPINTEGRATIVEDOCKING_DEPRECATED_FUNCTION_DEF
230 #undef IMPINTEGRATIVEDOCKING_DEPRECATED_FUNCTION_DECL
231 #undef IMPINTEGRATIVEDOCKING_DEPRECATED_METHOD_DEF
232 #undef IMPINTEGRATIVEDOCKING_DEPRECATED_METHOD_DECL
233 #undef IMPINTEGRATIVEDOCKING_DEPRECATED_MACRO
234 #undef IMPINTEGRATIVEDOCKING_SHOW_WARNINGS
235 #endif
236 
237 // the central modules we can update easily, so don't warn in them
238 #if defined( IMPINTEGRATIVEDOCKING_COMPILATION) \
239  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
240  || defined( IMPINTEGRATIVEDOCKING_ALL) || defined(IMP_DOXYGEN) \
241  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
242  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
243  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
244  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
245  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
246  || defined(IMPGSL_COMPILATION)
247 #define IMPINTEGRATIVEDOCKING_SHOW_WARNINGS 0
248 #else
249 #define IMPINTEGRATIVEDOCKING_SHOW_WARNINGS 1
250 #endif
251 
252 // suppress header warnings with all header, SWIG wrapper and in the module
253 #if IMPINTEGRATIVEDOCKING_SHOW_WARNINGS
254 #define IMPINTEGRATIVEDOCKING_DEPRECATED_HEADER(version, help_message) \
255  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
256 #define IMPINTEGRATIVEDOCKING_DEPRECATED_VALUE_DECL(version) \
257  IMP_DEPRECATED_ATTRIBUTE
258 #define IMPINTEGRATIVEDOCKING_DEPRECATED_OBJECT_DECL(version) \
259  IMP_DEPRECATED_ATTRIBUTE
260 #define IMPINTEGRATIVEDOCKING_DEPRECATED_FUNCTION_DECL(version) \
261  IMP_DEPRECATED_ATTRIBUTE
262 #define IMPINTEGRATIVEDOCKING_DEPRECATED_METHOD_DECL(version) \
263  IMP_DEPRECATED_ATTRIBUTE
264 
265 #else //IMPINTEGRATIVEDOCKING_SHOW_WARNINGS
266 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
267 #define IMPINTEGRATIVEDOCKING_DEPRECATED_HEADER(version, help_message) \
268 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
269 #define IMPINTEGRATIVEDOCKING_DEPRECATED_VALUE_DECL(version)
270 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
271 #define IMPINTEGRATIVEDOCKING_DEPRECATED_OBJECT_DECL(version)
272 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
273 #define IMPINTEGRATIVEDOCKING_DEPRECATED_FUNCTION_DECL(version)
274 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
275 #define IMPINTEGRATIVEDOCKING_DEPRECATED_METHOD_DECL(version)
276 
277 #endif // IMPINTEGRATIVEDOCKING_SHOW_WARNINGS
278 
279 // only warn about it in the all inclusion to cut down on copies
280 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
281  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
282  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
283  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
284  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
285  || defined(IMPSCOREFUNCTOR_COMPILATION)
286 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
287 #define IMPINTEGRATIVEDOCKING_DEPRECATED_MACRO(version, message)
288 
289 #else
290 #define IMPINTEGRATIVEDOCKING_DEPRECATED_MACRO(version, message) \
291  IMP_DEPRECATED_MACRO(version, message)
292 #endif
293 
294 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
295 #define IMPINTEGRATIVEDOCKING_DEPRECATED_VALUE_DEF(version, message) \
296  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
297 
298 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
299 #define IMPINTEGRATIVEDOCKING_DEPRECATED_OBJECT_DEF(version, message) \
300  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
301 
302 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
303 #define IMPINTEGRATIVEDOCKING_DEPRECATED_FUNCTION_DEF(version, message) \
304  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
305 
306 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
307 #define IMPINTEGRATIVEDOCKING_DEPRECATED_METHOD_DEF(version, message) \
308  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
309 
310 
312 
313 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
314 IMP_COMPILER_ENABLE_WARNINGS
315 #define IMP_EXECUTABLE_WARNINGS
316 #endif
std::string get_data_path(std::string file_name)
Return the full path to installed data.
IO support.
IO support.
Various compiler workarounds.
std::string get_example_path(std::string file_name)
Return the path to installed example data for this module.