IMP  2.1.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-2013 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 
109  // functions are defined explicitly for SWIG
110  namespace IMP {
111  namespace score_functor {
112 /** \name Standard module methods
113  All \imp modules have a set of standard methods to help get information
114  about the module and about files associated with the module.
115  @{
116  */
117 #if !defined(SWIG)
118  IMPSCOREFUNCTOREXPORT std::string get_module_version();
119 #endif
120 
121 #if !defined(SWIG)
122  // SWIG will whine about duplicate definitions of function
123  inline std::string get_module_name() { return "IMP::score_functor"; }
124 #endif
125 
126  }
127 } //namespace
128 
129 #if !defined(IMP_DOXYGEN) && !defined(SWIG)
130 
131 #include <IMP/base/Showable.h>
132 #include <IMP/base/hash.h>
133 
134 namespace IMP { namespace score_functor {
135 using ::IMP::base::Showable;
136 using ::IMP::base::operator<<;
137 using ::IMP::base::hash_value;
138 } } // namespace
139 namespace IMP { namespace score_functor { namespace internal {
140 using ::IMP::base::Showable;
141 using ::IMP::base::operator<<;
142 using ::IMP::base::hash_value;
143 } } } // namespace
144 
145 #endif // !defined(SWIG) && !defined(IMP_DOXYGEN)
146 
147 
148 #if !defined(SWIG)
149  namespace IMP {
150  namespace score_functor {
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  IMPSCOREFUNCTOREXPORT std::string get_data_path(std::string file_name);
164 
165  //! Return the path to installed example data for this module
166  /** Each module has its own example directory, so be sure to use
167  the version of this function in the correct module. For example
168  to read the file \c example_protein.pdb located in the
169  \c examples directory of the IMP::atom module, do
170  \code
171  IMP::atom::read_pdb(IMP::atom::get_example_path("example_protein.pdb",
172  model));
173  \endcode
174  This will ensure that the code works when \imp is installed or
175  used via the \c setup_environment.sh script.
176  */
177  IMPSCOREFUNCTOREXPORT std::string get_example_path(std::string file_name);
178  /** @} */
179 
180  }
181 } // namespace
182 
183 #endif // SWIG
184 
185 #include <IMP/base/compiler_macros.h>
186 
187 #ifdef IMP_DOXYGEN
188 /** \namespace IMP::score_functor
189  \brief See [IMP.score_functor](\ref impscore_functor) for more information.
190  */
191 #endif
192 
193 #endif /* IMPSCOREFUNCTOR_CONFIG_H */
194 
195 // Here so it is always parsed
196 
197 #ifdef IMPSCOREFUNCTOR_DEPRECATED_HEADER
198 #undef IMPSCOREFUNCTOR_DEPRECATED_HEADER
199 #undef IMPSCOREFUNCTOR_DEPRECATED_VALUE_DEF
200 #undef IMPSCOREFUNCTOR_DEPRECATED_VALUE_DECL
201 #undef IMPSCOREFUNCTOR_DEPRECATED_OBJECT_DEF
202 #undef IMPSCOREFUNCTOR_DEPRECATED_OBJECT_DECL
203 #undef IMPSCOREFUNCTOR_DEPRECATED_FUNCTION_DEF
204 #undef IMPSCOREFUNCTOR_DEPRECATED_FUNCTION_DECL
205 #undef IMPSCOREFUNCTOR_DEPRECATED_METHOD_DEF
206 #undef IMPSCOREFUNCTOR_DEPRECATED_METHOD_DECL
207 #undef IMPSCOREFUNCTOR_DEPRECATED_MACRO
208 #undef IMPSCOREFUNCTOR_SHOW_WARNINGS
209 #endif
210 
211 // the central modules we can update easily, so don't warn in them
212 #if defined( IMPSCOREFUNCTOR_COMPILATION) \
213  || defined(SWIG) || defined(IMP_SWIG_WRAPPER) \
214  || defined( IMPSCOREFUNCTOR_ALL) || defined(IMP_DOXYGEN) \
215  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
216  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
217  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
218  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
219  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
220  || defined(IMPGSL_COMPILATION)
221 #define IMPSCOREFUNCTOR_SHOW_WARNINGS 0
222 #else
223 #define IMPSCOREFUNCTOR_SHOW_WARNINGS 1
224 #endif
225 
226 // suppress header warnings with all header, SWIG wrapper and in the module
227 #if IMPSCOREFUNCTOR_SHOW_WARNINGS
228 #define IMPSCOREFUNCTOR_DEPRECATED_HEADER(version, help_message) \
229  IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
230 #define IMPSCOREFUNCTOR_DEPRECATED_VALUE_DECL(version) \
231  IMP_DEPRECATED_ATTRIBUTE
232 #define IMPSCOREFUNCTOR_DEPRECATED_OBJECT_DECL(version) \
233  IMP_DEPRECATED_ATTRIBUTE
234 #define IMPSCOREFUNCTOR_DEPRECATED_FUNCTION_DECL(version) \
235  IMP_DEPRECATED_ATTRIBUTE
236 #define IMPSCOREFUNCTOR_DEPRECATED_METHOD_DECL(version) \
237  IMP_DEPRECATED_ATTRIBUTE
238 
239 #else //IMPSCOREFUNCTOR_SHOW_WARNINGS
240 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
241 #define IMPSCOREFUNCTOR_DEPRECATED_HEADER(version, help_message) \
242 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
243 #define IMPSCOREFUNCTOR_DEPRECATED_VALUE_DECL(version)
244 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
245 #define IMPSCOREFUNCTOR_DEPRECATED_OBJECT_DECL(version)
246 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
247 #define IMPSCOREFUNCTOR_DEPRECATED_FUNCTION_DECL(version)
248 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
249 #define IMPSCOREFUNCTOR_DEPRECATED_METHOD_DECL(version)
250 
251 #endif // IMPSCOREFUNCTOR_SHOW_WARNINGS
252 
253 // only warn about it in the all inclusion to cut down on copies
254 #if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN) \
255  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION) \
256  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION) \
257  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
258  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
259  || defined(IMPSCOREFUNCTOR_COMPILATION)
260 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
261 #define IMPSCOREFUNCTOR_DEPRECATED_MACRO(version, message)
262 
263 #else
264 #define IMPSCOREFUNCTOR_DEPRECATED_MACRO(version, message) \
265  IMP_DEPRECATED_MACRO(version, message)
266 #endif
267 
268 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
269 #define IMPSCOREFUNCTOR_DEPRECATED_VALUE_DEF(version, message) \
270  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)
271 
272 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
273 #define IMPSCOREFUNCTOR_DEPRECATED_OBJECT_DEF(version, message) \
274  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)
275 
276 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
277 #define IMPSCOREFUNCTOR_DEPRECATED_FUNCTION_DEF(version, message) \
278  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)
279 
280 /** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
281 #define IMPSCOREFUNCTOR_DEPRECATED_METHOD_DEF(version, message) \
282  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)
283 
284 
285 #include <IMP/base/compiler_macros.h>
286 
287 #if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
288 IMP_COMPILER_ENABLE_WARNINGS
289 #define IMP_EXECUTABLE_WARNINGS
290 #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.