IMP logo
IMP Reference Guide  2.16.0
The Integrative Modeling Platform
container_config.h
1 // Autogenerated by ../../../../tmp/nightly-build-315/imp-2.16.0/tools/build/setup_module.py
2 // from ../../../../tmp/nightly-build-315/imp-2.16.0/tools/build/config_templates/header.h
3 // Do not edit - any changes will be lost!
4 
5 /*
6  * \file IMP/container/container_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, IMPCONTAINER_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  * IMPCONTAINEREXPORT 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::container namespace.
21  * This is simply achieved by wrapping things with the
22  * IMPCONTAINER_BEGIN_NAMESPACE and IMPCONTAINER_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-2021 IMP Inventors. All rights reserved.
27  *
28  */
29 
30 #ifndef IMPCONTAINER_CONFIG_H
31 #define IMPCONTAINER_CONFIG_H
32 
33 #include <IMP/kernel_config.h>
34 #include <string>
35 
36 #ifdef _MSC_VER
37 #define NOMINMAX
38 
39 #ifdef IMPCONTAINER_EXPORTS
40 #define IMPCONTAINEREXPORT __declspec(dllexport)
41 #else // EXPORTS
42 #define IMPCONTAINEREXPORT __declspec(dllimport)
43 #endif // EXPORTS
44 
45 #else // _MSC_VER
46 
47 #ifdef GCC_VISIBILITY
48 #define IMPCONTAINEREXPORT __attribute__((visibility("default")))
49 #else // GCC_VISIBILITY
50 #define IMPCONTAINEREXPORT
51 #endif // GCC_VISIBILITY
52 
53 #endif // _MSC_VER
54 
55 #if defined(_MSC_VER) && !defined(SWIG)
56 #ifdef IMPCONTAINER_EXPORTS
57 
58 #define IMPCONTAINER_EXPORT_TEMPLATE(name) \
59  template class __declspec(dllexport) name
60 
61 #else //EXPORTS
62 
63 #define IMPCONTAINER_EXPORT_TEMPLATE(name) \
64  template class __declspec(dllimport) name
65 
66 #endif // EXPORTS
67 
68 #else // MSC and SWIG
69 #define IMPCONTAINER_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
70 
71 #endif // MSC and SWIG
72 
73 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
74 
75 #define IMPCONTAINER_BEGIN_NAMESPACE \
76  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{ namespace container {
77 
78 #define IMPCONTAINER_END_NAMESPACE } } \
79 IMP_COMPILER_DISABLE_WARNINGS
80 
81 #define IMPCONTAINER_BEGIN_INTERNAL_NAMESPACE IMPCONTAINER_BEGIN_NAMESPACE \
82  namespace internal {
83 
84 #define IMPCONTAINER_END_INTERNAL_NAMESPACE } IMPCONTAINER_END_NAMESPACE
85 
86 #else // SWIG and DOXYGEN
87 #define IMPCONTAINER_BEGIN_NAMESPACE namespace IMP{ namespace container {
88 
89 #define IMPCONTAINER_END_NAMESPACE } }
90 
91 #define IMPCONTAINER_BEGIN_INTERNAL_NAMESPACE IMPCONTAINER_BEGIN_NAMESPACE\
92  namespace internal {
93 
94 #define IMPCONTAINER_END_INTERNAL_NAMESPACE } IMPCONTAINER_END_NAMESPACE
95 
96 #endif // SWIG AND DOXYGEN
97 
98 #define IMP_CONTAINER_USE_IMP_ALGEBRA
99 #define IMP_CONTAINER_HAS_IMP_ALGEBRA 1
100 #define IMP_CONTAINER_USE_IMP_CGAL
101 #define IMP_CONTAINER_HAS_IMP_CGAL 1
102 #define IMP_CONTAINER_USE_IMP_DISPLAY
103 #define IMP_CONTAINER_HAS_IMP_DISPLAY 1
104 #define IMP_CONTAINER_USE_IMP_KERNEL
105 #define IMP_CONTAINER_HAS_IMP_KERNEL 1
106 #define IMP_CONTAINER_USE_IMP_SCORE_FUNCTOR
107 #define IMP_CONTAINER_HAS_IMP_SCORE_FUNCTOR 1
108 #define IMP_CONTAINER_USE_BOOST_FILESYSTEM
109 #define IMP_CONTAINER_HAS_BOOST_FILESYSTEM 1
110 #define IMP_CONTAINER_USE_BOOST_PROGRAMOPTIONS
111 #define IMP_CONTAINER_HAS_BOOST_PROGRAMOPTIONS 1
112 #define IMP_CONTAINER_USE_BOOST_RANDOM
113 #define IMP_CONTAINER_HAS_BOOST_RANDOM 1
114 #define IMP_CONTAINER_USE_BOOST_SYSTEM
115 #define IMP_CONTAINER_HAS_BOOST_SYSTEM 1
116 #define IMP_CONTAINER_USE_CGAL
117 #define IMP_CONTAINER_HAS_CGAL 1
118 #define IMP_CONTAINER_USE_HDF5
119 #define IMP_CONTAINER_HAS_HDF5 1
120 #define IMP_CONTAINER_USE_NUMPY
121 #define IMP_CONTAINER_HAS_NUMPY 1
122 #define IMP_CONTAINER_USE_PYTHON_IHM
123 #define IMP_CONTAINER_HAS_PYTHON_IHM 1
124 #define IMP_CONTAINER_NO_GOOGLE_DENSE_HASH_MAP
125 #define IMP_CONTAINER_HAS_GOOGLE_DENSE_HASH_MAP 0
126 #define IMP_CONTAINER_NO_ROBIN_MAP
127 #define IMP_CONTAINER_HAS_ROBIN_MAP 0
128 
129 // functions are defined explicitly for SWIG
130 namespace IMP{ namespace container {
131 /** \name Standard module functions
132  All \imp modules have a set of standard functions to help get information
133  about the module and about files associated with the module.
134  @{
135  */
136 #if !defined(SWIG)
137  IMPCONTAINEREXPORT std::string get_module_version();
138 #endif
139 
140 #if !defined(SWIG)
141  // SWIG will whine about duplicate definitions of function
142  inline std::string get_module_name() { return "IMP::container"; }
143 #endif
144 
145  //! Return the full path to one of this module's data files
146  /** To read the data file "data_library" that was placed in the \c data
147  directory of this module, do something like
148  \code
149  std::ifstream in(IMP::container::get_data_path("data_library"));
150  \endcode
151  This will ensure that the code works both when IMP is installed or
152  if used via the \c setup_environment.sh script.
153 
154  \note Each module has its own data directory, so be sure to use
155  this function from the correct module.
156  */
157 #if !defined(SWIG)
158  IMPCONTAINEREXPORT std::string get_data_path(std::string file_name);
159 #endif
160 
161  //! Return the full path to one of this module's example files
162  /** To read the example file "example_protein.pdb" that was placed
163  in the \c examples directory of this module, do something like
164  \code
165  std::ifstream in(IMP::container::get_example_path("example_protein.pdb"));
166  \endcode
167  This will ensure that the code works both when IMP is installed or
168  if used via the \c setup_environment.sh script.
169 
170  \note Each module has its own example directory, so be sure to use
171  this function from the correct module.
172  */
173 #if !defined(SWIG)
174  IMPCONTAINEREXPORT std::string get_example_path(std::string file_name);
175 #endif
176  /** @} */
177 
178 
179 } } //namespace
180 
181 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
182 
183 #include <IMP/Showable.h>
184 #include <IMP/hash.h>
185 
186 namespace IMP{ namespace container {
187 using ::IMP::Showable;
188 using ::IMP::operator<<;
189 using ::IMP::hash_value;
190 } } // namespace
191 namespace IMP{ namespace container { namespace internal {
192 using ::IMP::Showable;
193 using ::IMP::operator<<;
194 using ::IMP::hash_value;
195 } } } // namespace
196 
197 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
198 
199 
200 #include <IMP/compiler_macros.h>
201 
202 #endif /* IMPCONTAINER_CONFIG_H */
203 
204 // Here so it is always parsed
205 
206 #ifdef IMPCONTAINER_DEPRECATED_HEADER
207 #undef IMPCONTAINER_DEPRECATED_HEADER
208 #undef IMPCONTAINER_DEPRECATED_VALUE_DEF
209 #undef IMPCONTAINER_DEPRECATED_VALUE_DECL
210 #undef IMPCONTAINER_DEPRECATED_OBJECT_DEF
211 #undef IMPCONTAINER_DEPRECATED_OBJECT_DECL
212 #undef IMPCONTAINER_DEPRECATED_FUNCTION_DEF
213 #undef IMPCONTAINER_DEPRECATED_FUNCTION_DECL
214 #undef IMPCONTAINER_DEPRECATED_METHOD_DEF
215 #undef IMPCONTAINER_DEPRECATED_METHOD_DECL
216 #undef IMPCONTAINER_DEPRECATED_MACRO
217 #undef IMPCONTAINER_SHOW_WARNINGS
218 #endif
219 
220 // the central modules we can update easily, so don't warn in them
221 #if defined( IMPCONTAINER_COMPILATION) \
222  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
223  || defined( IMPCONTAINER_ALL) || defined(IMP_DOXYGEN) \
224  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
225  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
226  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
227  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
228  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
229  || defined(IMPGSL_COMPILATION)
230 #define IMPCONTAINER_SHOW_WARNINGS 0
231 #else
232 #define IMPCONTAINER_SHOW_WARNINGS 1
233 #endif
234 
235 // suppress header warnings with all header, SWIG wrapper and in the module
236 #if IMPCONTAINER_SHOW_WARNINGS
237 #define IMPCONTAINER_DEPRECATED_HEADER(version, help_message) \
238  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
239 #define IMPCONTAINER_DEPRECATED_VALUE_DECL(version) \
240  IMP_DEPRECATED_ATTRIBUTE
241 #define IMPCONTAINER_DEPRECATED_OBJECT_DECL(version) \
242  IMP_DEPRECATED_ATTRIBUTE
243 #define IMPCONTAINER_DEPRECATED_FUNCTION_DECL(version) \
244  IMP_DEPRECATED_ATTRIBUTE
245 #define IMPCONTAINER_DEPRECATED_METHOD_DECL(version) \
246  IMP_DEPRECATED_ATTRIBUTE
247 
248 #else //IMPCONTAINER_SHOW_WARNINGS
249 /** See [deprecation support](@ref deprecation). */
250 #define IMPCONTAINER_DEPRECATED_HEADER(version, help_message) \
251 /** See [deprecation support](@ref deprecation). */
252 #define IMPCONTAINER_DEPRECATED_VALUE_DECL(version)
253 /** See [deprecation support](@ref deprecation). */
254 #define IMPCONTAINER_DEPRECATED_OBJECT_DECL(version)
255 /** See [deprecation support](@ref deprecation). */
256 #define IMPCONTAINER_DEPRECATED_FUNCTION_DECL(version)
257 /** See [deprecation support](@ref deprecation). */
258 #define IMPCONTAINER_DEPRECATED_METHOD_DECL(version)
259 
260 #endif // IMPCONTAINER_SHOW_WARNINGS
261 
262 // only warn about it in the all inclusion to cut down on copies
263 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
264  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
265  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
266  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
267  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
268  || defined(IMPSCOREFUNCTOR_COMPILATION)
269 /** See [deprecation support](@ref deprecation). */
270 #define IMPCONTAINER_DEPRECATED_MACRO(version, message)
271 
272 #else
273 #define IMPCONTAINER_DEPRECATED_MACRO(version, message) \
274  IMP_DEPRECATED_MACRO(version, message)
275 #endif
276 
277 /** See [deprecation support](@ref deprecation). */
278 #define IMPCONTAINER_DEPRECATED_VALUE_DEF(version, message) \
279  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
280 
281 /** See [deprecation support](@ref deprecation). */
282 #define IMPCONTAINER_DEPRECATED_OBJECT_DEF(version, message) \
283  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
284 
285 /** See [deprecation support](@ref deprecation). */
286 #define IMPCONTAINER_DEPRECATED_FUNCTION_DEF(version, message) \
287  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
288 
289 /** See [deprecation support](@ref deprecation). */
290 #define IMPCONTAINER_DEPRECATED_METHOD_DEF(version, message) \
291  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
292 
293 
294 #include <IMP/compiler_macros.h>
295 
296 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
297 IMP_COMPILER_ENABLE_WARNINGS
298 #define IMP_EXECUTABLE_WARNINGS
299 #endif
std::string get_module_version()
Return the version of this module, as a string.
Helper functions for implementing hashes.
Helper class to aid in output of IMP classes to streams.
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_data_path(std::string file_name)
Return the full path to one of this module's data files.