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