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