IMP logo
IMP Reference Guide  2.20.2
The Integrative Modeling Platform
mpi_config.h
1 // Autogenerated by ../../../../tmp/nightly-build-36632/imp-2.20.2/tools/build/setup_module.py
2 // from ../../../../tmp/nightly-build-36632/imp-2.20.2/tools/build/config_templates/header.h
3 // Do not edit - any changes will be lost!
4 
5 /*
6  * \file IMP/mpi/mpi_config.h
7  * \brief Provide macros to mark functions and classes as exported
8  * from a DLL/.so, and to set up namespaces
9  *
10  * When building the module, IMPMPI_EXPORTS should be defined, and when
11  * using the module externally, it should not be. Classes and functions
12  * declared in the module's headers should then be marked with
13  * IMPMPIEXPORT if they are intended to be part of the API and
14  * they are not defined entirely in a header.
15  *
16  * The Windows build environment requires applications to mark exports in
17  * this way; we use the same markings to set the visibility of ELF symbols
18  * if we have compiler support.
19  *
20  * All code in this module should live in the IMP::mpi namespace.
21  * This is simply achieved by wrapping things with the
22  * IMPMPI_BEGIN_NAMESPACE and IMPMPI_END_NAMESPACE macros.
23  * There are similar macros for module code that is designed to be for
24  * internal use only.
25  *
26  * Copyright 2007-2022 IMP Inventors. All rights reserved.
27  *
28  */
29 
30 #ifndef IMPMPI_CONFIG_H
31 #define IMPMPI_CONFIG_H
32 
33 #include <IMP/kernel_config.h>
34 #include <string>
35 
36 #ifdef _MSC_VER
37 #define NOMINMAX
38 
39 #ifdef IMPMPI_EXPORTS
40 #define IMPMPIEXPORT __declspec(dllexport)
41 #else // EXPORTS
42 #define IMPMPIEXPORT __declspec(dllimport)
43 #endif // EXPORTS
44 
45 #else // _MSC_VER
46 
47 #ifdef GCC_VISIBILITY
48 #define IMPMPIEXPORT __attribute__((visibility("default")))
49 #else // GCC_VISIBILITY
50 #define IMPMPIEXPORT
51 #endif // GCC_VISIBILITY
52 
53 #endif // _MSC_VER
54 
55 #if defined(_MSC_VER) && !defined(SWIG)
56 #ifdef IMPMPI_EXPORTS
57 
58 #define IMPMPI_EXPORT_TEMPLATE(name) \
59  template class __declspec(dllexport) name
60 
61 #else //EXPORTS
62 
63 #define IMPMPI_EXPORT_TEMPLATE(name) \
64  template class __declspec(dllimport) name
65 
66 #endif // EXPORTS
67 
68 #else // MSC and SWIG
69 #define IMPMPI_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
70 
71 #endif // MSC and SWIG
72 
73 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
74 
75 #define IMPMPI_BEGIN_NAMESPACE \
76  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{ namespace mpi {
77 
78 #define IMPMPI_END_NAMESPACE } } \
79 IMP_COMPILER_DISABLE_WARNINGS
80 
81 #define IMPMPI_BEGIN_INTERNAL_NAMESPACE IMPMPI_BEGIN_NAMESPACE \
82  namespace internal {
83 
84 #define IMPMPI_END_INTERNAL_NAMESPACE } IMPMPI_END_NAMESPACE
85 
86 #else // SWIG and DOXYGEN
87 #define IMPMPI_BEGIN_NAMESPACE namespace IMP{ namespace mpi {
88 
89 #define IMPMPI_END_NAMESPACE } }
90 
91 #define IMPMPI_BEGIN_INTERNAL_NAMESPACE IMPMPI_BEGIN_NAMESPACE\
92  namespace internal {
93 
94 #define IMPMPI_END_INTERNAL_NAMESPACE } IMPMPI_END_NAMESPACE
95 
96 #endif // SWIG AND DOXYGEN
97 
98 #define IMP_MPI_USE_BOOST_FILESYSTEM
99 #define IMP_MPI_HAS_BOOST_FILESYSTEM 1
100 #define IMP_MPI_USE_BOOST_PROGRAMOPTIONS
101 #define IMP_MPI_HAS_BOOST_PROGRAMOPTIONS 1
102 #define IMP_MPI_USE_BOOST_RANDOM
103 #define IMP_MPI_HAS_BOOST_RANDOM 1
104 #define IMP_MPI_USE_BOOST_SYSTEM
105 #define IMP_MPI_HAS_BOOST_SYSTEM 1
106 #define IMP_MPI_USE_NUMPY
107 #define IMP_MPI_HAS_NUMPY 1
108 
109 // functions are defined explicitly for SWIG
110 namespace IMP{ namespace mpi {
111 /** \name Standard module functions
112  All \imp modules have a set of standard functions to help get information
113  about the module and about files associated with the module.
114  @{
115  */
116 #if !defined(SWIG)
117  IMPMPIEXPORT std::string get_module_version();
118 #endif
119 
120 #if !defined(SWIG)
121  // SWIG will whine about duplicate definitions of function
122  inline std::string get_module_name() { return "IMP::mpi"; }
123 #endif
124 
125  //! Return the full path to one of this module's data files
126  /** To read the data file "data_library" that was placed in the \c data
127  directory of this module, do something like
128  \code
129  std::ifstream in(IMP::mpi::get_data_path("data_library"));
130  \endcode
131  This will ensure that the code works both when IMP is installed or
132  if used via the \c setup_environment.sh script.
133 
134  \note Each module has its own data directory, so be sure to use
135  this function from the correct module.
136  */
137 #if !defined(SWIG)
138  IMPMPIEXPORT std::string get_data_path(std::string file_name);
139 #endif
140 
141  //! Return the full path to one of this module's example files
142  /** To read the example file "example_protein.pdb" that was placed
143  in the \c examples directory of this module, do something like
144  \code
145  std::ifstream in(IMP::mpi::get_example_path("example_protein.pdb"));
146  \endcode
147  This will ensure that the code works both when IMP is installed or
148  if used via the \c setup_environment.sh script.
149 
150  \note Each module has its own example directory, so be sure to use
151  this function from the correct module.
152  */
153 #if !defined(SWIG)
154  IMPMPIEXPORT std::string get_example_path(std::string file_name);
155 #endif
156  /** @} */
157 
158 
159 } } //namespace
160 
161 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
162 
163 #include <IMP/Showable.h>
164 #include <IMP/hash.h>
165 
166 namespace IMP{ namespace mpi {
167 using ::IMP::Showable;
168 using ::IMP::operator<<;
169 using ::IMP::hash_value;
170 } } // namespace
171 namespace IMP{ namespace mpi { namespace internal {
172 using ::IMP::Showable;
173 using ::IMP::operator<<;
174 using ::IMP::hash_value;
175 } } } // namespace
176 
177 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
178 
179 
180 #include <IMP/compiler_macros.h>
181 
182 #endif /* IMPMPI_CONFIG_H */
183 
184 // Here so it is always parsed
185 
186 #ifdef IMPMPI_DEPRECATED_HEADER
187 #undef IMPMPI_DEPRECATED_HEADER
188 #undef IMPMPI_DEPRECATED_VALUE_DEF
189 #undef IMPMPI_DEPRECATED_VALUE_DECL
190 #undef IMPMPI_DEPRECATED_OBJECT_DEF
191 #undef IMPMPI_DEPRECATED_OBJECT_DECL
192 #undef IMPMPI_DEPRECATED_FUNCTION_DEF
193 #undef IMPMPI_DEPRECATED_FUNCTION_DECL
194 #undef IMPMPI_DEPRECATED_METHOD_DEF
195 #undef IMPMPI_DEPRECATED_METHOD_DECL
196 #undef IMPMPI_DEPRECATED_MACRO
197 #undef IMPMPI_SHOW_WARNINGS
198 #endif
199 
200 // the central modules we can update easily, so don't warn in them
201 #if defined( IMPMPI_COMPILATION) \
202  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
203  || defined( IMPMPI_ALL) || defined(IMP_DOXYGEN) \
204  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
205  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
206  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
207  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
208  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
209  || defined(IMPGSL_COMPILATION)
210 #define IMPMPI_SHOW_WARNINGS 0
211 #else
212 #define IMPMPI_SHOW_WARNINGS 1
213 #endif
214 
215 // suppress header warnings with all header, SWIG wrapper and in the module
216 #if IMPMPI_SHOW_WARNINGS
217 #define IMPMPI_DEPRECATED_HEADER(version, help_message) \
218  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
219 #define IMPMPI_DEPRECATED_VALUE_DECL(version) \
220  IMP_DEPRECATED_ATTRIBUTE
221 #define IMPMPI_DEPRECATED_OBJECT_DECL(version) \
222  IMP_DEPRECATED_ATTRIBUTE
223 #define IMPMPI_DEPRECATED_FUNCTION_DECL(version) \
224  IMP_DEPRECATED_ATTRIBUTE
225 #define IMPMPI_DEPRECATED_METHOD_DECL(version) \
226  IMP_DEPRECATED_ATTRIBUTE
227 
228 #else //IMPMPI_SHOW_WARNINGS
229 /** See [deprecation support](@ref deprecation). */
230 #define IMPMPI_DEPRECATED_HEADER(version, help_message) \
231 /** See [deprecation support](@ref deprecation). */
232 #define IMPMPI_DEPRECATED_VALUE_DECL(version)
233 /** See [deprecation support](@ref deprecation). */
234 #define IMPMPI_DEPRECATED_OBJECT_DECL(version)
235 /** See [deprecation support](@ref deprecation). */
236 #define IMPMPI_DEPRECATED_FUNCTION_DECL(version)
237 /** See [deprecation support](@ref deprecation). */
238 #define IMPMPI_DEPRECATED_METHOD_DECL(version)
239 
240 #endif // IMPMPI_SHOW_WARNINGS
241 
242 // only warn about it in the all inclusion to cut down on copies
243 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
244  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
245  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
246  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
247  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
248  || defined(IMPSCOREFUNCTOR_COMPILATION)
249 /** See [deprecation support](@ref deprecation). */
250 #define IMPMPI_DEPRECATED_MACRO(version, message)
251 
252 #else
253 #define IMPMPI_DEPRECATED_MACRO(version, message) \
254  IMP_DEPRECATED_MACRO(version, message)
255 #endif
256 
257 /** See [deprecation support](@ref deprecation). */
258 #define IMPMPI_DEPRECATED_VALUE_DEF(version, message) \
259  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
260 
261 /** See [deprecation support](@ref deprecation). */
262 #define IMPMPI_DEPRECATED_OBJECT_DEF(version, message) \
263  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
264 
265 /** See [deprecation support](@ref deprecation). */
266 #define IMPMPI_DEPRECATED_FUNCTION_DEF(version, message) \
267  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
268 
269 /** See [deprecation support](@ref deprecation). */
270 #define IMPMPI_DEPRECATED_METHOD_DEF(version, message) \
271  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
272 
273 
274 #include <IMP/compiler_macros.h>
275 
276 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
277 IMP_COMPILER_ENABLE_WARNINGS
278 #define IMP_EXECUTABLE_WARNINGS
279 #endif
Helper functions for implementing hashes.
Helper class to aid in output of IMP classes to streams.
std::string get_example_path(std::string file_name)
Return the full path to one of this module's example files.
std::string get_module_version()
Return the version of this module, as a string.
Various compiler workarounds.
std::string get_data_path(std::string file_name)
Return the full path to one of this module's data files.