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