IMP  2.1.0
The Integrative Modeling Platform
base_config.h
1 /*
2  * \file IMP/base/base_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, IMPBASE_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  * IMPBASEEXPORT 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::base namespace.
17  * This is simply achieved by wrapping things with the
18  * IMPBASE_BEGIN_NAMESPACE and IMPBASE_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-2013 IMP Inventors. All rights reserved.
26  *
27  */
28 
29 #ifndef IMPBASE_CONFIG_H
30 #define IMPBASE_CONFIG_H
31 
32 #include <IMP/base/base_config.h>
33 #include <string>
34 
35 #ifdef _MSC_VER
36 
37 #ifdef IMPBASE_EXPORTS
38 #define IMPBASEEXPORT __declspec(dllexport)
39 #else // EXPORTS
40 #define IMPBASEEXPORT __declspec(dllimport)
41 #endif // EXPORTS
42 
43 #else // _MSC_VER
44 
45 #ifdef GCC_VISIBILITY
46 #define IMPBASEEXPORT __attribute__((visibility("default")))
47 #else // GCC_VISIBILITY
48 #define IMPBASEEXPORT
49 #endif // GCC_VISIBILITY
50 
51 #endif // _MSC_VER
52 
53 #if defined(_MSC_VER) && !defined(SWIG)
54 #ifdef IMPBASE_EXPORTS
55 
56 #define IMPBASE_EXPORT_TEMPLATE(name) \
57  template class __declspec(dllexport) name
58 
59 #else //EXPORTS
60 
61 #define IMPBASE_EXPORT_TEMPLATE(name) \
62  template class __declspec(dllimport) name
63 
64 #endif // EXPORTS
65 
66 #else // MSC and SWIG
67 #define IMPBASE_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
68 
69 #endif // MSC and SWIG
70 
71 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
72 
73 #define IMPBASE_BEGIN_NAMESPACE \
74  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{namespace base {
75 
76 #define IMPBASE_END_NAMESPACE } } \
77 IMP_COMPILER_DISABLE_WARNINGS
78 
79 #define IMPBASE_BEGIN_INTERNAL_NAMESPACE IMPBASE_BEGIN_NAMESPACE \
80  namespace internal {
81 
82 #define IMPBASE_END_INTERNAL_NAMESPACE } IMPBASE_END_NAMESPACE
83 
84 #else // SWIG and DOXYGEN
85 #define IMPBASE_BEGIN_NAMESPACE namespace IMP{namespace base {
86 
87 #define IMPBASE_END_NAMESPACE } }
88 
89 #define IMPBASE_BEGIN_INTERNAL_NAMESPACE IMPBASE_BEGIN_NAMESPACE\
90  namespace internal {
91 
92 #define IMPBASE_END_INTERNAL_NAMESPACE } IMPBASE_END_NAMESPACE
93 
94 #endif // SWIG AND DOXYGEN
95 
96 #define IMP_BUILD IMP_RELEASE
97 #define IMP_HAS_LOG IMP_VERBOSE
98 #define IMP_HAS_CHECKS IMP_INTERNAL
99 #define IMP_DEBUG 0
100 #define IMP_RELEASE 1
101 #define IMP_SILENT 0
102 #define IMP_PROGRESS 2
103 #define IMP_TERSE 3
104 #define IMP_VERBOSE 4
105 #define IMP_MEMORY 5
106 #define IMP_NONE 0
107 #define IMP_USAGE 1
108 #define IMP_INTERNAL 2
109 #define IMP_BASE_HAS_LOG4CXX 0
110 #define IMP_COMPILER_HAS_AUTO 0
111 #define IMP_COMPILER_HAS_DEBUG_VECTOR 1
112 #define IMP_BASE_USE_BOOST_RANDOM
113 #define IMP_BASE_HAS_BOOST_RANDOM 1
114 #define IMP_BASE_NO_GPERFTOOLS
115 #define IMP_BASE_HAS_GPERFTOOLS 0
116 #define IMP_BASE_NO_TCMALLOC_HEAPCHECKER
117 #define IMP_BASE_HAS_TCMALLOC_HEAPCHECKER 0
118 #define IMP_BASE_NO_TCMALLOC_HEAPPROFILER
119 #define IMP_BASE_HAS_TCMALLOC_HEAPPROFILER 0
120 
121  // functions are defined explicitly for SWIG
122  namespace IMP {
123  namespace base {
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  IMPBASEEXPORT 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::base"; }
136 #endif
137 
138  }
139 } //namespace
140 
141 
142 
143 #if !defined(SWIG)
144  namespace IMP {
145  namespace base {
146 
147  //! Return the full path to installed data
148  /** Each module has its own data directory, so be sure to use
149  the version of this function in the correct module. To read
150  the data file "data_library" that was placed in the \c data
151  directory of module "mymodule", do something like
152  \code
153  std::ifstream in(IMP::mymodule::get_data_path("data_library"));
154  \endcode
155  This will ensure that the code works when \imp is installed or
156  used via the \c setup_environment.sh script.
157  */
158  IMPBASEEXPORT std::string get_data_path(std::string file_name);
159 
160  //! Return the path to installed example data for this module
161  /** Each module has its own example directory, so be sure to use
162  the version of this function in the correct module. For example
163  to read the file \c example_protein.pdb located in the
164  \c examples directory of the IMP::atom module, do
165  \code
166  IMP::atom::read_pdb(IMP::atom::get_example_path("example_protein.pdb",
167  model));
168  \endcode
169  This will ensure that the code works when \imp is installed or
170  used via the \c setup_environment.sh script.
171  */
172  IMPBASEEXPORT std::string get_example_path(std::string file_name);
173  /** @} */
174 
175  }
176 } // namespace
177 
178 #endif // SWIG
179 
181 
182 #ifdef IMP_DOXYGEN
183 /** \namespace IMP::base
184  \brief See [IMP.base](\ref impbase) for more information.
185  */
186 #endif
187 
188 #endif /* IMPBASE_CONFIG_H */
189 
190 // Here so it is always parsed
191 
192 #ifdef IMPBASE_DEPRECATED_HEADER
193 #undef IMPBASE_DEPRECATED_HEADER
194 #undef IMPBASE_DEPRECATED_VALUE_DEF
195 #undef IMPBASE_DEPRECATED_VALUE_DECL
196 #undef IMPBASE_DEPRECATED_OBJECT_DEF
197 #undef IMPBASE_DEPRECATED_OBJECT_DECL
198 #undef IMPBASE_DEPRECATED_FUNCTION_DEF
199 #undef IMPBASE_DEPRECATED_FUNCTION_DECL
200 #undef IMPBASE_DEPRECATED_METHOD_DEF
201 #undef IMPBASE_DEPRECATED_METHOD_DECL
202 #undef IMPBASE_DEPRECATED_MACRO
203 #undef IMPBASE_SHOW_WARNINGS
204 #endif
205 
206 // the central modules we can update easily, so don't warn in them
207 #if defined( IMPBASE_COMPILATION) \
208  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
209  || defined( IMPBASE_ALL) || defined(IMP_DOXYGEN) \
210  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
211  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
212  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
213  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
214  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
215  || defined(IMPGSL_COMPILATION)
216 #define IMPBASE_SHOW_WARNINGS 0
217 #else
218 #define IMPBASE_SHOW_WARNINGS 1
219 #endif
220 
221 // suppress header warnings with all header, SWIG wrapper and in the module
222 #if IMPBASE_SHOW_WARNINGS
223 #define IMPBASE_DEPRECATED_HEADER(version, help_message) \
224  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
225 #define IMPBASE_DEPRECATED_VALUE_DECL(version) \
226  IMP_DEPRECATED_ATTRIBUTE
227 #define IMPBASE_DEPRECATED_OBJECT_DECL(version) \
228  IMP_DEPRECATED_ATTRIBUTE
229 #define IMPBASE_DEPRECATED_FUNCTION_DECL(version) \
230  IMP_DEPRECATED_ATTRIBUTE
231 #define IMPBASE_DEPRECATED_METHOD_DECL(version) \
232  IMP_DEPRECATED_ATTRIBUTE
233 
234 #else //IMPBASE_SHOW_WARNINGS
235 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
236 #define IMPBASE_DEPRECATED_HEADER(version, help_message) \
237 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
238 #define IMPBASE_DEPRECATED_VALUE_DECL(version)
239 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
240 #define IMPBASE_DEPRECATED_OBJECT_DECL(version)
241 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
242 #define IMPBASE_DEPRECATED_FUNCTION_DECL(version)
243 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
244 #define IMPBASE_DEPRECATED_METHOD_DECL(version)
245 
246 #endif // IMPBASE_SHOW_WARNINGS
247 
248 // only warn about it in the all inclusion to cut down on copies
249 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
250  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
251  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
252  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
253  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
254  || defined(IMPSCOREFUNCTOR_COMPILATION)
255 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
256 #define IMPBASE_DEPRECATED_MACRO(version, message)
257 
258 #else
259 #define IMPBASE_DEPRECATED_MACRO(version, message) \
260  IMP_DEPRECATED_MACRO(version, message)
261 #endif
262 
263 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
264 #define IMPBASE_DEPRECATED_VALUE_DEF(version, message) \
265  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
266 
267 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
268 #define IMPBASE_DEPRECATED_OBJECT_DEF(version, message) \
269  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
270 
271 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
272 #define IMPBASE_DEPRECATED_FUNCTION_DEF(version, message) \
273  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
274 
275 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
276 #define IMPBASE_DEPRECATED_METHOD_DEF(version, message) \
277  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
278 
279 
281 
282 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
283 IMP_COMPILER_ENABLE_WARNINGS
284 #define IMP_EXECUTABLE_WARNINGS
285 #endif
std::string get_data_path(std::string file_name)
Return the full path to installed data.
std::string get_example_path(std::string file_name)
Return the path to installed example data for this module.
Various compiler workarounds.