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