IMP  2.3.0
The Integrative Modeling Platform
core_config.h
1 /*
2  * \file IMP/core/core_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, IMPCORE_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  * IMPCOREEXPORT 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::core namespace.
17  * This is simply achieved by wrapping things with the
18  * IMPCORE_BEGIN_NAMESPACE and IMPCORE_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 IMPCORE_CONFIG_H
30 #define IMPCORE_CONFIG_H
31 
32 #include <IMP/base/base_config.h>
33 #include <string>
34 
35 #ifdef _MSC_VER
36 
37 #ifdef IMPCORE_EXPORTS
38 #define IMPCOREEXPORT __declspec(dllexport)
39 #else // EXPORTS
40 #define IMPCOREEXPORT __declspec(dllimport)
41 #endif // EXPORTS
42 
43 #else // _MSC_VER
44 
45 #ifdef GCC_VISIBILITY
46 #define IMPCOREEXPORT __attribute__((visibility("default")))
47 #else // GCC_VISIBILITY
48 #define IMPCOREEXPORT
49 #endif // GCC_VISIBILITY
50 
51 #endif // _MSC_VER
52 
53 #if defined(_MSC_VER) && !defined(SWIG)
54 #ifdef IMPCORE_EXPORTS
55 
56 #define IMPCORE_EXPORT_TEMPLATE(name) \
57  template class __declspec(dllexport) name
58 
59 #else //EXPORTS
60 
61 #define IMPCORE_EXPORT_TEMPLATE(name) \
62  template class __declspec(dllimport) name
63 
64 #endif // EXPORTS
65 
66 #else // MSC and SWIG
67 #define IMPCORE_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
68 
69 #endif // MSC and SWIG
70 
71 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
72 
73 #define IMPCORE_BEGIN_NAMESPACE \
74  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{namespace core {
75 
76 #define IMPCORE_END_NAMESPACE } } \
77 IMP_COMPILER_DISABLE_WARNINGS
78 
79 #define IMPCORE_BEGIN_INTERNAL_NAMESPACE IMPCORE_BEGIN_NAMESPACE \
80  namespace internal {
81 
82 #define IMPCORE_END_INTERNAL_NAMESPACE } IMPCORE_END_NAMESPACE
83 
84 #else // SWIG and DOXYGEN
85 #define IMPCORE_BEGIN_NAMESPACE namespace IMP{namespace core {
86 
87 #define IMPCORE_END_NAMESPACE } }
88 
89 #define IMPCORE_BEGIN_INTERNAL_NAMESPACE IMPCORE_BEGIN_NAMESPACE\
90  namespace internal {
91 
92 #define IMPCORE_END_INTERNAL_NAMESPACE } IMPCORE_END_NAMESPACE
93 
94 #endif // SWIG AND DOXYGEN
95 
96 #define IMP_CORE_USE_IMP_BASE
97 #define IMP_CORE_HAS_IMP_BASE 1
98 #define IMP_CORE_USE_IMP_CGAL
99 #define IMP_CORE_HAS_IMP_CGAL 1
100 #define IMP_CORE_USE_IMP_KERNEL
101 #define IMP_CORE_HAS_IMP_KERNEL 1
102 #define IMP_CORE_USE_BOOST_FILESYSTEM
103 #define IMP_CORE_HAS_BOOST_FILESYSTEM 1
104 #define IMP_CORE_USE_BOOST_PROGRAMOPTIONS
105 #define IMP_CORE_HAS_BOOST_PROGRAMOPTIONS 1
106 #define IMP_CORE_USE_BOOST_RANDOM
107 #define IMP_CORE_HAS_BOOST_RANDOM 1
108 #define IMP_CORE_USE_BOOST_SYSTEM
109 #define IMP_CORE_HAS_BOOST_SYSTEM 1
110 #define IMP_CORE_USE_CGAL
111 #define IMP_CORE_HAS_CGAL 1
112 #define IMP_CORE_USE_HDF5
113 #define IMP_CORE_HAS_HDF5 1
114 
115 // functions are defined explicitly for SWIG
116 namespace IMP {
117  namespace core {
118 /** \name Standard module functions
119  All \imp modules have a set of standard functions to help get information
120  about the module and about files associated with the module.
121  @{
122  */
123 #if !defined(SWIG)
124  IMPCOREEXPORT 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::core"; }
130 #endif
131 
132  //! Return the full path to installed data
133  /** Each module has its own data directory, so be sure to use
134  the version of this function in the correct module. To read
135  the data file "data_library" that was placed in the \c data
136  directory of module "mymodule", do something like
137  \code
138  std::ifstream in(IMP::mymodule::get_data_path("data_library"));
139  \endcode
140  This will ensure that the code works when \imp is installed or
141  used via the \c setup_environment.sh script.
142  */
143 #if !defined(SWIG)
144  IMPCOREEXPORT std::string get_data_path(std::string file_name);
145 #endif
146 
147  //! Return the path to installed example data for this module
148  /** Each module has its own example directory, so be sure to use
149  the version of this function in the correct module. For example
150  to read the file \c example_protein.pdb located in the
151  \c examples directory of the IMP::atom module, do
152  \code
153  IMP::atom::read_pdb(IMP::atom::get_example_path("example_protein.pdb",
154  model));
155  \endcode
156  This will ensure that the code works when \imp is installed or
157  used via the \c setup_environment.sh script.
158  */
159 #if !defined(SWIG)
160  IMPCOREEXPORT std::string get_example_path(std::string file_name);
161 #endif
162  /** @} */
163 
164 
165  }
166 } //namespace
167 
168 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
169 
170 #include <IMP/base/Showable.h>
171 #include <IMP/base/hash.h>
172 
173 namespace IMP { namespace core {
174 using ::IMP::base::Showable;
175 using ::IMP::base::operator<<;
176 using ::IMP::base::hash_value;
177 } } // namespace
178 namespace IMP { namespace core { namespace internal {
179 using ::IMP::base::Showable;
180 using ::IMP::base::operator<<;
181 using ::IMP::base::hash_value;
182 } } } // namespace
183 
184 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
185 
186 
188 
189 #endif /* IMPCORE_CONFIG_H */
190 
191 // Here so it is always parsed
192 
193 #ifdef IMPCORE_DEPRECATED_HEADER
194 #undef IMPCORE_DEPRECATED_HEADER
195 #undef IMPCORE_DEPRECATED_VALUE_DEF
196 #undef IMPCORE_DEPRECATED_VALUE_DECL
197 #undef IMPCORE_DEPRECATED_OBJECT_DEF
198 #undef IMPCORE_DEPRECATED_OBJECT_DECL
199 #undef IMPCORE_DEPRECATED_FUNCTION_DEF
200 #undef IMPCORE_DEPRECATED_FUNCTION_DECL
201 #undef IMPCORE_DEPRECATED_METHOD_DEF
202 #undef IMPCORE_DEPRECATED_METHOD_DECL
203 #undef IMPCORE_DEPRECATED_MACRO
204 #undef IMPCORE_SHOW_WARNINGS
205 #endif
206 
207 // the central modules we can update easily, so don't warn in them
208 #if defined( IMPCORE_COMPILATION) \
209  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
210  || defined( IMPCORE_ALL) || defined(IMP_DOXYGEN) \
211  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
212  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
213  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
214  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
215  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
216  || defined(IMPGSL_COMPILATION)
217 #define IMPCORE_SHOW_WARNINGS 0
218 #else
219 #define IMPCORE_SHOW_WARNINGS 1
220 #endif
221 
222 // suppress header warnings with all header, SWIG wrapper and in the module
223 #if IMPCORE_SHOW_WARNINGS
224 #define IMPCORE_DEPRECATED_HEADER(version, help_message) \
225  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
226 #define IMPCORE_DEPRECATED_VALUE_DECL(version) \
227  IMP_DEPRECATED_ATTRIBUTE
228 #define IMPCORE_DEPRECATED_OBJECT_DECL(version) \
229  IMP_DEPRECATED_ATTRIBUTE
230 #define IMPCORE_DEPRECATED_FUNCTION_DECL(version) \
231  IMP_DEPRECATED_ATTRIBUTE
232 #define IMPCORE_DEPRECATED_METHOD_DECL(version) \
233  IMP_DEPRECATED_ATTRIBUTE
234 
235 #else //IMPCORE_SHOW_WARNINGS
236 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
237 #define IMPCORE_DEPRECATED_HEADER(version, help_message) \
238 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
239 #define IMPCORE_DEPRECATED_VALUE_DECL(version)
240 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
241 #define IMPCORE_DEPRECATED_OBJECT_DECL(version)
242 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
243 #define IMPCORE_DEPRECATED_FUNCTION_DECL(version)
244 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
245 #define IMPCORE_DEPRECATED_METHOD_DECL(version)
246 
247 #endif // IMPCORE_SHOW_WARNINGS
248 
249 // only warn about it in the all inclusion to cut down on copies
250 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
251  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
252  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
253  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
254  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
255  || defined(IMPSCOREFUNCTOR_COMPILATION)
256 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
257 #define IMPCORE_DEPRECATED_MACRO(version, message)
258 
259 #else
260 #define IMPCORE_DEPRECATED_MACRO(version, message) \
261  IMP_DEPRECATED_MACRO(version, message)
262 #endif
263 
264 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
265 #define IMPCORE_DEPRECATED_VALUE_DEF(version, message) \
266  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
267 
268 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
269 #define IMPCORE_DEPRECATED_OBJECT_DEF(version, message) \
270  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
271 
272 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
273 #define IMPCORE_DEPRECATED_FUNCTION_DEF(version, message) \
274  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
275 
276 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
277 #define IMPCORE_DEPRECATED_METHOD_DEF(version, message) \
278  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
279 
280 
282 
283 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
284 IMP_COMPILER_ENABLE_WARNINGS
285 #define IMP_EXECUTABLE_WARNINGS
286 #endif
IO support.
IO support.
std::string get_data_path(std::string file_name)
Return the full path to installed data.
std::string get_example_path(std::string file_name)
Return the path to installed example data for this module.
Various compiler workarounds.