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