IMP  2.2.0
The Integrative Modeling Platform
rotamer_config.h
1 /*
2  * \file IMP/rotamer/rotamer_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, IMPROTAMER_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  * IMPROTAMEREXPORT 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::rotamer namespace.
17  * This is simply achieved by wrapping things with the
18  * IMPROTAMER_BEGIN_NAMESPACE and IMPROTAMER_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 IMPROTAMER_CONFIG_H
30 #define IMPROTAMER_CONFIG_H
31 
32 #include <IMP/base/base_config.h>
33 #include <string>
34 
35 #ifdef _MSC_VER
36 
37 #ifdef IMPROTAMER_EXPORTS
38 #define IMPROTAMEREXPORT __declspec(dllexport)
39 #else // EXPORTS
40 #define IMPROTAMEREXPORT __declspec(dllimport)
41 #endif // EXPORTS
42 
43 #else // _MSC_VER
44 
45 #ifdef GCC_VISIBILITY
46 #define IMPROTAMEREXPORT __attribute__((visibility("default")))
47 #else // GCC_VISIBILITY
48 #define IMPROTAMEREXPORT
49 #endif // GCC_VISIBILITY
50 
51 #endif // _MSC_VER
52 
53 #if defined(_MSC_VER) && !defined(SWIG)
54 #ifdef IMPROTAMER_EXPORTS
55 
56 #define IMPROTAMER_EXPORT_TEMPLATE(name) \
57  template class __declspec(dllexport) name
58 
59 #else //EXPORTS
60 
61 #define IMPROTAMER_EXPORT_TEMPLATE(name) \
62  template class __declspec(dllimport) name
63 
64 #endif // EXPORTS
65 
66 #else // MSC and SWIG
67 #define IMPROTAMER_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
68 
69 #endif // MSC and SWIG
70 
71 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
72 
73 #define IMPROTAMER_BEGIN_NAMESPACE \
74  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{namespace rotamer {
75 
76 #define IMPROTAMER_END_NAMESPACE } } \
77 IMP_COMPILER_DISABLE_WARNINGS
78 
79 #define IMPROTAMER_BEGIN_INTERNAL_NAMESPACE IMPROTAMER_BEGIN_NAMESPACE \
80  namespace internal {
81 
82 #define IMPROTAMER_END_INTERNAL_NAMESPACE } IMPROTAMER_END_NAMESPACE
83 
84 #else // SWIG and DOXYGEN
85 #define IMPROTAMER_BEGIN_NAMESPACE namespace IMP{namespace rotamer {
86 
87 #define IMPROTAMER_END_NAMESPACE } }
88 
89 #define IMPROTAMER_BEGIN_INTERNAL_NAMESPACE IMPROTAMER_BEGIN_NAMESPACE\
90  namespace internal {
91 
92 #define IMPROTAMER_END_INTERNAL_NAMESPACE } IMPROTAMER_END_NAMESPACE
93 
94 #endif // SWIG AND DOXYGEN
95 
96 #define IMP_ROTAMER_USE_IMP_ALGEBRA
97 #define IMP_ROTAMER_HAS_IMP_ALGEBRA 1
98 #define IMP_ROTAMER_USE_IMP_BASE
99 #define IMP_ROTAMER_HAS_IMP_BASE 1
100 #define IMP_ROTAMER_USE_IMP_CGAL
101 #define IMP_ROTAMER_HAS_IMP_CGAL 1
102 #define IMP_ROTAMER_USE_IMP_CONTAINER
103 #define IMP_ROTAMER_HAS_IMP_CONTAINER 1
104 #define IMP_ROTAMER_USE_IMP_DISPLAY
105 #define IMP_ROTAMER_HAS_IMP_DISPLAY 1
106 #define IMP_ROTAMER_USE_IMP_KERNEL
107 #define IMP_ROTAMER_HAS_IMP_KERNEL 1
108 #define IMP_ROTAMER_USE_IMP_SCORE_FUNCTOR
109 #define IMP_ROTAMER_HAS_IMP_SCORE_FUNCTOR 1
110 #define IMP_ROTAMER_USE_BOOST_FILESYSTEM
111 #define IMP_ROTAMER_HAS_BOOST_FILESYSTEM 1
112 #define IMP_ROTAMER_USE_BOOST_PROGRAMOPTIONS
113 #define IMP_ROTAMER_HAS_BOOST_PROGRAMOPTIONS 1
114 #define IMP_ROTAMER_USE_BOOST_RANDOM
115 #define IMP_ROTAMER_HAS_BOOST_RANDOM 1
116 #define IMP_ROTAMER_USE_BOOST_REGEX
117 #define IMP_ROTAMER_HAS_BOOST_REGEX 1
118 #define IMP_ROTAMER_USE_BOOST_SYSTEM
119 #define IMP_ROTAMER_HAS_BOOST_SYSTEM 1
120 #define IMP_ROTAMER_USE_CGAL
121 #define IMP_ROTAMER_HAS_CGAL 1
122 #define IMP_ROTAMER_USE_HDF5
123 #define IMP_ROTAMER_HAS_HDF5 1
124 
125  // functions are defined explicitly for SWIG
126  namespace IMP {
127  namespace rotamer {
128 /** \name Standard module methods
129  All \imp modules have a set of standard methods to help get information
130  about the module and about files associated with the module.
131  @{
132  */
133 #if !defined(SWIG)
134  IMPROTAMEREXPORT 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::rotamer"; }
140 #endif
141 
142  }
143 } //namespace
144 
145 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
146 
147 #include <IMP/base/Showable.h>
148 #include <IMP/base/hash.h>
149 
150 namespace IMP { namespace rotamer {
151 using ::IMP::base::Showable;
152 using ::IMP::base::operator<<;
153 using ::IMP::base::hash_value;
154 } } // namespace
155 namespace IMP { namespace rotamer { namespace internal {
156 using ::IMP::base::Showable;
157 using ::IMP::base::operator<<;
158 using ::IMP::base::hash_value;
159 } } } // namespace
160 
161 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
162 
163 
164 #if !defined(SWIG)
165  namespace IMP {
166  namespace rotamer {
167 
168  //! Return the full path to installed data
169  /** Each module has its own data directory, so be sure to use
170  the version of this function in the correct module. To read
171  the data file "data_library" that was placed in the \c data
172  directory of module "mymodule", do something like
173  \code
174  std::ifstream in(IMP::mymodule::get_data_path("data_library"));
175  \endcode
176  This will ensure that the code works when \imp is installed or
177  used via the \c setup_environment.sh script.
178  */
179  IMPROTAMEREXPORT std::string get_data_path(std::string file_name);
180 
181  //! Return the path to installed example data for this module
182  /** Each module has its own example directory, so be sure to use
183  the version of this function in the correct module. For example
184  to read the file \c example_protein.pdb located in the
185  \c examples directory of the IMP::atom module, do
186  \code
187  IMP::atom::read_pdb(IMP::atom::get_example_path("example_protein.pdb",
188  model));
189  \endcode
190  This will ensure that the code works when \imp is installed or
191  used via the \c setup_environment.sh script.
192  */
193  IMPROTAMEREXPORT std::string get_example_path(std::string file_name);
194  /** @} */
195 
196  }
197 } // namespace
198 
199 #endif // SWIG
200 
201 #include <IMP/base/compiler_macros.h>
202 
203 #ifdef IMP_DOXYGEN
204 /** \namespace IMP::rotamer
205  \brief See [IMP.rotamer](\ref improtamer) for more information.
206  */
207 #endif
208 
209 #endif /* IMPROTAMER_CONFIG_H */
210 
211 // Here so it is always parsed
212 
213 #ifdef IMPROTAMER_DEPRECATED_HEADER
214 #undef IMPROTAMER_DEPRECATED_HEADER
215 #undef IMPROTAMER_DEPRECATED_VALUE_DEF
216 #undef IMPROTAMER_DEPRECATED_VALUE_DECL
217 #undef IMPROTAMER_DEPRECATED_OBJECT_DEF
218 #undef IMPROTAMER_DEPRECATED_OBJECT_DECL
219 #undef IMPROTAMER_DEPRECATED_FUNCTION_DEF
220 #undef IMPROTAMER_DEPRECATED_FUNCTION_DECL
221 #undef IMPROTAMER_DEPRECATED_METHOD_DEF
222 #undef IMPROTAMER_DEPRECATED_METHOD_DECL
223 #undef IMPROTAMER_DEPRECATED_MACRO
224 #undef IMPROTAMER_SHOW_WARNINGS
225 #endif
226 
227 // the central modules we can update easily, so don't warn in them
228 #if defined( IMPROTAMER_COMPILATION) \
229  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
230  || defined( IMPROTAMER_ALL) || defined(IMP_DOXYGEN) \
231  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
232  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
233  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
234  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
235  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
236  || defined(IMPGSL_COMPILATION)
237 #define IMPROTAMER_SHOW_WARNINGS 0
238 #else
239 #define IMPROTAMER_SHOW_WARNINGS 1
240 #endif
241 
242 // suppress header warnings with all header, SWIG wrapper and in the module
243 #if IMPROTAMER_SHOW_WARNINGS
244 #define IMPROTAMER_DEPRECATED_HEADER(version, help_message) \
245  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
246 #define IMPROTAMER_DEPRECATED_VALUE_DECL(version) \
247  IMP_DEPRECATED_ATTRIBUTE
248 #define IMPROTAMER_DEPRECATED_OBJECT_DECL(version) \
249  IMP_DEPRECATED_ATTRIBUTE
250 #define IMPROTAMER_DEPRECATED_FUNCTION_DECL(version) \
251  IMP_DEPRECATED_ATTRIBUTE
252 #define IMPROTAMER_DEPRECATED_METHOD_DECL(version) \
253  IMP_DEPRECATED_ATTRIBUTE
254 
255 #else //IMPROTAMER_SHOW_WARNINGS
256 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
257 #define IMPROTAMER_DEPRECATED_HEADER(version, help_message) \
258 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
259 #define IMPROTAMER_DEPRECATED_VALUE_DECL(version)
260 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
261 #define IMPROTAMER_DEPRECATED_OBJECT_DECL(version)
262 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
263 #define IMPROTAMER_DEPRECATED_FUNCTION_DECL(version)
264 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
265 #define IMPROTAMER_DEPRECATED_METHOD_DECL(version)
266 
267 #endif // IMPROTAMER_SHOW_WARNINGS
268 
269 // only warn about it in the all inclusion to cut down on copies
270 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
271  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
272  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
273  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
274  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
275  || defined(IMPSCOREFUNCTOR_COMPILATION)
276 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
277 #define IMPROTAMER_DEPRECATED_MACRO(version, message)
278 
279 #else
280 #define IMPROTAMER_DEPRECATED_MACRO(version, message) \
281  IMP_DEPRECATED_MACRO(version, message)
282 #endif
283 
284 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
285 #define IMPROTAMER_DEPRECATED_VALUE_DEF(version, message) \
286  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
287 
288 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
289 #define IMPROTAMER_DEPRECATED_OBJECT_DEF(version, message) \
290  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
291 
292 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
293 #define IMPROTAMER_DEPRECATED_FUNCTION_DEF(version, message) \
294  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
295 
296 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
297 #define IMPROTAMER_DEPRECATED_METHOD_DEF(version, message) \
298  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
299 
300 
301 #include <IMP/base/compiler_macros.h>
302 
303 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
304 IMP_COMPILER_ENABLE_WARNINGS
305 #define IMP_EXECUTABLE_WARNINGS
306 #endif
compiler_macros.h
Various compiler workarounds.
IMP::rotamer::get_data_path
std::string get_data_path(std::string file_name)
Return the full path to installed data.
IMP::rotamer::get_example_path
std::string get_example_path(std::string file_name)
Return the path to installed example data for this module.
hash.h
IO support.
Showable.h
IO support.