IMP  2.2.1
The Integrative Modeling Platform
scratch_config.h
1 /*
2  * \file IMP/scratch/scratch_config.h
3  * \brief Provide macros to mark functions and classes as exported
4  * from a DLL/.so, and to set up namespaces
5  *
6  * When building the module, IMPSCRATCH_EXPORTS should be defined, and when
7  * using the module externally, it should not be. Classes and functions
8  * declared in the module's headers should then be marked with
9  * IMPSCRATCHEXPORT if they are intended to be part of the API and
10  * they are not defined entirely in a header.
11  *
12  * The Windows build environment requires applications to mark exports in
13  * this way; we use the same markings to set the visibility of ELF symbols
14  * if we have compiler support.
15  *
16  * All code in this module should live in the IMP::scratch namespace.
17  * This is simply achieved by wrapping things with the
18  * IMPSCRATCH_BEGIN_NAMESPACE and IMPSCRATCH_END_NAMESPACE macros.
19  * There are similar macros for module code that is designed to be for
20  * internal use only.
21  *
22  * This header is auto-generated by tools/build/setup_module.py;
23  * it should not be edited manually.
24  *
25  * Copyright 2007-2014 IMP Inventors. All rights reserved.
26  *
27  */
28 
29 #ifndef IMPSCRATCH_CONFIG_H
30 #define IMPSCRATCH_CONFIG_H
31 
32 #include <IMP/base/base_config.h>
33 #include <string>
34 
35 #ifdef _MSC_VER
36 
37 #ifdef IMPSCRATCH_EXPORTS
38 #define IMPSCRATCHEXPORT __declspec(dllexport)
39 #else // EXPORTS
40 #define IMPSCRATCHEXPORT __declspec(dllimport)
41 #endif // EXPORTS
42 
43 #else // _MSC_VER
44 
45 #ifdef GCC_VISIBILITY
46 #define IMPSCRATCHEXPORT __attribute__((visibility("default")))
47 #else // GCC_VISIBILITY
48 #define IMPSCRATCHEXPORT
49 #endif // GCC_VISIBILITY
50 
51 #endif // _MSC_VER
52 
53 #if defined(_MSC_VER) && !defined(SWIG)
54 #ifdef IMPSCRATCH_EXPORTS
55 
56 #define IMPSCRATCH_EXPORT_TEMPLATE(name) \
57  template class __declspec(dllexport) name
58 
59 #else //EXPORTS
60 
61 #define IMPSCRATCH_EXPORT_TEMPLATE(name) \
62  template class __declspec(dllimport) name
63 
64 #endif // EXPORTS
65 
66 #else // MSC and SWIG
67 #define IMPSCRATCH_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
68 
69 #endif // MSC and SWIG
70 
71 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
72 
73 #define IMPSCRATCH_BEGIN_NAMESPACE \
74  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{namespace scratch {
75 
76 #define IMPSCRATCH_END_NAMESPACE } } \
77 IMP_COMPILER_DISABLE_WARNINGS
78 
79 #define IMPSCRATCH_BEGIN_INTERNAL_NAMESPACE IMPSCRATCH_BEGIN_NAMESPACE \
80  namespace internal {
81 
82 #define IMPSCRATCH_END_INTERNAL_NAMESPACE } IMPSCRATCH_END_NAMESPACE
83 
84 #else // SWIG and DOXYGEN
85 #define IMPSCRATCH_BEGIN_NAMESPACE namespace IMP{namespace scratch {
86 
87 #define IMPSCRATCH_END_NAMESPACE } }
88 
89 #define IMPSCRATCH_BEGIN_INTERNAL_NAMESPACE IMPSCRATCH_BEGIN_NAMESPACE\
90  namespace internal {
91 
92 #define IMPSCRATCH_END_INTERNAL_NAMESPACE } IMPSCRATCH_END_NAMESPACE
93 
94 #endif // SWIG AND DOXYGEN
95 
96 #define IMP_SCRATCH_USE_IMP_ALGEBRA
97 #define IMP_SCRATCH_HAS_IMP_ALGEBRA 1
98 #define IMP_SCRATCH_USE_IMP_BASE
99 #define IMP_SCRATCH_HAS_IMP_BASE 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 {
123  namespace scratch {
124 /** \name Standard module methods
125  All \imp modules have a set of standard methods to help get information
126  about the module and about files associated with the module.
127  @{
128  */
129 #if !defined(SWIG)
130  IMPSCRATCHEXPORT std::string get_module_version();
131 #endif
132 
133 #if !defined(SWIG)
134  // SWIG will whine about duplicate definitions of function
135  inline std::string get_module_name() { return "IMP::scratch"; }
136 #endif
137 
138  }
139 } //namespace
140 
141 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
142 
143 #include <IMP/base/Showable.h>
144 #include <IMP/base/hash.h>
145 
146 namespace IMP { namespace scratch {
147 using ::IMP::base::Showable;
148 using ::IMP::base::operator<<;
149 using ::IMP::base::hash_value;
150 } } // namespace
151 namespace IMP { namespace scratch { namespace internal {
152 using ::IMP::base::Showable;
153 using ::IMP::base::operator<<;
154 using ::IMP::base::hash_value;
155 } } } // namespace
156 
157 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
158 
159 
160 #if !defined(SWIG)
161  namespace IMP {
162  namespace scratch {
163 
164  //! Return the full path to installed data
165  /** Each module has its own data directory, so be sure to use
166  the version of this function in the correct module. To read
167  the data file "data_library" that was placed in the \c data
168  directory of module "mymodule", do something like
169  \code
170  std::ifstream in(IMP::mymodule::get_data_path("data_library"));
171  \endcode
172  This will ensure that the code works when \imp is installed or
173  used via the \c setup_environment.sh script.
174  */
175  IMPSCRATCHEXPORT std::string get_data_path(std::string file_name);
176 
177  //! Return the path to installed example data for this module
178  /** Each module has its own example directory, so be sure to use
179  the version of this function in the correct module. For example
180  to read the file \c example_protein.pdb located in the
181  \c examples directory of the IMP::atom module, do
182  \code
183  IMP::atom::read_pdb(IMP::atom::get_example_path("example_protein.pdb",
184  model));
185  \endcode
186  This will ensure that the code works when \imp is installed or
187  used via the \c setup_environment.sh script.
188  */
189  IMPSCRATCHEXPORT std::string get_example_path(std::string file_name);
190  /** @} */
191 
192  }
193 } // namespace
194 
195 #endif // SWIG
196 
198 
199 #ifdef IMP_DOXYGEN
200 /** \namespace IMP::scratch
201  \brief See [IMP.scratch](\ref impscratch) for more information.
202  */
203 #endif
204 
205 #endif /* IMPSCRATCH_CONFIG_H */
206 
207 // Here so it is always parsed
208 
209 #ifdef IMPSCRATCH_DEPRECATED_HEADER
210 #undef IMPSCRATCH_DEPRECATED_HEADER
211 #undef IMPSCRATCH_DEPRECATED_VALUE_DEF
212 #undef IMPSCRATCH_DEPRECATED_VALUE_DECL
213 #undef IMPSCRATCH_DEPRECATED_OBJECT_DEF
214 #undef IMPSCRATCH_DEPRECATED_OBJECT_DECL
215 #undef IMPSCRATCH_DEPRECATED_FUNCTION_DEF
216 #undef IMPSCRATCH_DEPRECATED_FUNCTION_DECL
217 #undef IMPSCRATCH_DEPRECATED_METHOD_DEF
218 #undef IMPSCRATCH_DEPRECATED_METHOD_DECL
219 #undef IMPSCRATCH_DEPRECATED_MACRO
220 #undef IMPSCRATCH_SHOW_WARNINGS
221 #endif
222 
223 // the central modules we can update easily, so don't warn in them
224 #if defined( IMPSCRATCH_COMPILATION) \
225  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
226  || defined( IMPSCRATCH_ALL) || defined(IMP_DOXYGEN) \
227  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
228  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
229  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
230  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
231  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
232  || defined(IMPGSL_COMPILATION)
233 #define IMPSCRATCH_SHOW_WARNINGS 0
234 #else
235 #define IMPSCRATCH_SHOW_WARNINGS 1
236 #endif
237 
238 // suppress header warnings with all header, SWIG wrapper and in the module
239 #if IMPSCRATCH_SHOW_WARNINGS
240 #define IMPSCRATCH_DEPRECATED_HEADER(version, help_message) \
241  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
242 #define IMPSCRATCH_DEPRECATED_VALUE_DECL(version) \
243  IMP_DEPRECATED_ATTRIBUTE
244 #define IMPSCRATCH_DEPRECATED_OBJECT_DECL(version) \
245  IMP_DEPRECATED_ATTRIBUTE
246 #define IMPSCRATCH_DEPRECATED_FUNCTION_DECL(version) \
247  IMP_DEPRECATED_ATTRIBUTE
248 #define IMPSCRATCH_DEPRECATED_METHOD_DECL(version) \
249  IMP_DEPRECATED_ATTRIBUTE
250 
251 #else //IMPSCRATCH_SHOW_WARNINGS
252 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
253 #define IMPSCRATCH_DEPRECATED_HEADER(version, help_message) \
254 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
255 #define IMPSCRATCH_DEPRECATED_VALUE_DECL(version)
256 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
257 #define IMPSCRATCH_DEPRECATED_OBJECT_DECL(version)
258 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
259 #define IMPSCRATCH_DEPRECATED_FUNCTION_DECL(version)
260 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
261 #define IMPSCRATCH_DEPRECATED_METHOD_DECL(version)
262 
263 #endif // IMPSCRATCH_SHOW_WARNINGS
264 
265 // only warn about it in the all inclusion to cut down on copies
266 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
267  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
268  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
269  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
270  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
271  || defined(IMPSCOREFUNCTOR_COMPILATION)
272 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
273 #define IMPSCRATCH_DEPRECATED_MACRO(version, message)
274 
275 #else
276 #define IMPSCRATCH_DEPRECATED_MACRO(version, message) \
277  IMP_DEPRECATED_MACRO(version, message)
278 #endif
279 
280 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
281 #define IMPSCRATCH_DEPRECATED_VALUE_DEF(version, message) \
282  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
283 
284 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
285 #define IMPSCRATCH_DEPRECATED_OBJECT_DEF(version, message) \
286  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
287 
288 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
289 #define IMPSCRATCH_DEPRECATED_FUNCTION_DEF(version, message) \
290  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
291 
292 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
293 #define IMPSCRATCH_DEPRECATED_METHOD_DEF(version, message) \
294  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
295 
296 
298 
299 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
300 IMP_COMPILER_ENABLE_WARNINGS
301 #define IMP_EXECUTABLE_WARNINGS
302 #endif
std::string get_example_path(std::string file_name)
Return the path to installed example data for this module.
Various compiler workarounds.
IO support.
IO support.
std::string get_data_path(std::string file_name)
Return the full path to installed data.