IMP logo
IMP Reference Guide  2.7.0
The Integrative Modeling Platform
scratch_config.h
1 // Autogenerated by ../../../../tmp/nightly-build-65341/imp-2.7.0/tools/build/setup_module.py
2 // from ../../../../tmp/nightly-build-65341/imp-2.7.0/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-2017 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 
121 // functions are defined explicitly for SWIG
122 namespace IMP{ namespace scratch {
123 /** \name Standard module functions
124  All \imp modules have a set of standard functions to help get information
125  about the module and about files associated with the module.
126  @{
127  */
128 #if !defined(SWIG)
129  IMPSCRATCHEXPORT std::string get_module_version();
130 #endif
131 
132 #if !defined(SWIG)
133  // SWIG will whine about duplicate definitions of function
134  inline std::string get_module_name() { return "IMP::scratch"; }
135 #endif
136 
137  //! Return the full path to one of this module's data files
138  /** To read the data file "data_library" that was placed in the \c data
139  directory of this module, do something like
140  \code
141  std::ifstream in(IMP::scratch::get_data_path("data_library"));
142  \endcode
143  This will ensure that the code works both when IMP is installed or
144  if used via the \c setup_environment.sh script.
145 
146  \note Each module has its own data directory, so be sure to use
147  this function from the correct module.
148  */
149 #if !defined(SWIG)
150  IMPSCRATCHEXPORT std::string get_data_path(std::string file_name);
151 #endif
152 
153  //! Return the full path to one of this module's example files
154  /** To read the example file "example_protein.pdb" that was placed
155  in the \c examples directory of this module, do something like
156  \code
157  std::ifstream in(IMP::scratch::get_example_path("example_protein.pdb"));
158  \endcode
159  This will ensure that the code works both when IMP is installed or
160  if used via the \c setup_environment.sh script.
161 
162  \note Each module has its own example directory, so be sure to use
163  this function from the correct module.
164  */
165 #if !defined(SWIG)
166  IMPSCRATCHEXPORT std::string get_example_path(std::string file_name);
167 #endif
168  /** @} */
169 
170 
171 } } //namespace
172 
173 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
174 
175 #include <IMP/Showable.h>
176 #include <IMP/hash.h>
177 
178 namespace IMP{ namespace scratch {
179 using ::IMP::Showable;
180 using ::IMP::operator<<;
181 using ::IMP::hash_value;
182 } } // namespace
183 namespace IMP{ namespace scratch { namespace internal {
184 using ::IMP::Showable;
185 using ::IMP::operator<<;
186 using ::IMP::hash_value;
187 } } } // namespace
188 
189 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
190 
191 
192 #include <IMP/compiler_macros.h>
193 
194 #endif /* IMPSCRATCH_CONFIG_H */
195 
196 // Here so it is always parsed
197 
198 #ifdef IMPSCRATCH_DEPRECATED_HEADER
199 #undef IMPSCRATCH_DEPRECATED_HEADER
200 #undef IMPSCRATCH_DEPRECATED_VALUE_DEF
201 #undef IMPSCRATCH_DEPRECATED_VALUE_DECL
202 #undef IMPSCRATCH_DEPRECATED_OBJECT_DEF
203 #undef IMPSCRATCH_DEPRECATED_OBJECT_DECL
204 #undef IMPSCRATCH_DEPRECATED_FUNCTION_DEF
205 #undef IMPSCRATCH_DEPRECATED_FUNCTION_DECL
206 #undef IMPSCRATCH_DEPRECATED_METHOD_DEF
207 #undef IMPSCRATCH_DEPRECATED_METHOD_DECL
208 #undef IMPSCRATCH_DEPRECATED_MACRO
209 #undef IMPSCRATCH_SHOW_WARNINGS
210 #endif
211 
212 // the central modules we can update easily, so don't warn in them
213 #if defined( IMPSCRATCH_COMPILATION) \
214  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
215  || defined( IMPSCRATCH_ALL) || defined(IMP_DOXYGEN) \
216  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
217  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
218  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
219  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
220  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
221  || defined(IMPGSL_COMPILATION)
222 #define IMPSCRATCH_SHOW_WARNINGS 0
223 #else
224 #define IMPSCRATCH_SHOW_WARNINGS 1
225 #endif
226 
227 // suppress header warnings with all header, SWIG wrapper and in the module
228 #if IMPSCRATCH_SHOW_WARNINGS
229 #define IMPSCRATCH_DEPRECATED_HEADER(version, help_message) \
230  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
231 #define IMPSCRATCH_DEPRECATED_VALUE_DECL(version) \
232  IMP_DEPRECATED_ATTRIBUTE
233 #define IMPSCRATCH_DEPRECATED_OBJECT_DECL(version) \
234  IMP_DEPRECATED_ATTRIBUTE
235 #define IMPSCRATCH_DEPRECATED_FUNCTION_DECL(version) \
236  IMP_DEPRECATED_ATTRIBUTE
237 #define IMPSCRATCH_DEPRECATED_METHOD_DECL(version) \
238  IMP_DEPRECATED_ATTRIBUTE
239 
240 #else //IMPSCRATCH_SHOW_WARNINGS
241 /** See [deprecation support](@ref deprecation). */
242 #define IMPSCRATCH_DEPRECATED_HEADER(version, help_message) \
243 /** See [deprecation support](@ref deprecation). */
244 #define IMPSCRATCH_DEPRECATED_VALUE_DECL(version)
245 /** See [deprecation support](@ref deprecation). */
246 #define IMPSCRATCH_DEPRECATED_OBJECT_DECL(version)
247 /** See [deprecation support](@ref deprecation). */
248 #define IMPSCRATCH_DEPRECATED_FUNCTION_DECL(version)
249 /** See [deprecation support](@ref deprecation). */
250 #define IMPSCRATCH_DEPRECATED_METHOD_DECL(version)
251 
252 #endif // IMPSCRATCH_SHOW_WARNINGS
253 
254 // only warn about it in the all inclusion to cut down on copies
255 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
256  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
257  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
258  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
259  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
260  || defined(IMPSCOREFUNCTOR_COMPILATION)
261 /** See [deprecation support](@ref deprecation). */
262 #define IMPSCRATCH_DEPRECATED_MACRO(version, message)
263 
264 #else
265 #define IMPSCRATCH_DEPRECATED_MACRO(version, message) \
266  IMP_DEPRECATED_MACRO(version, message)
267 #endif
268 
269 /** See [deprecation support](@ref deprecation). */
270 #define IMPSCRATCH_DEPRECATED_VALUE_DEF(version, message) \
271  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
272 
273 /** See [deprecation support](@ref deprecation). */
274 #define IMPSCRATCH_DEPRECATED_OBJECT_DEF(version, message) \
275  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
276 
277 /** See [deprecation support](@ref deprecation). */
278 #define IMPSCRATCH_DEPRECATED_FUNCTION_DEF(version, message) \
279  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
280 
281 /** See [deprecation support](@ref deprecation). */
282 #define IMPSCRATCH_DEPRECATED_METHOD_DEF(version, message) \
283  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
284 
285 
286 #include <IMP/compiler_macros.h>
287 
288 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
289 IMP_COMPILER_ENABLE_WARNINGS
290 #define IMP_EXECUTABLE_WARNINGS
291 #endif
std::string get_example_path(std::string file_name)
Return the full path to one of this module's example files.
IO support.
IO support.
Various compiler workarounds.
std::string get_data_path(std::string file_name)
Return the full path to one of this module's data files.