IMP logo
IMP Reference Guide  2.14.0
The Integrative Modeling Platform
saxs_config.h
1 // Autogenerated by ../../../../tmp/nightly-build-16408/imp-2.14.0/tools/build/setup_module.py
2 // from ../../../../tmp/nightly-build-16408/imp-2.14.0/tools/build/config_templates/header.h
3 // Do not edit - any changes will be lost!
4 
5 /*
6  * \file IMP/saxs/saxs_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, IMPSAXS_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  * IMPSAXSEXPORT 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 namespace.
21  * This is simply achieved by wrapping things with the
22  * IMPSAXS_BEGIN_NAMESPACE and IMPSAXS_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-2020 IMP Inventors. All rights reserved.
27  *
28  */
29 
30 #ifndef IMPSAXS_CONFIG_H
31 #define IMPSAXS_CONFIG_H
32 
33 #include <IMP/kernel_config.h>
34 #include <string>
35 
36 #ifdef _MSC_VER
37 #define NOMINMAX
38 
39 #ifdef IMPSAXS_EXPORTS
40 #define IMPSAXSEXPORT __declspec(dllexport)
41 #else // EXPORTS
42 #define IMPSAXSEXPORT __declspec(dllimport)
43 #endif // EXPORTS
44 
45 #else // _MSC_VER
46 
47 #ifdef GCC_VISIBILITY
48 #define IMPSAXSEXPORT __attribute__((visibility("default")))
49 #else // GCC_VISIBILITY
50 #define IMPSAXSEXPORT
51 #endif // GCC_VISIBILITY
52 
53 #endif // _MSC_VER
54 
55 #if defined(_MSC_VER) && !defined(SWIG)
56 #ifdef IMPSAXS_EXPORTS
57 
58 #define IMPSAXS_EXPORT_TEMPLATE(name) \
59  template class __declspec(dllexport) name
60 
61 #else //EXPORTS
62 
63 #define IMPSAXS_EXPORT_TEMPLATE(name) \
64  template class __declspec(dllimport) name
65 
66 #endif // EXPORTS
67 
68 #else // MSC and SWIG
69 #define IMPSAXS_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
70 
71 #endif // MSC and SWIG
72 
73 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
74 
75 #define IMPSAXS_BEGIN_NAMESPACE \
76  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{ namespace saxs {
77 
78 #define IMPSAXS_END_NAMESPACE } } \
79 IMP_COMPILER_DISABLE_WARNINGS
80 
81 #define IMPSAXS_BEGIN_INTERNAL_NAMESPACE IMPSAXS_BEGIN_NAMESPACE \
82  namespace internal {
83 
84 #define IMPSAXS_END_INTERNAL_NAMESPACE } IMPSAXS_END_NAMESPACE
85 
86 #else // SWIG and DOXYGEN
87 #define IMPSAXS_BEGIN_NAMESPACE namespace IMP{ namespace saxs {
88 
89 #define IMPSAXS_END_NAMESPACE } }
90 
91 #define IMPSAXS_BEGIN_INTERNAL_NAMESPACE IMPSAXS_BEGIN_NAMESPACE\
92  namespace internal {
93 
94 #define IMPSAXS_END_INTERNAL_NAMESPACE } IMPSAXS_END_NAMESPACE
95 
96 #endif // SWIG AND DOXYGEN
97 
98 #define IMP_SAXS_USE_IMP_CGAL
99 #define IMP_SAXS_HAS_IMP_CGAL 1
100 #define IMP_SAXS_USE_IMP_CONTAINER
101 #define IMP_SAXS_HAS_IMP_CONTAINER 1
102 #define IMP_SAXS_USE_IMP_DISPLAY
103 #define IMP_SAXS_HAS_IMP_DISPLAY 1
104 #define IMP_SAXS_USE_IMP_KERNEL
105 #define IMP_SAXS_HAS_IMP_KERNEL 1
106 #define IMP_SAXS_USE_IMP_SCORE_FUNCTOR
107 #define IMP_SAXS_HAS_IMP_SCORE_FUNCTOR 1
108 #define IMP_SAXS_USE_BOOST_FILESYSTEM
109 #define IMP_SAXS_HAS_BOOST_FILESYSTEM 1
110 #define IMP_SAXS_USE_BOOST_PROGRAMOPTIONS
111 #define IMP_SAXS_HAS_BOOST_PROGRAMOPTIONS 1
112 #define IMP_SAXS_USE_BOOST_RANDOM
113 #define IMP_SAXS_HAS_BOOST_RANDOM 1
114 #define IMP_SAXS_USE_BOOST_REGEX
115 #define IMP_SAXS_HAS_BOOST_REGEX 1
116 #define IMP_SAXS_USE_BOOST_SYSTEM
117 #define IMP_SAXS_HAS_BOOST_SYSTEM 1
118 #define IMP_SAXS_USE_CGAL
119 #define IMP_SAXS_HAS_CGAL 1
120 #define IMP_SAXS_USE_HDF5
121 #define IMP_SAXS_HAS_HDF5 1
122 #define IMP_SAXS_USE_NUMPY
123 #define IMP_SAXS_HAS_NUMPY 1
124 #define IMP_SAXS_USE_PYTHON_IHM
125 #define IMP_SAXS_HAS_PYTHON_IHM 1
126 
127 // functions are defined explicitly for SWIG
128 namespace IMP{ namespace saxs {
129 /** \name Standard module functions
130  All \imp modules have a set of standard functions to help get information
131  about the module and about files associated with the module.
132  @{
133  */
134 #if !defined(SWIG)
135  IMPSAXSEXPORT std::string get_module_version();
136 #endif
137 
138 #if !defined(SWIG)
139  // SWIG will whine about duplicate definitions of function
140  inline std::string get_module_name() { return "IMP::saxs"; }
141 #endif
142 
143  //! Return the full path to one of this module's data files
144  /** To read the data file "data_library" that was placed in the \c data
145  directory of this module, do something like
146  \code
147  std::ifstream in(IMP::saxs::get_data_path("data_library"));
148  \endcode
149  This will ensure that the code works both when IMP is installed or
150  if used via the \c setup_environment.sh script.
151 
152  \note Each module has its own data directory, so be sure to use
153  this function from the correct module.
154  */
155 #if !defined(SWIG)
156  IMPSAXSEXPORT std::string get_data_path(std::string file_name);
157 #endif
158 
159  //! Return the full path to one of this module's example files
160  /** To read the example file "example_protein.pdb" that was placed
161  in the \c examples directory of this module, do something like
162  \code
163  std::ifstream in(IMP::saxs::get_example_path("example_protein.pdb"));
164  \endcode
165  This will ensure that the code works both when IMP is installed or
166  if used via the \c setup_environment.sh script.
167 
168  \note Each module has its own example directory, so be sure to use
169  this function from the correct module.
170  */
171 #if !defined(SWIG)
172  IMPSAXSEXPORT std::string get_example_path(std::string file_name);
173 #endif
174  /** @} */
175 
176 
177 } } //namespace
178 
179 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
180 
181 #include <IMP/Showable.h>
182 #include <IMP/hash.h>
183 
184 namespace IMP{ namespace saxs {
185 using ::IMP::Showable;
186 using ::IMP::operator<<;
187 using ::IMP::hash_value;
188 } } // namespace
189 namespace IMP{ namespace saxs { namespace internal {
190 using ::IMP::Showable;
191 using ::IMP::operator<<;
192 using ::IMP::hash_value;
193 } } } // namespace
194 
195 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
196 
197 
198 #include <IMP/compiler_macros.h>
199 
200 #endif /* IMPSAXS_CONFIG_H */
201 
202 // Here so it is always parsed
203 
204 #ifdef IMPSAXS_DEPRECATED_HEADER
205 #undef IMPSAXS_DEPRECATED_HEADER
206 #undef IMPSAXS_DEPRECATED_VALUE_DEF
207 #undef IMPSAXS_DEPRECATED_VALUE_DECL
208 #undef IMPSAXS_DEPRECATED_OBJECT_DEF
209 #undef IMPSAXS_DEPRECATED_OBJECT_DECL
210 #undef IMPSAXS_DEPRECATED_FUNCTION_DEF
211 #undef IMPSAXS_DEPRECATED_FUNCTION_DECL
212 #undef IMPSAXS_DEPRECATED_METHOD_DEF
213 #undef IMPSAXS_DEPRECATED_METHOD_DECL
214 #undef IMPSAXS_DEPRECATED_MACRO
215 #undef IMPSAXS_SHOW_WARNINGS
216 #endif
217 
218 // the central modules we can update easily, so don't warn in them
219 #if defined( IMPSAXS_COMPILATION) \
220  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
221  || defined( IMPSAXS_ALL) || defined(IMP_DOXYGEN) \
222  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
223  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
224  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
225  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
226  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
227  || defined(IMPGSL_COMPILATION)
228 #define IMPSAXS_SHOW_WARNINGS 0
229 #else
230 #define IMPSAXS_SHOW_WARNINGS 1
231 #endif
232 
233 // suppress header warnings with all header, SWIG wrapper and in the module
234 #if IMPSAXS_SHOW_WARNINGS
235 #define IMPSAXS_DEPRECATED_HEADER(version, help_message) \
236  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
237 #define IMPSAXS_DEPRECATED_VALUE_DECL(version) \
238  IMP_DEPRECATED_ATTRIBUTE
239 #define IMPSAXS_DEPRECATED_OBJECT_DECL(version) \
240  IMP_DEPRECATED_ATTRIBUTE
241 #define IMPSAXS_DEPRECATED_FUNCTION_DECL(version) \
242  IMP_DEPRECATED_ATTRIBUTE
243 #define IMPSAXS_DEPRECATED_METHOD_DECL(version) \
244  IMP_DEPRECATED_ATTRIBUTE
245 
246 #else //IMPSAXS_SHOW_WARNINGS
247 /** See [deprecation support](@ref deprecation). */
248 #define IMPSAXS_DEPRECATED_HEADER(version, help_message) \
249 /** See [deprecation support](@ref deprecation). */
250 #define IMPSAXS_DEPRECATED_VALUE_DECL(version)
251 /** See [deprecation support](@ref deprecation). */
252 #define IMPSAXS_DEPRECATED_OBJECT_DECL(version)
253 /** See [deprecation support](@ref deprecation). */
254 #define IMPSAXS_DEPRECATED_FUNCTION_DECL(version)
255 /** See [deprecation support](@ref deprecation). */
256 #define IMPSAXS_DEPRECATED_METHOD_DECL(version)
257 
258 #endif // IMPSAXS_SHOW_WARNINGS
259 
260 // only warn about it in the all inclusion to cut down on copies
261 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
262  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
263  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
264  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
265  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
266  || defined(IMPSCOREFUNCTOR_COMPILATION)
267 /** See [deprecation support](@ref deprecation). */
268 #define IMPSAXS_DEPRECATED_MACRO(version, message)
269 
270 #else
271 #define IMPSAXS_DEPRECATED_MACRO(version, message) \
272  IMP_DEPRECATED_MACRO(version, message)
273 #endif
274 
275 /** See [deprecation support](@ref deprecation). */
276 #define IMPSAXS_DEPRECATED_VALUE_DEF(version, message) \
277  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
278 
279 /** See [deprecation support](@ref deprecation). */
280 #define IMPSAXS_DEPRECATED_OBJECT_DEF(version, message) \
281  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
282 
283 /** See [deprecation support](@ref deprecation). */
284 #define IMPSAXS_DEPRECATED_FUNCTION_DEF(version, message) \
285  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
286 
287 /** See [deprecation support](@ref deprecation). */
288 #define IMPSAXS_DEPRECATED_METHOD_DEF(version, message) \
289  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
290 
291 
292 #include <IMP/compiler_macros.h>
293 
294 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
295 IMP_COMPILER_ENABLE_WARNINGS
296 #define IMP_EXECUTABLE_WARNINGS
297 #endif
std::string get_data_path(std::string file_name)
Return the full path to one of this module's data files.
IO support.
IO support.
std::string get_example_path(std::string file_name)
Return the full path to one of this module's example files.
Various compiler workarounds.
std::string get_module_version()
Return the version of this module, as a string.