IMP  2.4.0
The Integrative Modeling Platform
saxs_merge_config.h
1 /*
2  * \file IMP/saxs_merge/saxs_merge_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, IMPSAXSMERGE_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  * IMPSAXSMERGEEXPORT 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::saxs_merge namespace.
17  * This is simply achieved by wrapping things with the
18  * IMPSAXSMERGE_BEGIN_NAMESPACE and IMPSAXSMERGE_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-2015 IMP Inventors. All rights reserved.
26  *
27  */
28 
29 #ifndef IMPSAXSMERGE_CONFIG_H
30 #define IMPSAXSMERGE_CONFIG_H
31 
32 #include <IMP/base/base_config.h>
33 #include <string>
34 
35 #ifdef _MSC_VER
36 
37 #ifdef IMPSAXSMERGE_EXPORTS
38 #define IMPSAXSMERGEEXPORT __declspec(dllexport)
39 #else // EXPORTS
40 #define IMPSAXSMERGEEXPORT __declspec(dllimport)
41 #endif // EXPORTS
42 
43 #else // _MSC_VER
44 
45 #ifdef GCC_VISIBILITY
46 #define IMPSAXSMERGEEXPORT __attribute__((visibility("default")))
47 #else // GCC_VISIBILITY
48 #define IMPSAXSMERGEEXPORT
49 #endif // GCC_VISIBILITY
50 
51 #endif // _MSC_VER
52 
53 #if defined(_MSC_VER) && !defined(SWIG)
54 #ifdef IMPSAXSMERGE_EXPORTS
55 
56 #define IMPSAXSMERGE_EXPORT_TEMPLATE(name) \
57  template class __declspec(dllexport) name
58 
59 #else //EXPORTS
60 
61 #define IMPSAXSMERGE_EXPORT_TEMPLATE(name) \
62  template class __declspec(dllimport) name
63 
64 #endif // EXPORTS
65 
66 #else // MSC and SWIG
67 #define IMPSAXSMERGE_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
68 
69 #endif // MSC and SWIG
70 
71 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
72 
73 #define IMPSAXSMERGE_BEGIN_NAMESPACE \
74  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{namespace saxs_merge {
75 
76 #define IMPSAXSMERGE_END_NAMESPACE } } \
77 IMP_COMPILER_DISABLE_WARNINGS
78 
79 #define IMPSAXSMERGE_BEGIN_INTERNAL_NAMESPACE IMPSAXSMERGE_BEGIN_NAMESPACE \
80  namespace internal {
81 
82 #define IMPSAXSMERGE_END_INTERNAL_NAMESPACE } IMPSAXSMERGE_END_NAMESPACE
83 
84 #else // SWIG and DOXYGEN
85 #define IMPSAXSMERGE_BEGIN_NAMESPACE namespace IMP{namespace saxs_merge {
86 
87 #define IMPSAXSMERGE_END_NAMESPACE } }
88 
89 #define IMPSAXSMERGE_BEGIN_INTERNAL_NAMESPACE IMPSAXSMERGE_BEGIN_NAMESPACE\
90  namespace internal {
91 
92 #define IMPSAXSMERGE_END_INTERNAL_NAMESPACE } IMPSAXSMERGE_END_NAMESPACE
93 
94 #endif // SWIG AND DOXYGEN
95 
96 #define IMP_SAXS_MERGE_USE_IMP_ALGEBRA
97 #define IMP_SAXS_MERGE_HAS_IMP_ALGEBRA 1
98 #define IMP_SAXS_MERGE_USE_IMP_ATOM
99 #define IMP_SAXS_MERGE_HAS_IMP_ATOM 1
100 #define IMP_SAXS_MERGE_USE_IMP_BASE
101 #define IMP_SAXS_MERGE_HAS_IMP_BASE 1
102 #define IMP_SAXS_MERGE_USE_IMP_CGAL
103 #define IMP_SAXS_MERGE_HAS_IMP_CGAL 1
104 #define IMP_SAXS_MERGE_USE_IMP_CONTAINER
105 #define IMP_SAXS_MERGE_HAS_IMP_CONTAINER 1
106 #define IMP_SAXS_MERGE_USE_IMP_CORE
107 #define IMP_SAXS_MERGE_HAS_IMP_CORE 1
108 #define IMP_SAXS_MERGE_USE_IMP_DISPLAY
109 #define IMP_SAXS_MERGE_HAS_IMP_DISPLAY 1
110 #define IMP_SAXS_MERGE_USE_IMP_EM
111 #define IMP_SAXS_MERGE_HAS_IMP_EM 1
112 #define IMP_SAXS_MERGE_USE_IMP_KERNEL
113 #define IMP_SAXS_MERGE_HAS_IMP_KERNEL 1
114 #define IMP_SAXS_MERGE_USE_IMP_SCORE_FUNCTOR
115 #define IMP_SAXS_MERGE_HAS_IMP_SCORE_FUNCTOR 1
116 #define IMP_SAXS_MERGE_USE_IMP_STATISTICS
117 #define IMP_SAXS_MERGE_HAS_IMP_STATISTICS 1
118 #define IMP_SAXS_MERGE_USE_BOOST_FILESYSTEM
119 #define IMP_SAXS_MERGE_HAS_BOOST_FILESYSTEM 1
120 #define IMP_SAXS_MERGE_USE_BOOST_PROGRAMOPTIONS
121 #define IMP_SAXS_MERGE_HAS_BOOST_PROGRAMOPTIONS 1
122 #define IMP_SAXS_MERGE_USE_BOOST_RANDOM
123 #define IMP_SAXS_MERGE_HAS_BOOST_RANDOM 1
124 #define IMP_SAXS_MERGE_USE_BOOST_REGEX
125 #define IMP_SAXS_MERGE_HAS_BOOST_REGEX 1
126 #define IMP_SAXS_MERGE_USE_BOOST_SYSTEM
127 #define IMP_SAXS_MERGE_HAS_BOOST_SYSTEM 1
128 #define IMP_SAXS_MERGE_USE_CGAL
129 #define IMP_SAXS_MERGE_HAS_CGAL 1
130 #define IMP_SAXS_MERGE_USE_GSL
131 #define IMP_SAXS_MERGE_HAS_GSL 1
132 #define IMP_SAXS_MERGE_USE_HDF5
133 #define IMP_SAXS_MERGE_HAS_HDF5 1
134 
135 // functions are defined explicitly for SWIG
136 namespace IMP {
137  namespace saxs_merge {
138 /** \name Standard module functions
139  All \imp modules have a set of standard functions to help get information
140  about the module and about files associated with the module.
141  @{
142  */
143 #if !defined(SWIG)
144  IMPSAXSMERGEEXPORT std::string get_module_version();
145 #endif
146 
147 #if !defined(SWIG)
148  // SWIG will whine about duplicate definitions of function
149  inline std::string get_module_name() { return "IMP::saxs_merge"; }
150 #endif
151 
152  //! Return the full path to installed data
153  /** Each module has its own data directory, so be sure to use
154  the version of this function in the correct module. To read
155  the data file "data_library" that was placed in the \c data
156  directory of module "mymodule", do something like
157  \code
158  std::ifstream in(IMP::mymodule::get_data_path("data_library"));
159  \endcode
160  This will ensure that the code works when \imp is installed or
161  used via the \c setup_environment.sh script.
162  */
163 #if !defined(SWIG)
164  IMPSAXSMERGEEXPORT std::string get_data_path(std::string file_name);
165 #endif
166 
167  //! Return the path to installed example data for this module
168  /** Each module has its own example directory, so be sure to use
169  the version of this function in the correct module. For example
170  to read the file \c example_protein.pdb located in the
171  \c examples directory of the IMP::atom module, do
172  \code
173  IMP::atom::read_pdb(IMP::atom::get_example_path("example_protein.pdb",
174  model));
175  \endcode
176  This will ensure that the code works when \imp is installed or
177  used via the \c setup_environment.sh script.
178  */
179 #if !defined(SWIG)
180  IMPSAXSMERGEEXPORT std::string get_example_path(std::string file_name);
181 #endif
182  /** @} */
183 
184 
185  }
186 } //namespace
187 
188 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
189 
190 #include <IMP/base/Showable.h>
191 #include <IMP/base/hash.h>
192 
193 namespace IMP { namespace saxs_merge {
194 using ::IMP::base::Showable;
195 using ::IMP::base::operator<<;
196 using ::IMP::base::hash_value;
197 } } // namespace
198 namespace IMP { namespace saxs_merge { namespace internal {
199 using ::IMP::base::Showable;
200 using ::IMP::base::operator<<;
201 using ::IMP::base::hash_value;
202 } } } // namespace
203 
204 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
205 
206 
208 
209 #endif /* IMPSAXSMERGE_CONFIG_H */
210 
211 // Here so it is always parsed
212 
213 #ifdef IMPSAXSMERGE_DEPRECATED_HEADER
214 #undef IMPSAXSMERGE_DEPRECATED_HEADER
215 #undef IMPSAXSMERGE_DEPRECATED_VALUE_DEF
216 #undef IMPSAXSMERGE_DEPRECATED_VALUE_DECL
217 #undef IMPSAXSMERGE_DEPRECATED_OBJECT_DEF
218 #undef IMPSAXSMERGE_DEPRECATED_OBJECT_DECL
219 #undef IMPSAXSMERGE_DEPRECATED_FUNCTION_DEF
220 #undef IMPSAXSMERGE_DEPRECATED_FUNCTION_DECL
221 #undef IMPSAXSMERGE_DEPRECATED_METHOD_DEF
222 #undef IMPSAXSMERGE_DEPRECATED_METHOD_DECL
223 #undef IMPSAXSMERGE_DEPRECATED_MACRO
224 #undef IMPSAXSMERGE_SHOW_WARNINGS
225 #endif
226 
227 // the central modules we can update easily, so don't warn in them
228 #if defined( IMPSAXSMERGE_COMPILATION) \
229  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
230  || defined( IMPSAXSMERGE_ALL) || defined(IMP_DOXYGEN) \
231  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
232  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
233  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
234  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
235  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
236  || defined(IMPGSL_COMPILATION)
237 #define IMPSAXSMERGE_SHOW_WARNINGS 0
238 #else
239 #define IMPSAXSMERGE_SHOW_WARNINGS 1
240 #endif
241 
242 // suppress header warnings with all header, SWIG wrapper and in the module
243 #if IMPSAXSMERGE_SHOW_WARNINGS
244 #define IMPSAXSMERGE_DEPRECATED_HEADER(version, help_message) \
245  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
246 #define IMPSAXSMERGE_DEPRECATED_VALUE_DECL(version) \
247  IMP_DEPRECATED_ATTRIBUTE
248 #define IMPSAXSMERGE_DEPRECATED_OBJECT_DECL(version) \
249  IMP_DEPRECATED_ATTRIBUTE
250 #define IMPSAXSMERGE_DEPRECATED_FUNCTION_DECL(version) \
251  IMP_DEPRECATED_ATTRIBUTE
252 #define IMPSAXSMERGE_DEPRECATED_METHOD_DECL(version) \
253  IMP_DEPRECATED_ATTRIBUTE
254 
255 #else //IMPSAXSMERGE_SHOW_WARNINGS
256 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
257 #define IMPSAXSMERGE_DEPRECATED_HEADER(version, help_message) \
258 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
259 #define IMPSAXSMERGE_DEPRECATED_VALUE_DECL(version)
260 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
261 #define IMPSAXSMERGE_DEPRECATED_OBJECT_DECL(version)
262 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
263 #define IMPSAXSMERGE_DEPRECATED_FUNCTION_DECL(version)
264 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
265 #define IMPSAXSMERGE_DEPRECATED_METHOD_DECL(version)
266 
267 #endif // IMPSAXSMERGE_SHOW_WARNINGS
268 
269 // only warn about it in the all inclusion to cut down on copies
270 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
271  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
272  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
273  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
274  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
275  || defined(IMPSCOREFUNCTOR_COMPILATION)
276 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
277 #define IMPSAXSMERGE_DEPRECATED_MACRO(version, message)
278 
279 #else
280 #define IMPSAXSMERGE_DEPRECATED_MACRO(version, message) \
281  IMP_DEPRECATED_MACRO(version, message)
282 #endif
283 
284 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
285 #define IMPSAXSMERGE_DEPRECATED_VALUE_DEF(version, message) \
286  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
287 
288 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
289 #define IMPSAXSMERGE_DEPRECATED_OBJECT_DEF(version, message) \
290  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
291 
292 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
293 #define IMPSAXSMERGE_DEPRECATED_FUNCTION_DEF(version, message) \
294  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
295 
296 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
297 #define IMPSAXSMERGE_DEPRECATED_METHOD_DEF(version, message) \
298  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
299 
300 
302 
303 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
304 IMP_COMPILER_ENABLE_WARNINGS
305 #define IMP_EXECUTABLE_WARNINGS
306 #endif
IO support.
IO support.
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.