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