IMP  2.2.1
The Integrative Modeling Platform
kinematics_config.h
1 /*
2  * \file IMP/kinematics/kinematics_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, IMPKINEMATICS_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  * IMPKINEMATICSEXPORT 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::kinematics namespace.
17  * This is simply achieved by wrapping things with the
18  * IMPKINEMATICS_BEGIN_NAMESPACE and IMPKINEMATICS_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 IMPKINEMATICS_CONFIG_H
30 #define IMPKINEMATICS_CONFIG_H
31 
32 #include <IMP/base/base_config.h>
33 #include <string>
34 
35 #ifdef _MSC_VER
36 
37 #ifdef IMPKINEMATICS_EXPORTS
38 #define IMPKINEMATICSEXPORT __declspec(dllexport)
39 #else // EXPORTS
40 #define IMPKINEMATICSEXPORT __declspec(dllimport)
41 #endif // EXPORTS
42 
43 #else // _MSC_VER
44 
45 #ifdef GCC_VISIBILITY
46 #define IMPKINEMATICSEXPORT __attribute__((visibility("default")))
47 #else // GCC_VISIBILITY
48 #define IMPKINEMATICSEXPORT
49 #endif // GCC_VISIBILITY
50 
51 #endif // _MSC_VER
52 
53 #if defined(_MSC_VER) && !defined(SWIG)
54 #ifdef IMPKINEMATICS_EXPORTS
55 
56 #define IMPKINEMATICS_EXPORT_TEMPLATE(name) \
57  template class __declspec(dllexport) name
58 
59 #else //EXPORTS
60 
61 #define IMPKINEMATICS_EXPORT_TEMPLATE(name) \
62  template class __declspec(dllimport) name
63 
64 #endif // EXPORTS
65 
66 #else // MSC and SWIG
67 #define IMPKINEMATICS_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
68 
69 #endif // MSC and SWIG
70 
71 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
72 
73 #define IMPKINEMATICS_BEGIN_NAMESPACE \
74  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{namespace kinematics {
75 
76 #define IMPKINEMATICS_END_NAMESPACE } } \
77 IMP_COMPILER_DISABLE_WARNINGS
78 
79 #define IMPKINEMATICS_BEGIN_INTERNAL_NAMESPACE IMPKINEMATICS_BEGIN_NAMESPACE \
80  namespace internal {
81 
82 #define IMPKINEMATICS_END_INTERNAL_NAMESPACE } IMPKINEMATICS_END_NAMESPACE
83 
84 #else // SWIG and DOXYGEN
85 #define IMPKINEMATICS_BEGIN_NAMESPACE namespace IMP{namespace kinematics {
86 
87 #define IMPKINEMATICS_END_NAMESPACE } }
88 
89 #define IMPKINEMATICS_BEGIN_INTERNAL_NAMESPACE IMPKINEMATICS_BEGIN_NAMESPACE\
90  namespace internal {
91 
92 #define IMPKINEMATICS_END_INTERNAL_NAMESPACE } IMPKINEMATICS_END_NAMESPACE
93 
94 #endif // SWIG AND DOXYGEN
95 
96 #define IMP_KINEMATICS_USE_IMP_CGAL
97 #define IMP_KINEMATICS_HAS_IMP_CGAL 1
98 #define IMP_KINEMATICS_USE_IMP_DISPLAY
99 #define IMP_KINEMATICS_HAS_IMP_DISPLAY 1
100 #define IMP_KINEMATICS_USE_IMP_KERNEL
101 #define IMP_KINEMATICS_HAS_IMP_KERNEL 1
102 #define IMP_KINEMATICS_USE_IMP_SCORE_FUNCTOR
103 #define IMP_KINEMATICS_HAS_IMP_SCORE_FUNCTOR 1
104 #define IMP_KINEMATICS_USE_BOOST_FILESYSTEM
105 #define IMP_KINEMATICS_HAS_BOOST_FILESYSTEM 1
106 #define IMP_KINEMATICS_USE_BOOST_PROGRAMOPTIONS
107 #define IMP_KINEMATICS_HAS_BOOST_PROGRAMOPTIONS 1
108 #define IMP_KINEMATICS_USE_BOOST_RANDOM
109 #define IMP_KINEMATICS_HAS_BOOST_RANDOM 1
110 #define IMP_KINEMATICS_USE_BOOST_REGEX
111 #define IMP_KINEMATICS_HAS_BOOST_REGEX 1
112 #define IMP_KINEMATICS_USE_BOOST_SYSTEM
113 #define IMP_KINEMATICS_HAS_BOOST_SYSTEM 1
114 #define IMP_KINEMATICS_USE_CGAL
115 #define IMP_KINEMATICS_HAS_CGAL 1
116 #define IMP_KINEMATICS_USE_HDF5
117 #define IMP_KINEMATICS_HAS_HDF5 1
118 
119  // functions are defined explicitly for SWIG
120  namespace IMP {
121  namespace kinematics {
122 /** \name Standard module methods
123  All \imp modules have a set of standard methods to help get information
124  about the module and about files associated with the module.
125  @{
126  */
127 #if !defined(SWIG)
128  IMPKINEMATICSEXPORT std::string get_module_version();
129 #endif
130 
131 #if !defined(SWIG)
132  // SWIG will whine about duplicate definitions of function
133  inline std::string get_module_name() { return "IMP::kinematics"; }
134 #endif
135 
136  }
137 } //namespace
138 
139 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
140 
141 #include <IMP/base/Showable.h>
142 #include <IMP/base/hash.h>
143 
144 namespace IMP { namespace kinematics {
145 using ::IMP::base::Showable;
146 using ::IMP::base::operator<<;
147 using ::IMP::base::hash_value;
148 } } // namespace
149 namespace IMP { namespace kinematics { namespace internal {
150 using ::IMP::base::Showable;
151 using ::IMP::base::operator<<;
152 using ::IMP::base::hash_value;
153 } } } // namespace
154 
155 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
156 
157 
158 #if !defined(SWIG)
159  namespace IMP {
160  namespace kinematics {
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  IMPKINEMATICSEXPORT std::string get_data_path(std::string file_name);
174 
175  //! Return the path to installed example data for this module
176  /** Each module has its own example directory, so be sure to use
177  the version of this function in the correct module. For example
178  to read the file \c example_protein.pdb located in the
179  \c examples directory of the IMP::atom module, do
180  \code
181  IMP::atom::read_pdb(IMP::atom::get_example_path("example_protein.pdb",
182  model));
183  \endcode
184  This will ensure that the code works when \imp is installed or
185  used via the \c setup_environment.sh script.
186  */
187  IMPKINEMATICSEXPORT std::string get_example_path(std::string file_name);
188  /** @} */
189 
190  }
191 } // namespace
192 
193 #endif // SWIG
194 
196 
197 #ifdef IMP_DOXYGEN
198 /** \namespace IMP::kinematics
199  \brief See [IMP.kinematics](\ref impkinematics) for more information.
200  */
201 #endif
202 
203 #endif /* IMPKINEMATICS_CONFIG_H */
204 
205 // Here so it is always parsed
206 
207 #ifdef IMPKINEMATICS_DEPRECATED_HEADER
208 #undef IMPKINEMATICS_DEPRECATED_HEADER
209 #undef IMPKINEMATICS_DEPRECATED_VALUE_DEF
210 #undef IMPKINEMATICS_DEPRECATED_VALUE_DECL
211 #undef IMPKINEMATICS_DEPRECATED_OBJECT_DEF
212 #undef IMPKINEMATICS_DEPRECATED_OBJECT_DECL
213 #undef IMPKINEMATICS_DEPRECATED_FUNCTION_DEF
214 #undef IMPKINEMATICS_DEPRECATED_FUNCTION_DECL
215 #undef IMPKINEMATICS_DEPRECATED_METHOD_DEF
216 #undef IMPKINEMATICS_DEPRECATED_METHOD_DECL
217 #undef IMPKINEMATICS_DEPRECATED_MACRO
218 #undef IMPKINEMATICS_SHOW_WARNINGS
219 #endif
220 
221 // the central modules we can update easily, so don't warn in them
222 #if defined( IMPKINEMATICS_COMPILATION) \
223  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
224  || defined( IMPKINEMATICS_ALL) || defined(IMP_DOXYGEN) \
225  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
226  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
227  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
228  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
229  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
230  || defined(IMPGSL_COMPILATION)
231 #define IMPKINEMATICS_SHOW_WARNINGS 0
232 #else
233 #define IMPKINEMATICS_SHOW_WARNINGS 1
234 #endif
235 
236 // suppress header warnings with all header, SWIG wrapper and in the module
237 #if IMPKINEMATICS_SHOW_WARNINGS
238 #define IMPKINEMATICS_DEPRECATED_HEADER(version, help_message) \
239  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
240 #define IMPKINEMATICS_DEPRECATED_VALUE_DECL(version) \
241  IMP_DEPRECATED_ATTRIBUTE
242 #define IMPKINEMATICS_DEPRECATED_OBJECT_DECL(version) \
243  IMP_DEPRECATED_ATTRIBUTE
244 #define IMPKINEMATICS_DEPRECATED_FUNCTION_DECL(version) \
245  IMP_DEPRECATED_ATTRIBUTE
246 #define IMPKINEMATICS_DEPRECATED_METHOD_DECL(version) \
247  IMP_DEPRECATED_ATTRIBUTE
248 
249 #else //IMPKINEMATICS_SHOW_WARNINGS
250 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
251 #define IMPKINEMATICS_DEPRECATED_HEADER(version, help_message) \
252 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
253 #define IMPKINEMATICS_DEPRECATED_VALUE_DECL(version)
254 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
255 #define IMPKINEMATICS_DEPRECATED_OBJECT_DECL(version)
256 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
257 #define IMPKINEMATICS_DEPRECATED_FUNCTION_DECL(version)
258 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
259 #define IMPKINEMATICS_DEPRECATED_METHOD_DECL(version)
260 
261 #endif // IMPKINEMATICS_SHOW_WARNINGS
262 
263 // only warn about it in the all inclusion to cut down on copies
264 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
265  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
266  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
267  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
268  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
269  || defined(IMPSCOREFUNCTOR_COMPILATION)
270 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
271 #define IMPKINEMATICS_DEPRECATED_MACRO(version, message)
272 
273 #else
274 #define IMPKINEMATICS_DEPRECATED_MACRO(version, message) \
275  IMP_DEPRECATED_MACRO(version, message)
276 #endif
277 
278 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
279 #define IMPKINEMATICS_DEPRECATED_VALUE_DEF(version, message) \
280  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
281 
282 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
283 #define IMPKINEMATICS_DEPRECATED_OBJECT_DEF(version, message) \
284  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
285 
286 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
287 #define IMPKINEMATICS_DEPRECATED_FUNCTION_DEF(version, message) \
288  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
289 
290 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
291 #define IMPKINEMATICS_DEPRECATED_METHOD_DEF(version, message) \
292  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
293 
294 
296 
297 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
298 IMP_COMPILER_ENABLE_WARNINGS
299 #define IMP_EXECUTABLE_WARNINGS
300 #endif
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.
IO support.
IO support.