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