IMP  2.3.1
The Integrative Modeling Platform
example_config.h
1 /*
2  * \file IMP/example/example_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, IMPEXAMPLE_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  * IMPEXAMPLEEXPORT 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::example namespace.
17  * This is simply achieved by wrapping things with the
18  * IMPEXAMPLE_BEGIN_NAMESPACE and IMPEXAMPLE_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 IMPEXAMPLE_CONFIG_H
30 #define IMPEXAMPLE_CONFIG_H
31 
32 #include <IMP/base/base_config.h>
33 #include <string>
34 
35 #ifdef _MSC_VER
36 
37 #ifdef IMPEXAMPLE_EXPORTS
38 #define IMPEXAMPLEEXPORT __declspec(dllexport)
39 #else // EXPORTS
40 #define IMPEXAMPLEEXPORT __declspec(dllimport)
41 #endif // EXPORTS
42 
43 #else // _MSC_VER
44 
45 #ifdef GCC_VISIBILITY
46 #define IMPEXAMPLEEXPORT __attribute__((visibility("default")))
47 #else // GCC_VISIBILITY
48 #define IMPEXAMPLEEXPORT
49 #endif // GCC_VISIBILITY
50 
51 #endif // _MSC_VER
52 
53 #if defined(_MSC_VER) && !defined(SWIG)
54 #ifdef IMPEXAMPLE_EXPORTS
55 
56 #define IMPEXAMPLE_EXPORT_TEMPLATE(name) \
57  template class __declspec(dllexport) name
58 
59 #else //EXPORTS
60 
61 #define IMPEXAMPLE_EXPORT_TEMPLATE(name) \
62  template class __declspec(dllimport) name
63 
64 #endif // EXPORTS
65 
66 #else // MSC and SWIG
67 #define IMPEXAMPLE_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
68 
69 #endif // MSC and SWIG
70 
71 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
72 
73 #define IMPEXAMPLE_BEGIN_NAMESPACE \
74  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{namespace example {
75 
76 #define IMPEXAMPLE_END_NAMESPACE } } \
77 IMP_COMPILER_DISABLE_WARNINGS
78 
79 #define IMPEXAMPLE_BEGIN_INTERNAL_NAMESPACE IMPEXAMPLE_BEGIN_NAMESPACE \
80  namespace internal {
81 
82 #define IMPEXAMPLE_END_INTERNAL_NAMESPACE } IMPEXAMPLE_END_NAMESPACE
83 
84 #else // SWIG and DOXYGEN
85 #define IMPEXAMPLE_BEGIN_NAMESPACE namespace IMP{namespace example {
86 
87 #define IMPEXAMPLE_END_NAMESPACE } }
88 
89 #define IMPEXAMPLE_BEGIN_INTERNAL_NAMESPACE IMPEXAMPLE_BEGIN_NAMESPACE\
90  namespace internal {
91 
92 #define IMPEXAMPLE_END_INTERNAL_NAMESPACE } IMPEXAMPLE_END_NAMESPACE
93 
94 #endif // SWIG AND DOXYGEN
95 
96 #define IMP_EXAMPLE_USE_IMP_ALGEBRA
97 #define IMP_EXAMPLE_HAS_IMP_ALGEBRA 1
98 #define IMP_EXAMPLE_USE_IMP_BASE
99 #define IMP_EXAMPLE_HAS_IMP_BASE 1
100 #define IMP_EXAMPLE_USE_IMP_CGAL
101 #define IMP_EXAMPLE_HAS_IMP_CGAL 1
102 #define IMP_EXAMPLE_USE_IMP_DISPLAY
103 #define IMP_EXAMPLE_HAS_IMP_DISPLAY 1
104 #define IMP_EXAMPLE_USE_IMP_KERNEL
105 #define IMP_EXAMPLE_HAS_IMP_KERNEL 1
106 #define IMP_EXAMPLE_USE_IMP_RMF
107 #define IMP_EXAMPLE_HAS_IMP_RMF 1
108 #define IMP_EXAMPLE_USE_IMP_SCORE_FUNCTOR
109 #define IMP_EXAMPLE_HAS_IMP_SCORE_FUNCTOR 1
110 #define IMP_EXAMPLE_USE_IMP_STATISTICS
111 #define IMP_EXAMPLE_HAS_IMP_STATISTICS 1
112 #define IMP_EXAMPLE_USE_BOOST_FILESYSTEM
113 #define IMP_EXAMPLE_HAS_BOOST_FILESYSTEM 1
114 #define IMP_EXAMPLE_USE_BOOST_GRAPH
115 #define IMP_EXAMPLE_HAS_BOOST_GRAPH 1
116 #define IMP_EXAMPLE_USE_BOOST_PROGRAMOPTIONS
117 #define IMP_EXAMPLE_HAS_BOOST_PROGRAMOPTIONS 1
118 #define IMP_EXAMPLE_USE_BOOST_RANDOM
119 #define IMP_EXAMPLE_HAS_BOOST_RANDOM 1
120 #define IMP_EXAMPLE_USE_BOOST_REGEX
121 #define IMP_EXAMPLE_HAS_BOOST_REGEX 1
122 #define IMP_EXAMPLE_USE_BOOST_SYSTEM
123 #define IMP_EXAMPLE_HAS_BOOST_SYSTEM 1
124 #define IMP_EXAMPLE_USE_CGAL
125 #define IMP_EXAMPLE_HAS_CGAL 1
126 #define IMP_EXAMPLE_USE_HDF5
127 #define IMP_EXAMPLE_HAS_HDF5 1
128 #define IMP_EXAMPLE_USE_RMF
129 #define IMP_EXAMPLE_HAS_RMF 1
130 #define IMP_EXAMPLE_NO_EXAMPLEDEPENDENCY
131 #define IMP_EXAMPLE_HAS_EXAMPLEDEPENDENCY 0
132 
133 // functions are defined explicitly for SWIG
134 namespace IMP {
135  namespace example {
136 /** \name Standard module functions
137  All \imp modules have a set of standard functions to help get information
138  about the module and about files associated with the module.
139  @{
140  */
141 #if !defined(SWIG)
142  IMPEXAMPLEEXPORT std::string get_module_version();
143 #endif
144 
145 #if !defined(SWIG)
146  // SWIG will whine about duplicate definitions of function
147  inline std::string get_module_name() { return "IMP::example"; }
148 #endif
149 
150  //! Return the full path to installed data
151  /** Each module has its own data directory, so be sure to use
152  the version of this function in the correct module. To read
153  the data file "data_library" that was placed in the \c data
154  directory of module "mymodule", do something like
155  \code
156  std::ifstream in(IMP::mymodule::get_data_path("data_library"));
157  \endcode
158  This will ensure that the code works when \imp is installed or
159  used via the \c setup_environment.sh script.
160  */
161 #if !defined(SWIG)
162  IMPEXAMPLEEXPORT std::string get_data_path(std::string file_name);
163 #endif
164 
165  //! Return the path to installed example data for this module
166  /** Each module has its own example directory, so be sure to use
167  the version of this function in the correct module. For example
168  to read the file \c example_protein.pdb located in the
169  \c examples directory of the IMP::atom module, do
170  \code
171  IMP::atom::read_pdb(IMP::atom::get_example_path("example_protein.pdb",
172  model));
173  \endcode
174  This will ensure that the code works when \imp is installed or
175  used via the \c setup_environment.sh script.
176  */
177 #if !defined(SWIG)
178  IMPEXAMPLEEXPORT std::string get_example_path(std::string file_name);
179 #endif
180  /** @} */
181 
182 
183  }
184 } //namespace
185 
186 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
187 
188 #include <IMP/base/Showable.h>
189 #include <IMP/base/hash.h>
190 
191 namespace IMP { namespace example {
192 using ::IMP::base::Showable;
193 using ::IMP::base::operator<<;
194 using ::IMP::base::hash_value;
195 } } // namespace
196 namespace IMP { namespace example { namespace internal {
197 using ::IMP::base::Showable;
198 using ::IMP::base::operator<<;
199 using ::IMP::base::hash_value;
200 } } } // namespace
201 
202 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
203 
204 
205 #include <IMP/base/compiler_macros.h>
206 
207 #endif /* IMPEXAMPLE_CONFIG_H */
208 
209 // Here so it is always parsed
210 
211 #ifdef IMPEXAMPLE_DEPRECATED_HEADER
212 #undef IMPEXAMPLE_DEPRECATED_HEADER
213 #undef IMPEXAMPLE_DEPRECATED_VALUE_DEF
214 #undef IMPEXAMPLE_DEPRECATED_VALUE_DECL
215 #undef IMPEXAMPLE_DEPRECATED_OBJECT_DEF
216 #undef IMPEXAMPLE_DEPRECATED_OBJECT_DECL
217 #undef IMPEXAMPLE_DEPRECATED_FUNCTION_DEF
218 #undef IMPEXAMPLE_DEPRECATED_FUNCTION_DECL
219 #undef IMPEXAMPLE_DEPRECATED_METHOD_DEF
220 #undef IMPEXAMPLE_DEPRECATED_METHOD_DECL
221 #undef IMPEXAMPLE_DEPRECATED_MACRO
222 #undef IMPEXAMPLE_SHOW_WARNINGS
223 #endif
224 
225 // the central modules we can update easily, so don't warn in them
226 #if defined( IMPEXAMPLE_COMPILATION) \
227  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
228  || defined( IMPEXAMPLE_ALL) || defined(IMP_DOXYGEN) \
229  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
230  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
231  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
232  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
233  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
234  || defined(IMPGSL_COMPILATION)
235 #define IMPEXAMPLE_SHOW_WARNINGS 0
236 #else
237 #define IMPEXAMPLE_SHOW_WARNINGS 1
238 #endif
239 
240 // suppress header warnings with all header, SWIG wrapper and in the module
241 #if IMPEXAMPLE_SHOW_WARNINGS
242 #define IMPEXAMPLE_DEPRECATED_HEADER(version, help_message) \
243  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
244 #define IMPEXAMPLE_DEPRECATED_VALUE_DECL(version) \
245  IMP_DEPRECATED_ATTRIBUTE
246 #define IMPEXAMPLE_DEPRECATED_OBJECT_DECL(version) \
247  IMP_DEPRECATED_ATTRIBUTE
248 #define IMPEXAMPLE_DEPRECATED_FUNCTION_DECL(version) \
249  IMP_DEPRECATED_ATTRIBUTE
250 #define IMPEXAMPLE_DEPRECATED_METHOD_DECL(version) \
251  IMP_DEPRECATED_ATTRIBUTE
252 
253 #else //IMPEXAMPLE_SHOW_WARNINGS
254 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
255 #define IMPEXAMPLE_DEPRECATED_HEADER(version, help_message) \
256 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
257 #define IMPEXAMPLE_DEPRECATED_VALUE_DECL(version)
258 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
259 #define IMPEXAMPLE_DEPRECATED_OBJECT_DECL(version)
260 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
261 #define IMPEXAMPLE_DEPRECATED_FUNCTION_DECL(version)
262 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
263 #define IMPEXAMPLE_DEPRECATED_METHOD_DECL(version)
264 
265 #endif // IMPEXAMPLE_SHOW_WARNINGS
266 
267 // only warn about it in the all inclusion to cut down on copies
268 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
269  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
270  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
271  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
272  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
273  || defined(IMPSCOREFUNCTOR_COMPILATION)
274 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
275 #define IMPEXAMPLE_DEPRECATED_MACRO(version, message)
276 
277 #else
278 #define IMPEXAMPLE_DEPRECATED_MACRO(version, message) \
279  IMP_DEPRECATED_MACRO(version, message)
280 #endif
281 
282 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
283 #define IMPEXAMPLE_DEPRECATED_VALUE_DEF(version, message) \
284  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
285 
286 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
287 #define IMPEXAMPLE_DEPRECATED_OBJECT_DEF(version, message) \
288  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
289 
290 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
291 #define IMPEXAMPLE_DEPRECATED_FUNCTION_DEF(version, message) \
292  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
293 
294 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
295 #define IMPEXAMPLE_DEPRECATED_METHOD_DEF(version, message) \
296  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
297 
298 
299 #include <IMP/base/compiler_macros.h>
300 
301 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
302 IMP_COMPILER_ENABLE_WARNINGS
303 #define IMP_EXECUTABLE_WARNINGS
304 #endif
hash.h
IO support.
Showable.h
IO support.
compiler_macros.h
Various compiler workarounds.
IMP::example::get_example_path
std::string get_example_path(std::string file_name)
Return the path to installed example data for this module.
IMP::example::get_data_path
std::string get_data_path(std::string file_name)
Return the full path to installed data.