IMP  2.2.0
The Integrative Modeling Platform
score_functor_config.h
1 /*
2  * \file IMP/score_functor/score_functor_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, IMPSCOREFUNCTOR_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  * IMPSCOREFUNCTOREXPORT 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::score_functor namespace.
17  * This is simply achieved by wrapping things with the
18  * IMPSCOREFUNCTOR_BEGIN_NAMESPACE and IMPSCOREFUNCTOR_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 IMPSCOREFUNCTOR_CONFIG_H
30 #define IMPSCOREFUNCTOR_CONFIG_H
31 
32 #include <IMP/base/base_config.h>
33 #include <string>
34 
35 #ifdef _MSC_VER
36 
37 #ifdef IMPSCOREFUNCTOR_EXPORTS
38 #define IMPSCOREFUNCTOREXPORT __declspec(dllexport)
39 #else // EXPORTS
40 #define IMPSCOREFUNCTOREXPORT __declspec(dllimport)
41 #endif // EXPORTS
42 
43 #else // _MSC_VER
44 
45 #ifdef GCC_VISIBILITY
46 #define IMPSCOREFUNCTOREXPORT __attribute__((visibility("default")))
47 #else // GCC_VISIBILITY
48 #define IMPSCOREFUNCTOREXPORT
49 #endif // GCC_VISIBILITY
50 
51 #endif // _MSC_VER
52 
53 #if defined(_MSC_VER) && !defined(SWIG)
54 #ifdef IMPSCOREFUNCTOR_EXPORTS
55 
56 #define IMPSCOREFUNCTOR_EXPORT_TEMPLATE(name) \
57  template class __declspec(dllexport) name
58 
59 #else //EXPORTS
60 
61 #define IMPSCOREFUNCTOR_EXPORT_TEMPLATE(name) \
62  template class __declspec(dllimport) name
63 
64 #endif // EXPORTS
65 
66 #else // MSC and SWIG
67 #define IMPSCOREFUNCTOR_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE
68 
69 #endif // MSC and SWIG
70 
71 #if !defined(SWIG) && !defined(IMP_DOXYGEN)
72 
73 #define IMPSCOREFUNCTOR_BEGIN_NAMESPACE \
74  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{namespace score_functor {
75 
76 #define IMPSCOREFUNCTOR_END_NAMESPACE } } \
77 IMP_COMPILER_DISABLE_WARNINGS
78 
79 #define IMPSCOREFUNCTOR_BEGIN_INTERNAL_NAMESPACE IMPSCOREFUNCTOR_BEGIN_NAMESPACE \
80  namespace internal {
81 
82 #define IMPSCOREFUNCTOR_END_INTERNAL_NAMESPACE } IMPSCOREFUNCTOR_END_NAMESPACE
83 
84 #else // SWIG and DOXYGEN
85 #define IMPSCOREFUNCTOR_BEGIN_NAMESPACE namespace IMP{namespace score_functor {
86 
87 #define IMPSCOREFUNCTOR_END_NAMESPACE } }
88 
89 #define IMPSCOREFUNCTOR_BEGIN_INTERNAL_NAMESPACE IMPSCOREFUNCTOR_BEGIN_NAMESPACE\
90  namespace internal {
91 
92 #define IMPSCOREFUNCTOR_END_INTERNAL_NAMESPACE } IMPSCOREFUNCTOR_END_NAMESPACE
93 
94 #endif // SWIG AND DOXYGEN
95 
96 #define IMP_SCORE_FUNCTOR_USE_IMP_CGAL
97 #define IMP_SCORE_FUNCTOR_HAS_IMP_CGAL 1
98 #define IMP_SCORE_FUNCTOR_USE_BOOST_FILESYSTEM
99 #define IMP_SCORE_FUNCTOR_HAS_BOOST_FILESYSTEM 1
100 #define IMP_SCORE_FUNCTOR_USE_BOOST_PROGRAMOPTIONS
101 #define IMP_SCORE_FUNCTOR_HAS_BOOST_PROGRAMOPTIONS 1
102 #define IMP_SCORE_FUNCTOR_USE_BOOST_RANDOM
103 #define IMP_SCORE_FUNCTOR_HAS_BOOST_RANDOM 1
104 #define IMP_SCORE_FUNCTOR_USE_BOOST_SYSTEM
105 #define IMP_SCORE_FUNCTOR_HAS_BOOST_SYSTEM 1
106 #define IMP_SCORE_FUNCTOR_USE_CGAL
107 #define IMP_SCORE_FUNCTOR_HAS_CGAL 1
108 #define IMP_SCORE_FUNCTOR_USE_HDF5
109 #define IMP_SCORE_FUNCTOR_HAS_HDF5 1
110 
111  // functions are defined explicitly for SWIG
112  namespace IMP {
113  namespace score_functor {
114 /** \name Standard module methods
115  All \imp modules have a set of standard methods to help get information
116  about the module and about files associated with the module.
117  @{
118  */
119 #if !defined(SWIG)
120  IMPSCOREFUNCTOREXPORT 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::score_functor"; }
126 #endif
127 
128  }
129 } //namespace
130 
131 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
132 
133 #include <IMP/base/Showable.h>
134 #include <IMP/base/hash.h>
135 
136 namespace IMP { namespace score_functor {
137 using ::IMP::base::Showable;
138 using ::IMP::base::operator<<;
139 using ::IMP::base::hash_value;
140 } } // namespace
141 namespace IMP { namespace score_functor { namespace internal {
142 using ::IMP::base::Showable;
143 using ::IMP::base::operator<<;
144 using ::IMP::base::hash_value;
145 } } } // namespace
146 
147 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
148 
149 
150 #if !defined(SWIG)
151  namespace IMP {
152  namespace score_functor {
153 
154  //! Return the full path to installed data
155  /** Each module has its own data directory, so be sure to use
156  the version of this function in the correct module. To read
157  the data file "data_library" that was placed in the \c data
158  directory of module "mymodule", do something like
159  \code
160  std::ifstream in(IMP::mymodule::get_data_path("data_library"));
161  \endcode
162  This will ensure that the code works when \imp is installed or
163  used via the \c setup_environment.sh script.
164  */
165  IMPSCOREFUNCTOREXPORT std::string get_data_path(std::string file_name);
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  IMPSCOREFUNCTOREXPORT std::string get_example_path(std::string file_name);
180  /** @} */
181 
182  }
183 } // namespace
184 
185 #endif // SWIG
186 
187 #include <IMP/base/compiler_macros.h>
188 
189 #ifdef IMP_DOXYGEN
190 /** \namespace IMP::score_functor
191  \brief See [IMP.score_functor](\ref impscore_functor) for more information.
192  */
193 #endif
194 
195 #endif /* IMPSCOREFUNCTOR_CONFIG_H */
196 
197 // Here so it is always parsed
198 
199 #ifdef IMPSCOREFUNCTOR_DEPRECATED_HEADER
200 #undef IMPSCOREFUNCTOR_DEPRECATED_HEADER
201 #undef IMPSCOREFUNCTOR_DEPRECATED_VALUE_DEF
202 #undef IMPSCOREFUNCTOR_DEPRECATED_VALUE_DECL
203 #undef IMPSCOREFUNCTOR_DEPRECATED_OBJECT_DEF
204 #undef IMPSCOREFUNCTOR_DEPRECATED_OBJECT_DECL
205 #undef IMPSCOREFUNCTOR_DEPRECATED_FUNCTION_DEF
206 #undef IMPSCOREFUNCTOR_DEPRECATED_FUNCTION_DECL
207 #undef IMPSCOREFUNCTOR_DEPRECATED_METHOD_DEF
208 #undef IMPSCOREFUNCTOR_DEPRECATED_METHOD_DECL
209 #undef IMPSCOREFUNCTOR_DEPRECATED_MACRO
210 #undef IMPSCOREFUNCTOR_SHOW_WARNINGS
211 #endif
212 
213 // the central modules we can update easily, so don't warn in them
214 #if defined( IMPSCOREFUNCTOR_COMPILATION) \
215  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
216  || defined( IMPSCOREFUNCTOR_ALL) || defined(IMP_DOXYGEN) \
217  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
218  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
219  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
220  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
221  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
222  || defined(IMPGSL_COMPILATION)
223 #define IMPSCOREFUNCTOR_SHOW_WARNINGS 0
224 #else
225 #define IMPSCOREFUNCTOR_SHOW_WARNINGS 1
226 #endif
227 
228 // suppress header warnings with all header, SWIG wrapper and in the module
229 #if IMPSCOREFUNCTOR_SHOW_WARNINGS
230 #define IMPSCOREFUNCTOR_DEPRECATED_HEADER(version, help_message) \
231  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
232 #define IMPSCOREFUNCTOR_DEPRECATED_VALUE_DECL(version) \
233  IMP_DEPRECATED_ATTRIBUTE
234 #define IMPSCOREFUNCTOR_DEPRECATED_OBJECT_DECL(version) \
235  IMP_DEPRECATED_ATTRIBUTE
236 #define IMPSCOREFUNCTOR_DEPRECATED_FUNCTION_DECL(version) \
237  IMP_DEPRECATED_ATTRIBUTE
238 #define IMPSCOREFUNCTOR_DEPRECATED_METHOD_DECL(version) \
239  IMP_DEPRECATED_ATTRIBUTE
240 
241 #else //IMPSCOREFUNCTOR_SHOW_WARNINGS
242 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
243 #define IMPSCOREFUNCTOR_DEPRECATED_HEADER(version, help_message) \
244 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
245 #define IMPSCOREFUNCTOR_DEPRECATED_VALUE_DECL(version)
246 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
247 #define IMPSCOREFUNCTOR_DEPRECATED_OBJECT_DECL(version)
248 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
249 #define IMPSCOREFUNCTOR_DEPRECATED_FUNCTION_DECL(version)
250 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
251 #define IMPSCOREFUNCTOR_DEPRECATED_METHOD_DECL(version)
252 
253 #endif // IMPSCOREFUNCTOR_SHOW_WARNINGS
254 
255 // only warn about it in the all inclusion to cut down on copies
256 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
257  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
258  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
259  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
260  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
261  || defined(IMPSCOREFUNCTOR_COMPILATION)
262 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
263 #define IMPSCOREFUNCTOR_DEPRECATED_MACRO(version, message)
264 
265 #else
266 #define IMPSCOREFUNCTOR_DEPRECATED_MACRO(version, message) \
267  IMP_DEPRECATED_MACRO(version, message)
268 #endif
269 
270 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
271 #define IMPSCOREFUNCTOR_DEPRECATED_VALUE_DEF(version, message) \
272  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
273 
274 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
275 #define IMPSCOREFUNCTOR_DEPRECATED_OBJECT_DEF(version, message) \
276  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
277 
278 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
279 #define IMPSCOREFUNCTOR_DEPRECATED_FUNCTION_DEF(version, message) \
280  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
281 
282 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
283 #define IMPSCOREFUNCTOR_DEPRECATED_METHOD_DEF(version, message) \
284  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
285 
286 
287 #include <IMP/base/compiler_macros.h>
288 
289 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
290 IMP_COMPILER_ENABLE_WARNINGS
291 #define IMP_EXECUTABLE_WARNINGS
292 #endif
compiler_macros.h
Various compiler workarounds.
hash.h
IO support.
IMP::score_functor::get_data_path
std::string get_data_path(std::string file_name)
Return the full path to installed data.
Showable.h
IO support.
IMP::score_functor::get_example_path
std::string get_example_path(std::string file_name)
Return the path to installed example data for this module.