IMP logo
IMP Reference Guide  2.6.0
The Integrative Modeling Platform
saxs_merge_config.h
1 // Autogenerated by ../../../../tmp/nightly-build-38828/imp-2.6.0/tools/build/setup_module.py
2 // from ../../../../tmp/nightly-build-38828/imp-2.6.0/tools/build/config_templates/header.h
3 // Do not edit - any changes will be lost!
4 
5 /*
6  * \file IMP/saxs_merge/saxs_merge_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, IMPSAXSMERGE_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  * IMPSAXSMERGEEXPORT 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::saxs_merge namespace.
21  * This is simply achieved by wrapping things with the
22  * IMPSAXSMERGE_BEGIN_NAMESPACE and IMPSAXSMERGE_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-2016 IMP Inventors. All rights reserved.
27  *
28  */
29 
30 #ifndef IMPSAXSMERGE_CONFIG_H
31 #define IMPSAXSMERGE_CONFIG_H
32 
33 #include <IMP/kernel_config.h>
34 #include <string>
35 
36 #ifdef _MSC_VER
37 #define NOMINMAX
38 
39 #ifdef IMPSAXSMERGE_EXPORTS
40 #define IMPSAXSMERGEEXPORT __declspec(dllexport)
41 #else // EXPORTS
42 #define IMPSAXSMERGEEXPORT __declspec(dllimport)
43 #endif // EXPORTS
44 
45 #else // _MSC_VER
46 
47 #ifdef GCC_VISIBILITY
48 #define IMPSAXSMERGEEXPORT __attribute__((visibility("default")))
49 #else // GCC_VISIBILITY
50 #define IMPSAXSMERGEEXPORT
51 #endif // GCC_VISIBILITY
52 
53 #endif // _MSC_VER
54 
55 #if defined(_MSC_VER) && !defined(SWIG)
56 #ifdef IMPSAXSMERGE_EXPORTS
57 
58 #define IMPSAXSMERGE_EXPORT_TEMPLATE(name) \
59  template class __declspec(dllexport) name
60 
61 #else //EXPORTS
62 
63 #define IMPSAXSMERGE_EXPORT_TEMPLATE(name) \
64  template class __declspec(dllimport) name
65 
66 #endif // EXPORTS
67 
68 #else // MSC and SWIG
69 #define IMPSAXSMERGE_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
70 
71 #endif // MSC and SWIG
72 
73 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
74 
75 #define IMPSAXSMERGE_BEGIN_NAMESPACE \
76  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{ namespace saxs_merge {
77 
78 #define IMPSAXSMERGE_END_NAMESPACE } } \
79 IMP_COMPILER_DISABLE_WARNINGS
80 
81 #define IMPSAXSMERGE_BEGIN_INTERNAL_NAMESPACE IMPSAXSMERGE_BEGIN_NAMESPACE \
82  namespace internal {
83 
84 #define IMPSAXSMERGE_END_INTERNAL_NAMESPACE } IMPSAXSMERGE_END_NAMESPACE
85 
86 #else // SWIG and DOXYGEN
87 #define IMPSAXSMERGE_BEGIN_NAMESPACE namespace IMP{ namespace saxs_merge {
88 
89 #define IMPSAXSMERGE_END_NAMESPACE } }
90 
91 #define IMPSAXSMERGE_BEGIN_INTERNAL_NAMESPACE IMPSAXSMERGE_BEGIN_NAMESPACE\
92  namespace internal {
93 
94 #define IMPSAXSMERGE_END_INTERNAL_NAMESPACE } IMPSAXSMERGE_END_NAMESPACE
95 
96 #endif // SWIG AND DOXYGEN
97 
98 #define IMP_SAXS_MERGE_USE_IMP_ALGEBRA
99 #define IMP_SAXS_MERGE_HAS_IMP_ALGEBRA 1
100 #define IMP_SAXS_MERGE_USE_IMP_ATOM
101 #define IMP_SAXS_MERGE_HAS_IMP_ATOM 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{ namespace saxs_merge {
137 /** \name Standard module functions
138  All \imp modules have a set of standard functions to help get information
139  about the module and about files associated with the module.
140  @{
141  */
142 #if !defined(SWIG)
143  IMPSAXSMERGEEXPORT std::string get_module_version();
144 #endif
145 
146 #if !defined(SWIG)
147  // SWIG will whine about duplicate definitions of function
148  inline std::string get_module_name() { return "IMP::saxs_merge"; }
149 #endif
150 
151  //! Return the full path to one of this module's data files
152  /** To read the data file "data_library" that was placed in the \c data
153  directory of this module, do something like
154  \code
155  std::ifstream in(IMP::saxs_merge::get_data_path("data_library"));
156  \endcode
157  This will ensure that the code works both when %IMP is installed or
158  if used via the \c setup_environment.sh script.
159 
160  \note Each module has its own data directory, so be sure to use
161  this function from the correct module.
162  */
163 #if !defined(SWIG)
164  IMPSAXSMERGEEXPORT std::string get_data_path(std::string file_name);
165 #endif
166 
167  //! Return the full path to one of this module's example files
168  /** To read the example file "example_protein.pdb" that was placed
169  in the \c examples directory of this module, do something like
170  \code
171  std::ifstream in(IMP::saxs_merge::get_example_path("example_protein.pdb"));
172  \endcode
173  This will ensure that the code works both when %IMP is installed or
174  if used via the \c setup_environment.sh script.
175 
176  \note Each module has its own example directory, so be sure to use
177  this function from the correct module.
178  */
179 #if !defined(SWIG)
180  IMPSAXSMERGEEXPORT std::string get_example_path(std::string file_name);
181 #endif
182  /** @} */
183 
184 
185 } } //namespace
186 
187 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
188 
189 #include <IMP/Showable.h>
190 #include <IMP/hash.h>
191 
192 namespace IMP{ namespace saxs_merge {
193 using ::IMP::Showable;
194 using ::IMP::operator<<;
195 using ::IMP::hash_value;
196 } } // namespace
197 namespace IMP{ namespace saxs_merge { namespace internal {
198 using ::IMP::Showable;
199 using ::IMP::operator<<;
200 using ::IMP::hash_value;
201 } } } // namespace
202 
203 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
204 
205 
206 #include <IMP/compiler_macros.h>
207 
208 #endif /* IMPSAXSMERGE_CONFIG_H */
209 
210 // Here so it is always parsed
211 
212 #ifdef IMPSAXSMERGE_DEPRECATED_HEADER
213 #undef IMPSAXSMERGE_DEPRECATED_HEADER
214 #undef IMPSAXSMERGE_DEPRECATED_VALUE_DEF
215 #undef IMPSAXSMERGE_DEPRECATED_VALUE_DECL
216 #undef IMPSAXSMERGE_DEPRECATED_OBJECT_DEF
217 #undef IMPSAXSMERGE_DEPRECATED_OBJECT_DECL
218 #undef IMPSAXSMERGE_DEPRECATED_FUNCTION_DEF
219 #undef IMPSAXSMERGE_DEPRECATED_FUNCTION_DECL
220 #undef IMPSAXSMERGE_DEPRECATED_METHOD_DEF
221 #undef IMPSAXSMERGE_DEPRECATED_METHOD_DECL
222 #undef IMPSAXSMERGE_DEPRECATED_MACRO
223 #undef IMPSAXSMERGE_SHOW_WARNINGS
224 #endif
225 
226 // the central modules we can update easily, so don't warn in them
227 #if defined( IMPSAXSMERGE_COMPILATION) \
228  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
229  || defined( IMPSAXSMERGE_ALL) || defined(IMP_DOXYGEN) \
230  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
231  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
232  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
233  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
234  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
235  || defined(IMPGSL_COMPILATION)
236 #define IMPSAXSMERGE_SHOW_WARNINGS 0
237 #else
238 #define IMPSAXSMERGE_SHOW_WARNINGS 1
239 #endif
240 
241 // suppress header warnings with all header, SWIG wrapper and in the module
242 #if IMPSAXSMERGE_SHOW_WARNINGS
243 #define IMPSAXSMERGE_DEPRECATED_HEADER(version, help_message) \
244  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
245 #define IMPSAXSMERGE_DEPRECATED_VALUE_DECL(version) \
246  IMP_DEPRECATED_ATTRIBUTE
247 #define IMPSAXSMERGE_DEPRECATED_OBJECT_DECL(version) \
248  IMP_DEPRECATED_ATTRIBUTE
249 #define IMPSAXSMERGE_DEPRECATED_FUNCTION_DECL(version) \
250  IMP_DEPRECATED_ATTRIBUTE
251 #define IMPSAXSMERGE_DEPRECATED_METHOD_DECL(version) \
252  IMP_DEPRECATED_ATTRIBUTE
253 
254 #else //IMPSAXSMERGE_SHOW_WARNINGS
255 /** See [deprecation support](@ref deprecation). */
256 #define IMPSAXSMERGE_DEPRECATED_HEADER(version, help_message) \
257 /** See [deprecation support](@ref deprecation). */
258 #define IMPSAXSMERGE_DEPRECATED_VALUE_DECL(version)
259 /** See [deprecation support](@ref deprecation). */
260 #define IMPSAXSMERGE_DEPRECATED_OBJECT_DECL(version)
261 /** See [deprecation support](@ref deprecation). */
262 #define IMPSAXSMERGE_DEPRECATED_FUNCTION_DECL(version)
263 /** See [deprecation support](@ref deprecation). */
264 #define IMPSAXSMERGE_DEPRECATED_METHOD_DECL(version)
265 
266 #endif // IMPSAXSMERGE_SHOW_WARNINGS
267 
268 // only warn about it in the all inclusion to cut down on copies
269 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
270  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
271  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
272  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
273  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
274  || defined(IMPSCOREFUNCTOR_COMPILATION)
275 /** See [deprecation support](@ref deprecation). */
276 #define IMPSAXSMERGE_DEPRECATED_MACRO(version, message)
277 
278 #else
279 #define IMPSAXSMERGE_DEPRECATED_MACRO(version, message) \
280  IMP_DEPRECATED_MACRO(version, message)
281 #endif
282 
283 /** See [deprecation support](@ref deprecation). */
284 #define IMPSAXSMERGE_DEPRECATED_VALUE_DEF(version, message) \
285  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
286 
287 /** See [deprecation support](@ref deprecation). */
288 #define IMPSAXSMERGE_DEPRECATED_OBJECT_DEF(version, message) \
289  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
290 
291 /** See [deprecation support](@ref deprecation). */
292 #define IMPSAXSMERGE_DEPRECATED_FUNCTION_DEF(version, message) \
293  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
294 
295 /** See [deprecation support](@ref deprecation). */
296 #define IMPSAXSMERGE_DEPRECATED_METHOD_DEF(version, message) \
297  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
298 
299 
300 #include <IMP/compiler_macros.h>
301 
302 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
303 IMP_COMPILER_ENABLE_WARNINGS
304 #define IMP_EXECUTABLE_WARNINGS
305 #endif
hash.h
IO support.
Showable.h
IO support.
IMP::saxs_merge::get_data_path
std::string get_data_path(std::string file_name)
Return the full path to one of this module's data files.
compiler_macros.h
Various compiler workarounds.
IMP::saxs_merge::get_example_path
std::string get_example_path(std::string file_name)
Return the full path to one of this module's example files.