IMP  2.1.1
The Integrative Modeling Platform
atom_config.h
1 /*
2  * \file IMP/atom/atom_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, IMPATOM_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  * IMPATOMEXPORT 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::atom namespace.
17  * This is simply achieved by wrapping things with the
18  * IMPATOM_BEGIN_NAMESPACE and IMPATOM_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-2013 IMP Inventors. All rights reserved.
26  *
27  */
28 
29 #ifndef IMPATOM_CONFIG_H
30 #define IMPATOM_CONFIG_H
31 
32 #include <IMP/base/base_config.h>
33 #include <string>
34 
35 #ifdef _MSC_VER
36 
37 #ifdef IMPATOM_EXPORTS
38 #define IMPATOMEXPORT __declspec(dllexport)
39 #else // EXPORTS
40 #define IMPATOMEXPORT __declspec(dllimport)
41 #endif // EXPORTS
42 
43 #else // _MSC_VER
44 
45 #ifdef GCC_VISIBILITY
46 #define IMPATOMEXPORT __attribute__((visibility("default")))
47 #else // GCC_VISIBILITY
48 #define IMPATOMEXPORT
49 #endif // GCC_VISIBILITY
50 
51 #endif // _MSC_VER
52 
53 #if defined(_MSC_VER) && !defined(SWIG)
54 #ifdef IMPATOM_EXPORTS
55 
56 #define IMPATOM_EXPORT_TEMPLATE(name) \
57  template class __declspec(dllexport) name
58 
59 #else //EXPORTS
60 
61 #define IMPATOM_EXPORT_TEMPLATE(name) \
62  template class __declspec(dllimport) name
63 
64 #endif // EXPORTS
65 
66 #else // MSC and SWIG
67 #define IMPATOM_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
68 
69 #endif // MSC and SWIG
70 
71 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
72 
73 #define IMPATOM_BEGIN_NAMESPACE \
74  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{namespace atom {
75 
76 #define IMPATOM_END_NAMESPACE } } \
77 IMP_COMPILER_DISABLE_WARNINGS
78 
79 #define IMPATOM_BEGIN_INTERNAL_NAMESPACE IMPATOM_BEGIN_NAMESPACE \
80  namespace internal {
81 
82 #define IMPATOM_END_INTERNAL_NAMESPACE } IMPATOM_END_NAMESPACE
83 
84 #else // SWIG and DOXYGEN
85 #define IMPATOM_BEGIN_NAMESPACE namespace IMP{namespace atom {
86 
87 #define IMPATOM_END_NAMESPACE } }
88 
89 #define IMPATOM_BEGIN_INTERNAL_NAMESPACE IMPATOM_BEGIN_NAMESPACE\
90  namespace internal {
91 
92 #define IMPATOM_END_INTERNAL_NAMESPACE } IMPATOM_END_NAMESPACE
93 
94 #endif // SWIG AND DOXYGEN
95 
96 #define IMP_ATOM_USE_IMP_BASE
97 #define IMP_ATOM_HAS_IMP_BASE 1
98 #define IMP_ATOM_USE_IMP_CGAL
99 #define IMP_ATOM_HAS_IMP_CGAL 1
100 #define IMP_ATOM_USE_IMP_KERNEL
101 #define IMP_ATOM_HAS_IMP_KERNEL 1
102 #define IMP_ATOM_USE_IMP_SCORE_FUNCTOR
103 #define IMP_ATOM_HAS_IMP_SCORE_FUNCTOR 1
104 #define IMP_ATOM_USE_BOOST_PROGRAMOPTIONS
105 #define IMP_ATOM_HAS_BOOST_PROGRAMOPTIONS 1
106 #define IMP_ATOM_USE_BOOST_RANDOM
107 #define IMP_ATOM_HAS_BOOST_RANDOM 1
108 #define IMP_ATOM_USE_BOOST_REGEX
109 #define IMP_ATOM_HAS_BOOST_REGEX 1
110 #define IMP_ATOM_USE_BOOST_SYSTEM
111 #define IMP_ATOM_HAS_BOOST_SYSTEM 1
112 #define IMP_ATOM_USE_CGAL
113 #define IMP_ATOM_HAS_CGAL 1
114 
115  // functions are defined explicitly for SWIG
116  namespace IMP {
117  namespace atom {
118 /** \name Standard module methods
119  All \imp modules have a set of standard methods to help get information
120  about the module and about files associated with the module.
121  @{
122  */
123 #if !defined(SWIG)
124  IMPATOMEXPORT std::string get_module_version();
125 #endif
126 
127 #if !defined(SWIG)
128  // SWIG will whine about duplicate definitions of function
129  inline std::string get_module_name() { return "IMP::atom"; }
130 #endif
131 
132  }
133 } //namespace
134 
135 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
136 
137 #include <IMP/base/Showable.h>
138 #include <IMP/base/hash.h>
139 
140 namespace IMP { namespace atom {
141 using ::IMP::base::Showable;
142 using ::IMP::base::operator<<;
143 using ::IMP::base::hash_value;
144 } } // namespace
145 namespace IMP { namespace atom { namespace internal {
146 using ::IMP::base::Showable;
147 using ::IMP::base::operator<<;
148 using ::IMP::base::hash_value;
149 } } } // namespace
150 
151 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
152 
153 
154 #if !defined(SWIG)
155  namespace IMP {
156  namespace atom {
157 
158  //! Return the full path to installed data
159  /** Each module has its own data directory, so be sure to use
160  the version of this function in the correct module. To read
161  the data file "data_library" that was placed in the \c data
162  directory of module "mymodule", do something like
163  \code
164  std::ifstream in(IMP::mymodule::get_data_path("data_library"));
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  IMPATOMEXPORT std::string get_data_path(std::string file_name);
170 
171  //! Return the path to installed example data for this module
172  /** Each module has its own example directory, so be sure to use
173  the version of this function in the correct module. For example
174  to read the file \c example_protein.pdb located in the
175  \c examples directory of the IMP::atom module, do
176  \code
177  IMP::atom::read_pdb(IMP::atom::get_example_path("example_protein.pdb",
178  model));
179  \endcode
180  This will ensure that the code works when \imp is installed or
181  used via the \c setup_environment.sh script.
182  */
183  IMPATOMEXPORT std::string get_example_path(std::string file_name);
184  /** @} */
185 
186  }
187 } // namespace
188 
189 #endif // SWIG
190 
192 
193 #ifdef IMP_DOXYGEN
194 /** \namespace IMP::atom
195  \brief See [IMP.atom](\ref impatom) for more information.
196  */
197 #endif
198 
199 #endif /* IMPATOM_CONFIG_H */
200 
201 // Here so it is always parsed
202 
203 #ifdef IMPATOM_DEPRECATED_HEADER
204 #undef IMPATOM_DEPRECATED_HEADER
205 #undef IMPATOM_DEPRECATED_VALUE_DEF
206 #undef IMPATOM_DEPRECATED_VALUE_DECL
207 #undef IMPATOM_DEPRECATED_OBJECT_DEF
208 #undef IMPATOM_DEPRECATED_OBJECT_DECL
209 #undef IMPATOM_DEPRECATED_FUNCTION_DEF
210 #undef IMPATOM_DEPRECATED_FUNCTION_DECL
211 #undef IMPATOM_DEPRECATED_METHOD_DEF
212 #undef IMPATOM_DEPRECATED_METHOD_DECL
213 #undef IMPATOM_DEPRECATED_MACRO
214 #undef IMPATOM_SHOW_WARNINGS
215 #endif
216 
217 // the central modules we can update easily, so don't warn in them
218 #if defined( IMPATOM_COMPILATION) \
219  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
220  || defined( IMPATOM_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 IMPATOM_SHOW_WARNINGS 0
228 #else
229 #define IMPATOM_SHOW_WARNINGS 1
230 #endif
231 
232 // suppress header warnings with all header, SWIG wrapper and in the module
233 #if IMPATOM_SHOW_WARNINGS
234 #define IMPATOM_DEPRECATED_HEADER(version, help_message) \
235  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
236 #define IMPATOM_DEPRECATED_VALUE_DECL(version) \
237  IMP_DEPRECATED_ATTRIBUTE
238 #define IMPATOM_DEPRECATED_OBJECT_DECL(version) \
239  IMP_DEPRECATED_ATTRIBUTE
240 #define IMPATOM_DEPRECATED_FUNCTION_DECL(version) \
241  IMP_DEPRECATED_ATTRIBUTE
242 #define IMPATOM_DEPRECATED_METHOD_DECL(version) \
243  IMP_DEPRECATED_ATTRIBUTE
244 
245 #else //IMPATOM_SHOW_WARNINGS
246 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
247 #define IMPATOM_DEPRECATED_HEADER(version, help_message) \
248 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
249 #define IMPATOM_DEPRECATED_VALUE_DECL(version)
250 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
251 #define IMPATOM_DEPRECATED_OBJECT_DECL(version)
252 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
253 #define IMPATOM_DEPRECATED_FUNCTION_DECL(version)
254 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
255 #define IMPATOM_DEPRECATED_METHOD_DECL(version)
256 
257 #endif // IMPATOM_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 IMPATOM_DEPRECATED_MACRO(version, message)
268 
269 #else
270 #define IMPATOM_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 IMPATOM_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 IMPATOM_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 IMPATOM_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 IMPATOM_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
std::string get_example_path(std::string file_name)
Return the path to installed example data for this module.
Various compiler workarounds.
IO support.
IO support.
std::string get_data_path(std::string file_name)
Return the full path to installed data.