IMP logo
IMP Reference Guide  2.20.0
The Integrative Modeling Platform
kernel_config.h
1 // Autogenerated by ../../../../tmp/nightly-build-18515/imp-2.20.0/tools/build/setup_module.py
2 // from ../../../../tmp/nightly-build-18515/imp-2.20.0/tools/build/config_templates/header.h
3 // Do not edit - any changes will be lost!
4 
5 /*
6  * \file IMP/kernel_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, IMPKERNEL_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  * IMPKERNELEXPORT 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 namespace.
21  * This is simply achieved by wrapping things with the
22  * IMPKERNEL_BEGIN_NAMESPACE and IMPKERNEL_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-2022 IMP Inventors. All rights reserved.
27  *
28  */
29 
30 #ifndef IMPKERNEL_CONFIG_H
31 #define IMPKERNEL_CONFIG_H
32 
33 #include <IMP/kernel_config.h>
34 #include <string>
35 
36 #ifdef _MSC_VER
37 #define NOMINMAX
38 
39 #ifdef IMPKERNEL_EXPORTS
40 #define IMPKERNELEXPORT __declspec(dllexport)
41 #else // EXPORTS
42 #define IMPKERNELEXPORT __declspec(dllimport)
43 #endif // EXPORTS
44 
45 #else // _MSC_VER
46 
47 #ifdef GCC_VISIBILITY
48 #define IMPKERNELEXPORT __attribute__((visibility("default")))
49 #else // GCC_VISIBILITY
50 #define IMPKERNELEXPORT
51 #endif // GCC_VISIBILITY
52 
53 #endif // _MSC_VER
54 
55 #if defined(_MSC_VER) && !defined(SWIG)
56 #ifdef IMPKERNEL_EXPORTS
57 
58 #define IMPKERNEL_EXPORT_TEMPLATE(name) \
59  template class __declspec(dllexport) name
60 
61 #else //EXPORTS
62 
63 #define IMPKERNEL_EXPORT_TEMPLATE(name) \
64  template class __declspec(dllimport) name
65 
66 #endif // EXPORTS
67 
68 #else // MSC and SWIG
69 #define IMPKERNEL_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
70 
71 #endif // MSC and SWIG
72 
73 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
74 
75 #define IMPKERNEL_BEGIN_NAMESPACE \
76  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{
77 
78 #define IMPKERNEL_END_NAMESPACE } \
79 IMP_COMPILER_DISABLE_WARNINGS
80 
81 #define IMPKERNEL_BEGIN_INTERNAL_NAMESPACE IMPKERNEL_BEGIN_NAMESPACE \
82  namespace internal {
83 
84 #define IMPKERNEL_END_INTERNAL_NAMESPACE } IMPKERNEL_END_NAMESPACE
85 
86 #else // SWIG and DOXYGEN
87 #define IMPKERNEL_BEGIN_NAMESPACE namespace IMP{
88 
89 #define IMPKERNEL_END_NAMESPACE }
90 
91 #define IMPKERNEL_BEGIN_INTERNAL_NAMESPACE IMPKERNEL_BEGIN_NAMESPACE\
92  namespace internal {
93 
94 #define IMPKERNEL_END_INTERNAL_NAMESPACE } IMPKERNEL_END_NAMESPACE
95 
96 #endif // SWIG AND DOXYGEN
97 
98 #define IMP_BUILD IMP_RELEASE
99 #define IMP_HAS_LOG IMP_VERBOSE
100 #define IMP_HAS_CHECKS IMP_INTERNAL
101 #define IMP_DEBUG 0
102 #define IMP_RELEASE 1
103 #define IMP_SILENT 0
104 #define IMP_PROGRESS 2
105 #define IMP_TERSE 3
106 #define IMP_VERBOSE 4
107 #define IMP_MEMORY 5
108 #define IMP_NONE 0
109 #define IMP_USAGE 1
110 #define IMP_INTERNAL 2
111 #define IMP_KERNEL_HAS_LOG4CXX 0
112 #define IMP_COMPILER_HAS_CEREAL_RAW_POINTER 0
113 #define IMP_COMPILER_HAS_DEBUG_VECTOR 0
114 #define IMP_COMPILER_HAS_RANDOM_SHUFFLE 0
115 #define IMP_COMPILER_HAS_THREE_WAY 0
116 #define IMP_KERNEL_USE_BOOST_RANDOM
117 #define IMP_KERNEL_HAS_BOOST_RANDOM 1
118 #define IMP_KERNEL_USE_NUMPY
119 #define IMP_KERNEL_HAS_NUMPY 1
120 #define IMP_KERNEL_NO_GPERFTOOLS
121 #define IMP_KERNEL_HAS_GPERFTOOLS 0
122 #define IMP_KERNEL_NO_TCMALLOC_HEAPCHECKER
123 #define IMP_KERNEL_HAS_TCMALLOC_HEAPCHECKER 0
124 #define IMP_KERNEL_NO_TCMALLOC_HEAPPROFILER
125 #define IMP_KERNEL_HAS_TCMALLOC_HEAPPROFILER 0
126 
127 // functions are defined explicitly for SWIG
128 namespace IMP{
129 /** \name Standard module functions
130  All \imp modules have a set of standard functions to help get information
131  about the module and about files associated with the module.
132  @{
133  */
134 #if !defined(SWIG)
135  IMPKERNELEXPORT std::string get_module_version();
136 #endif
137 
138 #if !defined(SWIG)
139  // SWIG will whine about duplicate definitions of function
140  inline std::string get_module_name() { return "IMP"; }
141 #endif
142 
143  //! Return the full path to one of this module's data files
144  /** To read the data file "data_library" that was placed in the \c data
145  directory of this module, do something like
146  \code
147  std::ifstream in(IMP::get_data_path("data_library"));
148  \endcode
149  This will ensure that the code works both when IMP is installed or
150  if used via the \c setup_environment.sh script.
151 
152  \note Each module has its own data directory, so be sure to use
153  this function from the correct module.
154  */
155 #if !defined(SWIG)
156  IMPKERNELEXPORT std::string get_data_path(std::string file_name);
157 #endif
158 
159  //! Return the full path to one of this module's example files
160  /** To read the example file "example_protein.pdb" that was placed
161  in the \c examples directory of this module, do something like
162  \code
163  std::ifstream in(IMP::get_example_path("example_protein.pdb"));
164  \endcode
165  This will ensure that the code works both when IMP is installed or
166  if used via the \c setup_environment.sh script.
167 
168  \note Each module has its own example directory, so be sure to use
169  this function from the correct module.
170  */
171 #if !defined(SWIG)
172  IMPKERNELEXPORT std::string get_example_path(std::string file_name);
173 #endif
174  /** @} */
175 
176 
177 } //namespace
178 
179 
180 
181 #include <IMP/compiler_macros.h>
182 
183 #endif /* IMPKERNEL_CONFIG_H */
184 
185 // Here so it is always parsed
186 
187 #ifdef IMPKERNEL_DEPRECATED_HEADER
188 #undef IMPKERNEL_DEPRECATED_HEADER
189 #undef IMPKERNEL_DEPRECATED_VALUE_DEF
190 #undef IMPKERNEL_DEPRECATED_VALUE_DECL
191 #undef IMPKERNEL_DEPRECATED_OBJECT_DEF
192 #undef IMPKERNEL_DEPRECATED_OBJECT_DECL
193 #undef IMPKERNEL_DEPRECATED_FUNCTION_DEF
194 #undef IMPKERNEL_DEPRECATED_FUNCTION_DECL
195 #undef IMPKERNEL_DEPRECATED_METHOD_DEF
196 #undef IMPKERNEL_DEPRECATED_METHOD_DECL
197 #undef IMPKERNEL_DEPRECATED_MACRO
198 #undef IMPKERNEL_SHOW_WARNINGS
199 #endif
200 
201 // the central modules we can update easily, so don't warn in them
202 #if defined( IMPKERNEL_COMPILATION) \
203  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
204  || defined( IMPKERNEL_ALL) || defined(IMP_DOXYGEN) \
205  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
206  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
207  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
208  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
209  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
210  || defined(IMPGSL_COMPILATION)
211 #define IMPKERNEL_SHOW_WARNINGS 0
212 #else
213 #define IMPKERNEL_SHOW_WARNINGS 1
214 #endif
215 
216 // suppress header warnings with all header, SWIG wrapper and in the module
217 #if IMPKERNEL_SHOW_WARNINGS
218 #define IMPKERNEL_DEPRECATED_HEADER(version, help_message) \
219  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
220 #define IMPKERNEL_DEPRECATED_VALUE_DECL(version) \
221  IMP_DEPRECATED_ATTRIBUTE
222 #define IMPKERNEL_DEPRECATED_OBJECT_DECL(version) \
223  IMP_DEPRECATED_ATTRIBUTE
224 #define IMPKERNEL_DEPRECATED_FUNCTION_DECL(version) \
225  IMP_DEPRECATED_ATTRIBUTE
226 #define IMPKERNEL_DEPRECATED_METHOD_DECL(version) \
227  IMP_DEPRECATED_ATTRIBUTE
228 
229 #else //IMPKERNEL_SHOW_WARNINGS
230 /** See [deprecation support](@ref deprecation). */
231 #define IMPKERNEL_DEPRECATED_HEADER(version, help_message) \
232 /** See [deprecation support](@ref deprecation). */
233 #define IMPKERNEL_DEPRECATED_VALUE_DECL(version)
234 /** See [deprecation support](@ref deprecation). */
235 #define IMPKERNEL_DEPRECATED_OBJECT_DECL(version)
236 /** See [deprecation support](@ref deprecation). */
237 #define IMPKERNEL_DEPRECATED_FUNCTION_DECL(version)
238 /** See [deprecation support](@ref deprecation). */
239 #define IMPKERNEL_DEPRECATED_METHOD_DECL(version)
240 
241 #endif // IMPKERNEL_SHOW_WARNINGS
242 
243 // only warn about it in the all inclusion to cut down on copies
244 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
245  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
246  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
247  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
248  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
249  || defined(IMPSCOREFUNCTOR_COMPILATION)
250 /** See [deprecation support](@ref deprecation). */
251 #define IMPKERNEL_DEPRECATED_MACRO(version, message)
252 
253 #else
254 #define IMPKERNEL_DEPRECATED_MACRO(version, message) \
255  IMP_DEPRECATED_MACRO(version, message)
256 #endif
257 
258 /** See [deprecation support](@ref deprecation). */
259 #define IMPKERNEL_DEPRECATED_VALUE_DEF(version, message) \
260  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
261 
262 /** See [deprecation support](@ref deprecation). */
263 #define IMPKERNEL_DEPRECATED_OBJECT_DEF(version, message) \
264  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
265 
266 /** See [deprecation support](@ref deprecation). */
267 #define IMPKERNEL_DEPRECATED_FUNCTION_DEF(version, message) \
268  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
269 
270 /** See [deprecation support](@ref deprecation). */
271 #define IMPKERNEL_DEPRECATED_METHOD_DEF(version, message) \
272  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
273 
274 
275 #include <IMP/compiler_macros.h>
276 
277 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
278 IMP_COMPILER_ENABLE_WARNINGS
279 #define IMP_EXECUTABLE_WARNINGS
280 #endif
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.
std::string get_module_version()
Return the version of this module, as a string.