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