IMP logo
IMP Reference Guide  2.12.0
The Integrative Modeling Platform
core_config.h
1 // Autogenerated by ../../../../tmp/nightly-build-5371/imp-2.12.0/tools/build/setup_module.py
2 // from ../../../../tmp/nightly-build-5371/imp-2.12.0/tools/build/config_templates/header.h
3 // Do not edit - any changes will be lost!
4 
5 /*
6  * \file IMP/core/core_config.h
7  * \brief Provide macros to mark functions and classes as exported
8  * from a DLL/.so, and to set up namespaces
9  *
10  * When building the module, IMPCORE_EXPORTS should be defined, and when
11  * using the module externally, it should not be. Classes and functions
12  * declared in the module's headers should then be marked with
13  * IMPCOREEXPORT if they are intended to be part of the API and
14  * they are not defined entirely in a header.
15  *
16  * The Windows build environment requires applications to mark exports in
17  * this way; we use the same markings to set the visibility of ELF symbols
18  * if we have compiler support.
19  *
20  * All code in this module should live in the IMP::core namespace.
21  * This is simply achieved by wrapping things with the
22  * IMPCORE_BEGIN_NAMESPACE and IMPCORE_END_NAMESPACE macros.
23  * There are similar macros for module code that is designed to be for
24  * internal use only.
25  *
26  * Copyright 2007-2019 IMP Inventors. All rights reserved.
27  *
28  */
29 
30 #ifndef IMPCORE_CONFIG_H
31 #define IMPCORE_CONFIG_H
32 
33 #include <IMP/kernel_config.h>
34 #include <string>
35 
36 #ifdef _MSC_VER
37 #define NOMINMAX
38 
39 #ifdef IMPCORE_EXPORTS
40 #define IMPCOREEXPORT __declspec(dllexport)
41 #else // EXPORTS
42 #define IMPCOREEXPORT __declspec(dllimport)
43 #endif // EXPORTS
44 
45 #else // _MSC_VER
46 
47 #ifdef GCC_VISIBILITY
48 #define IMPCOREEXPORT __attribute__((visibility("default")))
49 #else // GCC_VISIBILITY
50 #define IMPCOREEXPORT
51 #endif // GCC_VISIBILITY
52 
53 #endif // _MSC_VER
54 
55 #if defined(_MSC_VER) && !defined(SWIG)
56 #ifdef IMPCORE_EXPORTS
57 
58 #define IMPCORE_EXPORT_TEMPLATE(name) \
59  template class __declspec(dllexport) name
60 
61 #else //EXPORTS
62 
63 #define IMPCORE_EXPORT_TEMPLATE(name) \
64  template class __declspec(dllimport) name
65 
66 #endif // EXPORTS
67 
68 #else // MSC and SWIG
69 #define IMPCORE_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
70 
71 #endif // MSC and SWIG
72 
73 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
74 
75 #define IMPCORE_BEGIN_NAMESPACE \
76  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{ namespace core {
77 
78 #define IMPCORE_END_NAMESPACE } } \
79 IMP_COMPILER_DISABLE_WARNINGS
80 
81 #define IMPCORE_BEGIN_INTERNAL_NAMESPACE IMPCORE_BEGIN_NAMESPACE \
82  namespace internal {
83 
84 #define IMPCORE_END_INTERNAL_NAMESPACE } IMPCORE_END_NAMESPACE
85 
86 #else // SWIG and DOXYGEN
87 #define IMPCORE_BEGIN_NAMESPACE namespace IMP{ namespace core {
88 
89 #define IMPCORE_END_NAMESPACE } }
90 
91 #define IMPCORE_BEGIN_INTERNAL_NAMESPACE IMPCORE_BEGIN_NAMESPACE\
92  namespace internal {
93 
94 #define IMPCORE_END_INTERNAL_NAMESPACE } IMPCORE_END_NAMESPACE
95 
96 #endif // SWIG AND DOXYGEN
97 
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 #define IMP_CORE_USE_NUMPY
115 #define IMP_CORE_HAS_NUMPY 1
116 
117 // functions are defined explicitly for SWIG
118 namespace IMP{ namespace core {
119 /** \name Standard module functions
120  All \imp modules have a set of standard functions to help get information
121  about the module and about files associated with the module.
122  @{
123  */
124 #if !defined(SWIG)
125  IMPCOREEXPORT std::string get_module_version();
126 #endif
127 
128 #if !defined(SWIG)
129  // SWIG will whine about duplicate definitions of function
130  inline std::string get_module_name() { return "IMP::core"; }
131 #endif
132 
133  //! Return the full path to one of this module's data files
134  /** To read the data file "data_library" that was placed in the \c data
135  directory of this module, do something like
136  \code
137  std::ifstream in(IMP::core::get_data_path("data_library"));
138  \endcode
139  This will ensure that the code works both when IMP is installed or
140  if used via the \c setup_environment.sh script.
141 
142  \note Each module has its own data directory, so be sure to use
143  this function from the correct module.
144  */
145 #if !defined(SWIG)
146  IMPCOREEXPORT std::string get_data_path(std::string file_name);
147 #endif
148 
149  //! Return the full path to one of this module's example files
150  /** To read the example file "example_protein.pdb" that was placed
151  in the \c examples directory of this module, do something like
152  \code
153  std::ifstream in(IMP::core::get_example_path("example_protein.pdb"));
154  \endcode
155  This will ensure that the code works both when IMP is installed or
156  if used via the \c setup_environment.sh script.
157 
158  \note Each module has its own example directory, so be sure to use
159  this function from the correct module.
160  */
161 #if !defined(SWIG)
162  IMPCOREEXPORT std::string get_example_path(std::string file_name);
163 #endif
164  /** @} */
165 
166 
167 } } //namespace
168 
169 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
170 
171 #include <IMP/Showable.h>
172 #include <IMP/hash.h>
173 
174 namespace IMP{ namespace core {
175 using ::IMP::Showable;
176 using ::IMP::operator<<;
177 using ::IMP::hash_value;
178 } } // namespace
179 namespace IMP{ namespace core { namespace internal {
180 using ::IMP::Showable;
181 using ::IMP::operator<<;
182 using ::IMP::hash_value;
183 } } } // namespace
184 
185 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
186 
187 
188 #include <IMP/compiler_macros.h>
189 
190 #endif /* IMPCORE_CONFIG_H */
191 
192 // Here so it is always parsed
193 
194 #ifdef IMPCORE_DEPRECATED_HEADER
195 #undef IMPCORE_DEPRECATED_HEADER
196 #undef IMPCORE_DEPRECATED_VALUE_DEF
197 #undef IMPCORE_DEPRECATED_VALUE_DECL
198 #undef IMPCORE_DEPRECATED_OBJECT_DEF
199 #undef IMPCORE_DEPRECATED_OBJECT_DECL
200 #undef IMPCORE_DEPRECATED_FUNCTION_DEF
201 #undef IMPCORE_DEPRECATED_FUNCTION_DECL
202 #undef IMPCORE_DEPRECATED_METHOD_DEF
203 #undef IMPCORE_DEPRECATED_METHOD_DECL
204 #undef IMPCORE_DEPRECATED_MACRO
205 #undef IMPCORE_SHOW_WARNINGS
206 #endif
207 
208 // the central modules we can update easily, so don't warn in them
209 #if defined( IMPCORE_COMPILATION) \
210  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
211  || defined( IMPCORE_ALL) || defined(IMP_DOXYGEN) \
212  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
213  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
214  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
215  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
216  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
217  || defined(IMPGSL_COMPILATION)
218 #define IMPCORE_SHOW_WARNINGS 0
219 #else
220 #define IMPCORE_SHOW_WARNINGS 1
221 #endif
222 
223 // suppress header warnings with all header, SWIG wrapper and in the module
224 #if IMPCORE_SHOW_WARNINGS
225 #define IMPCORE_DEPRECATED_HEADER(version, help_message) \
226  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
227 #define IMPCORE_DEPRECATED_VALUE_DECL(version) \
228  IMP_DEPRECATED_ATTRIBUTE
229 #define IMPCORE_DEPRECATED_OBJECT_DECL(version) \
230  IMP_DEPRECATED_ATTRIBUTE
231 #define IMPCORE_DEPRECATED_FUNCTION_DECL(version) \
232  IMP_DEPRECATED_ATTRIBUTE
233 #define IMPCORE_DEPRECATED_METHOD_DECL(version) \
234  IMP_DEPRECATED_ATTRIBUTE
235 
236 #else //IMPCORE_SHOW_WARNINGS
237 /** See [deprecation support](@ref deprecation). */
238 #define IMPCORE_DEPRECATED_HEADER(version, help_message) \
239 /** See [deprecation support](@ref deprecation). */
240 #define IMPCORE_DEPRECATED_VALUE_DECL(version)
241 /** See [deprecation support](@ref deprecation). */
242 #define IMPCORE_DEPRECATED_OBJECT_DECL(version)
243 /** See [deprecation support](@ref deprecation). */
244 #define IMPCORE_DEPRECATED_FUNCTION_DECL(version)
245 /** See [deprecation support](@ref deprecation). */
246 #define IMPCORE_DEPRECATED_METHOD_DECL(version)
247 
248 #endif // IMPCORE_SHOW_WARNINGS
249 
250 // only warn about it in the all inclusion to cut down on copies
251 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
252  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
253  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
254  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
255  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
256  || defined(IMPSCOREFUNCTOR_COMPILATION)
257 /** See [deprecation support](@ref deprecation). */
258 #define IMPCORE_DEPRECATED_MACRO(version, message)
259 
260 #else
261 #define IMPCORE_DEPRECATED_MACRO(version, message) \
262  IMP_DEPRECATED_MACRO(version, message)
263 #endif
264 
265 /** See [deprecation support](@ref deprecation). */
266 #define IMPCORE_DEPRECATED_VALUE_DEF(version, message) \
267  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
268 
269 /** See [deprecation support](@ref deprecation). */
270 #define IMPCORE_DEPRECATED_OBJECT_DEF(version, message) \
271  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
272 
273 /** See [deprecation support](@ref deprecation). */
274 #define IMPCORE_DEPRECATED_FUNCTION_DEF(version, message) \
275  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
276 
277 /** See [deprecation support](@ref deprecation). */
278 #define IMPCORE_DEPRECATED_METHOD_DEF(version, message) \
279  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
280 
281 
282 #include <IMP/compiler_macros.h>
283 
284 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
285 IMP_COMPILER_ENABLE_WARNINGS
286 #define IMP_EXECUTABLE_WARNINGS
287 #endif
IO support.
IO support.
std::string get_data_path(std::string file_name)
Return the full path to one of this module's data files.
std::string get_example_path(std::string file_name)
Return the full path to one of this module's example files.
Various compiler workarounds.