IMP logo
IMP Reference Guide  2.6.2
The Integrative Modeling Platform
example_config.h
1 // Autogenerated by ../../../../tmp/nightly-build-86896/imp-2.6.2/tools/build/setup_module.py
2 // from ../../../../tmp/nightly-build-86896/imp-2.6.2/tools/build/config_templates/header.h
3 // Do not edit - any changes will be lost!
4 
5 /*
6  * \file IMP/example/example_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, IMPEXAMPLE_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  * IMPEXAMPLEEXPORT 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::example namespace.
21  * This is simply achieved by wrapping things with the
22  * IMPEXAMPLE_BEGIN_NAMESPACE and IMPEXAMPLE_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-2016 IMP Inventors. All rights reserved.
27  *
28  */
29 
30 #ifndef IMPEXAMPLE_CONFIG_H
31 #define IMPEXAMPLE_CONFIG_H
32 
33 #include <IMP/kernel_config.h>
34 #include <string>
35 
36 #ifdef _MSC_VER
37 #define NOMINMAX
38 
39 #ifdef IMPEXAMPLE_EXPORTS
40 #define IMPEXAMPLEEXPORT __declspec(dllexport)
41 #else // EXPORTS
42 #define IMPEXAMPLEEXPORT __declspec(dllimport)
43 #endif // EXPORTS
44 
45 #else // _MSC_VER
46 
47 #ifdef GCC_VISIBILITY
48 #define IMPEXAMPLEEXPORT __attribute__((visibility("default")))
49 #else // GCC_VISIBILITY
50 #define IMPEXAMPLEEXPORT
51 #endif // GCC_VISIBILITY
52 
53 #endif // _MSC_VER
54 
55 #if defined(_MSC_VER) && !defined(SWIG)
56 #ifdef IMPEXAMPLE_EXPORTS
57 
58 #define IMPEXAMPLE_EXPORT_TEMPLATE(name) \
59  template class __declspec(dllexport) name
60 
61 #else //EXPORTS
62 
63 #define IMPEXAMPLE_EXPORT_TEMPLATE(name) \
64  template class __declspec(dllimport) name
65 
66 #endif // EXPORTS
67 
68 #else // MSC and SWIG
69 #define IMPEXAMPLE_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
70 
71 #endif // MSC and SWIG
72 
73 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
74 
75 #define IMPEXAMPLE_BEGIN_NAMESPACE \
76  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{ namespace example {
77 
78 #define IMPEXAMPLE_END_NAMESPACE } } \
79 IMP_COMPILER_DISABLE_WARNINGS
80 
81 #define IMPEXAMPLE_BEGIN_INTERNAL_NAMESPACE IMPEXAMPLE_BEGIN_NAMESPACE \
82  namespace internal {
83 
84 #define IMPEXAMPLE_END_INTERNAL_NAMESPACE } IMPEXAMPLE_END_NAMESPACE
85 
86 #else // SWIG and DOXYGEN
87 #define IMPEXAMPLE_BEGIN_NAMESPACE namespace IMP{ namespace example {
88 
89 #define IMPEXAMPLE_END_NAMESPACE } }
90 
91 #define IMPEXAMPLE_BEGIN_INTERNAL_NAMESPACE IMPEXAMPLE_BEGIN_NAMESPACE\
92  namespace internal {
93 
94 #define IMPEXAMPLE_END_INTERNAL_NAMESPACE } IMPEXAMPLE_END_NAMESPACE
95 
96 #endif // SWIG AND DOXYGEN
97 
98 #define IMP_EXAMPLE_USE_IMP_ALGEBRA
99 #define IMP_EXAMPLE_HAS_IMP_ALGEBRA 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{ namespace example {
135 /** \name Standard module functions
136  All \imp modules have a set of standard functions to help get information
137  about the module and about files associated with the module.
138  @{
139  */
140 #if !defined(SWIG)
141  IMPEXAMPLEEXPORT std::string get_module_version();
142 #endif
143 
144 #if !defined(SWIG)
145  // SWIG will whine about duplicate definitions of function
146  inline std::string get_module_name() { return "IMP::example"; }
147 #endif
148 
149  //! Return the full path to one of this module's data files
150  /** To read the data file "data_library" that was placed in the \c data
151  directory of this module, do something like
152  \code
153  std::ifstream in(IMP::example::get_data_path("data_library"));
154  \endcode
155  This will ensure that the code works both when %IMP is installed or
156  if used via the \c setup_environment.sh script.
157 
158  \note Each module has its own data directory, so be sure to use
159  this function from the correct module.
160  */
161 #if !defined(SWIG)
162  IMPEXAMPLEEXPORT std::string get_data_path(std::string file_name);
163 #endif
164 
165  //! Return the full path to one of this module's example files
166  /** To read the example file "example_protein.pdb" that was placed
167  in the \c examples directory of this module, do something like
168  \code
169  std::ifstream in(IMP::example::get_example_path("example_protein.pdb"));
170  \endcode
171  This will ensure that the code works both when %IMP is installed or
172  if used via the \c setup_environment.sh script.
173 
174  \note Each module has its own example directory, so be sure to use
175  this function from the correct module.
176  */
177 #if !defined(SWIG)
178  IMPEXAMPLEEXPORT std::string get_example_path(std::string file_name);
179 #endif
180  /** @} */
181 
182 
183 } } //namespace
184 
185 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
186 
187 #include <IMP/Showable.h>
188 #include <IMP/hash.h>
189 
190 namespace IMP{ namespace example {
191 using ::IMP::Showable;
192 using ::IMP::operator<<;
193 using ::IMP::hash_value;
194 } } // namespace
195 namespace IMP{ namespace example { namespace internal {
196 using ::IMP::Showable;
197 using ::IMP::operator<<;
198 using ::IMP::hash_value;
199 } } } // namespace
200 
201 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
202 
203 
204 #include <IMP/compiler_macros.h>
205 
206 #endif /* IMPEXAMPLE_CONFIG_H */
207 
208 // Here so it is always parsed
209 
210 #ifdef IMPEXAMPLE_DEPRECATED_HEADER
211 #undef IMPEXAMPLE_DEPRECATED_HEADER
212 #undef IMPEXAMPLE_DEPRECATED_VALUE_DEF
213 #undef IMPEXAMPLE_DEPRECATED_VALUE_DECL
214 #undef IMPEXAMPLE_DEPRECATED_OBJECT_DEF
215 #undef IMPEXAMPLE_DEPRECATED_OBJECT_DECL
216 #undef IMPEXAMPLE_DEPRECATED_FUNCTION_DEF
217 #undef IMPEXAMPLE_DEPRECATED_FUNCTION_DECL
218 #undef IMPEXAMPLE_DEPRECATED_METHOD_DEF
219 #undef IMPEXAMPLE_DEPRECATED_METHOD_DECL
220 #undef IMPEXAMPLE_DEPRECATED_MACRO
221 #undef IMPEXAMPLE_SHOW_WARNINGS
222 #endif
223 
224 // the central modules we can update easily, so don't warn in them
225 #if defined( IMPEXAMPLE_COMPILATION) \
226  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
227  || defined( IMPEXAMPLE_ALL) || defined(IMP_DOXYGEN) \
228  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
229  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
230  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
231  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
232  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
233  || defined(IMPGSL_COMPILATION)
234 #define IMPEXAMPLE_SHOW_WARNINGS 0
235 #else
236 #define IMPEXAMPLE_SHOW_WARNINGS 1
237 #endif
238 
239 // suppress header warnings with all header, SWIG wrapper and in the module
240 #if IMPEXAMPLE_SHOW_WARNINGS
241 #define IMPEXAMPLE_DEPRECATED_HEADER(version, help_message) \
242  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
243 #define IMPEXAMPLE_DEPRECATED_VALUE_DECL(version) \
244  IMP_DEPRECATED_ATTRIBUTE
245 #define IMPEXAMPLE_DEPRECATED_OBJECT_DECL(version) \
246  IMP_DEPRECATED_ATTRIBUTE
247 #define IMPEXAMPLE_DEPRECATED_FUNCTION_DECL(version) \
248  IMP_DEPRECATED_ATTRIBUTE
249 #define IMPEXAMPLE_DEPRECATED_METHOD_DECL(version) \
250  IMP_DEPRECATED_ATTRIBUTE
251 
252 #else //IMPEXAMPLE_SHOW_WARNINGS
253 /** See [deprecation support](@ref deprecation). */
254 #define IMPEXAMPLE_DEPRECATED_HEADER(version, help_message) \
255 /** See [deprecation support](@ref deprecation). */
256 #define IMPEXAMPLE_DEPRECATED_VALUE_DECL(version)
257 /** See [deprecation support](@ref deprecation). */
258 #define IMPEXAMPLE_DEPRECATED_OBJECT_DECL(version)
259 /** See [deprecation support](@ref deprecation). */
260 #define IMPEXAMPLE_DEPRECATED_FUNCTION_DECL(version)
261 /** See [deprecation support](@ref deprecation). */
262 #define IMPEXAMPLE_DEPRECATED_METHOD_DECL(version)
263 
264 #endif // IMPEXAMPLE_SHOW_WARNINGS
265 
266 // only warn about it in the all inclusion to cut down on copies
267 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
268  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
269  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
270  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
271  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
272  || defined(IMPSCOREFUNCTOR_COMPILATION)
273 /** See [deprecation support](@ref deprecation). */
274 #define IMPEXAMPLE_DEPRECATED_MACRO(version, message)
275 
276 #else
277 #define IMPEXAMPLE_DEPRECATED_MACRO(version, message) \
278  IMP_DEPRECATED_MACRO(version, message)
279 #endif
280 
281 /** See [deprecation support](@ref deprecation). */
282 #define IMPEXAMPLE_DEPRECATED_VALUE_DEF(version, message) \
283  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
284 
285 /** See [deprecation support](@ref deprecation). */
286 #define IMPEXAMPLE_DEPRECATED_OBJECT_DEF(version, message) \
287  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
288 
289 /** See [deprecation support](@ref deprecation). */
290 #define IMPEXAMPLE_DEPRECATED_FUNCTION_DEF(version, message) \
291  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
292 
293 /** See [deprecation support](@ref deprecation). */
294 #define IMPEXAMPLE_DEPRECATED_METHOD_DEF(version, message) \
295  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
296 
297 
298 #include <IMP/compiler_macros.h>
299 
300 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
301 IMP_COMPILER_ENABLE_WARNINGS
302 #define IMP_EXECUTABLE_WARNINGS
303 #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 full path to one of this module's example files.
IMP::example::get_data_path
std::string get_data_path(std::string file_name)
Return the full path to one of this module's data files.