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