IMP logo
IMP Reference Guide  2.18.0
The Integrative Modeling Platform
kernel_config.h
1 // Autogenerated by ../../../../tmp/nightly-build-407/imp-2.18.0/tools/build/setup_module.py
2 // from ../../../../tmp/nightly-build-407/imp-2.18.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_DEBUG_VECTOR 0
113 #define IMP_COMPILER_HAS_RANDOM_SHUFFLE 1
114 #define IMP_COMPILER_HAS_THREE_WAY 0
115 #define IMP_KERNEL_USE_BOOST_RANDOM
116 #define IMP_KERNEL_HAS_BOOST_RANDOM 1
117 #define IMP_KERNEL_USE_NUMPY
118 #define IMP_KERNEL_HAS_NUMPY 1
119 #define IMP_KERNEL_NO_GPERFTOOLS
120 #define IMP_KERNEL_HAS_GPERFTOOLS 0
121 #define IMP_KERNEL_NO_TCMALLOC_HEAPCHECKER
122 #define IMP_KERNEL_HAS_TCMALLOC_HEAPCHECKER 0
123 #define IMP_KERNEL_NO_TCMALLOC_HEAPPROFILER
124 #define IMP_KERNEL_HAS_TCMALLOC_HEAPPROFILER 0
125 
126 // functions are defined explicitly for SWIG
127 namespace IMP{
128 /** \name Standard module functions
129  All \imp modules have a set of standard functions to help get information
130  about the module and about files associated with the module.
131  @{
132  */
133 #if !defined(SWIG)
134  IMPKERNELEXPORT 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"; }
140 #endif
141 
142  //! Return the full path to one of this module's data files
143  /** To read the data file "data_library" that was placed in the \c data
144  directory of this module, do something like
145  \code
146  std::ifstream in(IMP::get_data_path("data_library"));
147  \endcode
148  This will ensure that the code works both when IMP is installed or
149  if used via the \c setup_environment.sh script.
150 
151  \note Each module has its own data directory, so be sure to use
152  this function from the correct module.
153  */
154 #if !defined(SWIG)
155  IMPKERNELEXPORT std::string get_data_path(std::string file_name);
156 #endif
157 
158  //! Return the full path to one of this module's example files
159  /** To read the example file "example_protein.pdb" that was placed
160  in the \c examples directory of this module, do something like
161  \code
162  std::ifstream in(IMP::get_example_path("example_protein.pdb"));
163  \endcode
164  This will ensure that the code works both when IMP is installed or
165  if used via the \c setup_environment.sh script.
166 
167  \note Each module has its own example directory, so be sure to use
168  this function from the correct module.
169  */
170 #if !defined(SWIG)
171  IMPKERNELEXPORT std::string get_example_path(std::string file_name);
172 #endif
173  /** @} */
174 
175 
176 } //namespace
177 
178 
179 
180 #include <IMP/compiler_macros.h>
181 
182 #endif /* IMPKERNEL_CONFIG_H */
183 
184 // Here so it is always parsed
185 
186 #ifdef IMPKERNEL_DEPRECATED_HEADER
187 #undef IMPKERNEL_DEPRECATED_HEADER
188 #undef IMPKERNEL_DEPRECATED_VALUE_DEF
189 #undef IMPKERNEL_DEPRECATED_VALUE_DECL
190 #undef IMPKERNEL_DEPRECATED_OBJECT_DEF
191 #undef IMPKERNEL_DEPRECATED_OBJECT_DECL
192 #undef IMPKERNEL_DEPRECATED_FUNCTION_DEF
193 #undef IMPKERNEL_DEPRECATED_FUNCTION_DECL
194 #undef IMPKERNEL_DEPRECATED_METHOD_DEF
195 #undef IMPKERNEL_DEPRECATED_METHOD_DECL
196 #undef IMPKERNEL_DEPRECATED_MACRO
197 #undef IMPKERNEL_SHOW_WARNINGS
198 #endif
199 
200 // the central modules we can update easily, so don't warn in them
201 #if defined( IMPKERNEL_COMPILATION) \
202  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
203  || defined( IMPKERNEL_ALL) || defined(IMP_DOXYGEN) \
204  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
205  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
206  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
207  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
208  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
209  || defined(IMPGSL_COMPILATION)
210 #define IMPKERNEL_SHOW_WARNINGS 0
211 #else
212 #define IMPKERNEL_SHOW_WARNINGS 1
213 #endif
214 
215 // suppress header warnings with all header, SWIG wrapper and in the module
216 #if IMPKERNEL_SHOW_WARNINGS
217 #define IMPKERNEL_DEPRECATED_HEADER(version, help_message) \
218  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
219 #define IMPKERNEL_DEPRECATED_VALUE_DECL(version) \
220  IMP_DEPRECATED_ATTRIBUTE
221 #define IMPKERNEL_DEPRECATED_OBJECT_DECL(version) \
222  IMP_DEPRECATED_ATTRIBUTE
223 #define IMPKERNEL_DEPRECATED_FUNCTION_DECL(version) \
224  IMP_DEPRECATED_ATTRIBUTE
225 #define IMPKERNEL_DEPRECATED_METHOD_DECL(version) \
226  IMP_DEPRECATED_ATTRIBUTE
227 
228 #else //IMPKERNEL_SHOW_WARNINGS
229 /** See [deprecation support](@ref deprecation). */
230 #define IMPKERNEL_DEPRECATED_HEADER(version, help_message) \
231 /** See [deprecation support](@ref deprecation). */
232 #define IMPKERNEL_DEPRECATED_VALUE_DECL(version)
233 /** See [deprecation support](@ref deprecation). */
234 #define IMPKERNEL_DEPRECATED_OBJECT_DECL(version)
235 /** See [deprecation support](@ref deprecation). */
236 #define IMPKERNEL_DEPRECATED_FUNCTION_DECL(version)
237 /** See [deprecation support](@ref deprecation). */
238 #define IMPKERNEL_DEPRECATED_METHOD_DECL(version)
239 
240 #endif // IMPKERNEL_SHOW_WARNINGS
241 
242 // only warn about it in the all inclusion to cut down on copies
243 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
244  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
245  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
246  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
247  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
248  || defined(IMPSCOREFUNCTOR_COMPILATION)
249 /** See [deprecation support](@ref deprecation). */
250 #define IMPKERNEL_DEPRECATED_MACRO(version, message)
251 
252 #else
253 #define IMPKERNEL_DEPRECATED_MACRO(version, message) \
254  IMP_DEPRECATED_MACRO(version, message)
255 #endif
256 
257 /** See [deprecation support](@ref deprecation). */
258 #define IMPKERNEL_DEPRECATED_VALUE_DEF(version, message) \
259  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
260 
261 /** See [deprecation support](@ref deprecation). */
262 #define IMPKERNEL_DEPRECATED_OBJECT_DEF(version, message) \
263  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
264 
265 /** See [deprecation support](@ref deprecation). */
266 #define IMPKERNEL_DEPRECATED_FUNCTION_DEF(version, message) \
267  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
268 
269 /** See [deprecation support](@ref deprecation). */
270 #define IMPKERNEL_DEPRECATED_METHOD_DEF(version, message) \
271  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
272 
273 
274 #include <IMP/compiler_macros.h>
275 
276 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
277 IMP_COMPILER_ENABLE_WARNINGS
278 #define IMP_EXECUTABLE_WARNINGS
279 #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.