IMP logo
IMP Reference Guide  develop.b99932598c,2021/06/14
The Integrative Modeling Platform
algebra_config.h
1 // Autogenerated by ../../../../tmp/nightly-build-311/imp-20210614.develop.b99932598c/tools/build/setup_module.py
2 // from ../../../../tmp/nightly-build-311/imp-20210614.develop.b99932598c/tools/build/config_templates/header.h
3 // Do not edit - any changes will be lost!
4 
5 /*
6  * \file IMP/algebra/algebra_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, IMPALGEBRA_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  * IMPALGEBRAEXPORT 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::algebra namespace.
21  * This is simply achieved by wrapping things with the
22  * IMPALGEBRA_BEGIN_NAMESPACE and IMPALGEBRA_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 IMPALGEBRA_CONFIG_H
31 #define IMPALGEBRA_CONFIG_H
32 
33 #include <IMP/kernel_config.h>
34 #include <string>
35 
36 #ifdef _MSC_VER
37 #define NOMINMAX
38 
39 #ifdef IMPALGEBRA_EXPORTS
40 #define IMPALGEBRAEXPORT __declspec(dllexport)
41 #else // EXPORTS
42 #define IMPALGEBRAEXPORT __declspec(dllimport)
43 #endif // EXPORTS
44 
45 #else // _MSC_VER
46 
47 #ifdef GCC_VISIBILITY
48 #define IMPALGEBRAEXPORT __attribute__((visibility("default")))
49 #else // GCC_VISIBILITY
50 #define IMPALGEBRAEXPORT
51 #endif // GCC_VISIBILITY
52 
53 #endif // _MSC_VER
54 
55 #if defined(_MSC_VER) && !defined(SWIG)
56 #ifdef IMPALGEBRA_EXPORTS
57 
58 #define IMPALGEBRA_EXPORT_TEMPLATE(name) \
59  template class __declspec(dllexport) name
60 
61 #else //EXPORTS
62 
63 #define IMPALGEBRA_EXPORT_TEMPLATE(name) \
64  template class __declspec(dllimport) name
65 
66 #endif // EXPORTS
67 
68 #else // MSC and SWIG
69 #define IMPALGEBRA_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
70 
71 #endif // MSC and SWIG
72 
73 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
74 
75 #define IMPALGEBRA_BEGIN_NAMESPACE \
76  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{ namespace algebra {
77 
78 #define IMPALGEBRA_END_NAMESPACE } } \
79 IMP_COMPILER_DISABLE_WARNINGS
80 
81 #define IMPALGEBRA_BEGIN_INTERNAL_NAMESPACE IMPALGEBRA_BEGIN_NAMESPACE \
82  namespace internal {
83 
84 #define IMPALGEBRA_END_INTERNAL_NAMESPACE } IMPALGEBRA_END_NAMESPACE
85 
86 #else // SWIG and DOXYGEN
87 #define IMPALGEBRA_BEGIN_NAMESPACE namespace IMP{ namespace algebra {
88 
89 #define IMPALGEBRA_END_NAMESPACE } }
90 
91 #define IMPALGEBRA_BEGIN_INTERNAL_NAMESPACE IMPALGEBRA_BEGIN_NAMESPACE\
92  namespace internal {
93 
94 #define IMPALGEBRA_END_INTERNAL_NAMESPACE } IMPALGEBRA_END_NAMESPACE
95 
96 #endif // SWIG AND DOXYGEN
97 
98 #define IMP_ALGEBRA_USE_IMP_CGAL
99 #define IMP_ALGEBRA_HAS_IMP_CGAL 1
100 #define IMP_ALGEBRA_USE_BOOST_FILESYSTEM
101 #define IMP_ALGEBRA_HAS_BOOST_FILESYSTEM 1
102 #define IMP_ALGEBRA_USE_BOOST_PROGRAMOPTIONS
103 #define IMP_ALGEBRA_HAS_BOOST_PROGRAMOPTIONS 1
104 #define IMP_ALGEBRA_USE_BOOST_RANDOM
105 #define IMP_ALGEBRA_HAS_BOOST_RANDOM 1
106 #define IMP_ALGEBRA_USE_BOOST_SYSTEM
107 #define IMP_ALGEBRA_HAS_BOOST_SYSTEM 1
108 #define IMP_ALGEBRA_USE_CGAL
109 #define IMP_ALGEBRA_HAS_CGAL 1
110 #define IMP_ALGEBRA_USE_NUMPY
111 #define IMP_ALGEBRA_HAS_NUMPY 1
112 #define IMP_ALGEBRA_NO_ANN
113 #define IMP_ALGEBRA_HAS_ANN 0
114 
115 // functions are defined explicitly for SWIG
116 namespace IMP{ namespace algebra {
117 /** \name Standard module functions
118  All \imp modules have a set of standard functions to help get information
119  about the module and about files associated with the module.
120  @{
121  */
122 #if !defined(SWIG)
123  IMPALGEBRAEXPORT std::string get_module_version();
124 #endif
125 
126 #if !defined(SWIG)
127  // SWIG will whine about duplicate definitions of function
128  inline std::string get_module_name() { return "IMP::algebra"; }
129 #endif
130 
131  //! Return the full path to one of this module's data files
132  /** To read the data file "data_library" that was placed in the \c data
133  directory of this module, do something like
134  \code
135  std::ifstream in(IMP::algebra::get_data_path("data_library"));
136  \endcode
137  This will ensure that the code works both when IMP is installed or
138  if used via the \c setup_environment.sh script.
139 
140  \note Each module has its own data directory, so be sure to use
141  this function from the correct module.
142  */
143 #if !defined(SWIG)
144  IMPALGEBRAEXPORT std::string get_data_path(std::string file_name);
145 #endif
146 
147  //! Return the full path to one of this module's example files
148  /** To read the example file "example_protein.pdb" that was placed
149  in the \c examples directory of this module, do something like
150  \code
151  std::ifstream in(IMP::algebra::get_example_path("example_protein.pdb"));
152  \endcode
153  This will ensure that the code works both when IMP is installed or
154  if used via the \c setup_environment.sh script.
155 
156  \note Each module has its own example directory, so be sure to use
157  this function from the correct module.
158  */
159 #if !defined(SWIG)
160  IMPALGEBRAEXPORT std::string get_example_path(std::string file_name);
161 #endif
162  /** @} */
163 
164 
165 } } //namespace
166 
167 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
168 
169 #include <IMP/Showable.h>
170 #include <IMP/hash.h>
171 
172 namespace IMP{ namespace algebra {
173 using ::IMP::Showable;
174 using ::IMP::operator<<;
175 using ::IMP::hash_value;
176 } } // namespace
177 namespace IMP{ namespace algebra { namespace internal {
178 using ::IMP::Showable;
179 using ::IMP::operator<<;
180 using ::IMP::hash_value;
181 } } } // namespace
182 
183 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
184 
185 
186 #include <IMP/compiler_macros.h>
187 
188 #endif /* IMPALGEBRA_CONFIG_H */
189 
190 // Here so it is always parsed
191 
192 #ifdef IMPALGEBRA_DEPRECATED_HEADER
193 #undef IMPALGEBRA_DEPRECATED_HEADER
194 #undef IMPALGEBRA_DEPRECATED_VALUE_DEF
195 #undef IMPALGEBRA_DEPRECATED_VALUE_DECL
196 #undef IMPALGEBRA_DEPRECATED_OBJECT_DEF
197 #undef IMPALGEBRA_DEPRECATED_OBJECT_DECL
198 #undef IMPALGEBRA_DEPRECATED_FUNCTION_DEF
199 #undef IMPALGEBRA_DEPRECATED_FUNCTION_DECL
200 #undef IMPALGEBRA_DEPRECATED_METHOD_DEF
201 #undef IMPALGEBRA_DEPRECATED_METHOD_DECL
202 #undef IMPALGEBRA_DEPRECATED_MACRO
203 #undef IMPALGEBRA_SHOW_WARNINGS
204 #endif
205 
206 // the central modules we can update easily, so don't warn in them
207 #if defined( IMPALGEBRA_COMPILATION) \
208  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
209  || defined( IMPALGEBRA_ALL) || defined(IMP_DOXYGEN) \
210  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
211  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
212  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
213  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
214  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
215  || defined(IMPGSL_COMPILATION)
216 #define IMPALGEBRA_SHOW_WARNINGS 0
217 #else
218 #define IMPALGEBRA_SHOW_WARNINGS 1
219 #endif
220 
221 // suppress header warnings with all header, SWIG wrapper and in the module
222 #if IMPALGEBRA_SHOW_WARNINGS
223 #define IMPALGEBRA_DEPRECATED_HEADER(version, help_message) \
224  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
225 #define IMPALGEBRA_DEPRECATED_VALUE_DECL(version) \
226  IMP_DEPRECATED_ATTRIBUTE
227 #define IMPALGEBRA_DEPRECATED_OBJECT_DECL(version) \
228  IMP_DEPRECATED_ATTRIBUTE
229 #define IMPALGEBRA_DEPRECATED_FUNCTION_DECL(version) \
230  IMP_DEPRECATED_ATTRIBUTE
231 #define IMPALGEBRA_DEPRECATED_METHOD_DECL(version) \
232  IMP_DEPRECATED_ATTRIBUTE
233 
234 #else //IMPALGEBRA_SHOW_WARNINGS
235 /** See [deprecation support](@ref deprecation). */
236 #define IMPALGEBRA_DEPRECATED_HEADER(version, help_message) \
237 /** See [deprecation support](@ref deprecation). */
238 #define IMPALGEBRA_DEPRECATED_VALUE_DECL(version)
239 /** See [deprecation support](@ref deprecation). */
240 #define IMPALGEBRA_DEPRECATED_OBJECT_DECL(version)
241 /** See [deprecation support](@ref deprecation). */
242 #define IMPALGEBRA_DEPRECATED_FUNCTION_DECL(version)
243 /** See [deprecation support](@ref deprecation). */
244 #define IMPALGEBRA_DEPRECATED_METHOD_DECL(version)
245 
246 #endif // IMPALGEBRA_SHOW_WARNINGS
247 
248 // only warn about it in the all inclusion to cut down on copies
249 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
250  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
251  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
252  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
253  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
254  || defined(IMPSCOREFUNCTOR_COMPILATION)
255 /** See [deprecation support](@ref deprecation). */
256 #define IMPALGEBRA_DEPRECATED_MACRO(version, message)
257 
258 #else
259 #define IMPALGEBRA_DEPRECATED_MACRO(version, message) \
260  IMP_DEPRECATED_MACRO(version, message)
261 #endif
262 
263 /** See [deprecation support](@ref deprecation). */
264 #define IMPALGEBRA_DEPRECATED_VALUE_DEF(version, message) \
265  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
266 
267 /** See [deprecation support](@ref deprecation). */
268 #define IMPALGEBRA_DEPRECATED_OBJECT_DEF(version, message) \
269  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
270 
271 /** See [deprecation support](@ref deprecation). */
272 #define IMPALGEBRA_DEPRECATED_FUNCTION_DEF(version, message) \
273  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
274 
275 /** See [deprecation support](@ref deprecation). */
276 #define IMPALGEBRA_DEPRECATED_METHOD_DEF(version, message) \
277  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
278 
279 
280 #include <IMP/compiler_macros.h>
281 
282 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
283 IMP_COMPILER_ENABLE_WARNINGS
284 #define IMP_EXECUTABLE_WARNINGS
285 #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.
Helper functions for implementing hashes.
std::string get_module_version()
Return the version of this module, as a string.
Helper class to aid in output of IMP classes to streams.
Various compiler workarounds.