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