misc_config.h

/*
 * \file IMP/misc/misc_config.h
 * \brief Provide macros to mark functions and classes as exported
 *        from a DLL/.so, and to set up namespaces
 *
 * When building the module, IMPMISC_EXPORTS should be defined, and when
 * using the module externally, it should not be. Classes and functions
 * declared in the module's headers should then be marked with
 * IMPMISCEXPORT if they are intended to be part of the API and
 * they are not defined entirely in a header.
 *
 * The Windows build environment requires applications to mark exports in
 * this way; we use the same markings to set the visibility of ELF symbols
 * if we have compiler support.
 *
 * All code in this module should live in the IMP::misc namespace.
 * This is simply achieved by wrapping things with the
 * IMPMISC_BEGIN_NAMESPACE and IMPMISC_END_NAMESPACE macros.
 * There are similar macros for module code that is designed to be for
 * internal use only.
 *
 * This header is auto-generated by tools/build/setup_module.py;
 * it should not be edited manually.
 *
 * Copyright 2007-2013 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPMISC_CONFIG_H
#define IMPMISC_CONFIG_H

#include <IMP/base/base_config.h>
#include <string>


#ifdef _MSC_VER

#ifdef IMPMISC_EXPORTS
#define IMPMISCEXPORT __declspec(dllexport)
#else // EXPORTS
#define IMPMISCEXPORT __declspec(dllimport)
#endif // EXPORTS

#else // _MSC_VER

#ifdef GCC_VISIBILITY
#define IMPMISCEXPORT __attribute__ ((visibility("default")))
#else // GCC_VISIBILITY
#define IMPMISCEXPORT
#endif // GCC_VISIBILITY
#endif // _MSC_VER

#if defined(_MSC_VER) && !defined(SWIG)
#ifdef IMPMISC_EXPORTS

#define IMPMISC_EXPORT_TEMPLATE(name)                 template class __declspec(dllexport) name

#else //EXPORTS

#define IMPMISC_EXPORT_TEMPLATE(name)                 template class __declspec(dllimport) name

#endif // EXPORTS

#else // MSC and SWIG
#define IMPMISC_EXPORT_TEMPLATE(name) IMP_REQUIRE_SEMICOLON_NAMESPACE

#endif // MSC and SWIG

#if !defined(SWIG) && !defined(IMP_DOXYGEN)

#define IMPMISC_BEGIN_NAMESPACE \
IMP_COMPILER_ENABLE_WARNINGS \
namespace IMP { namespace misc { \

#define IMPMISC_END_NAMESPACE \
} } \
IMP_COMPILER_DISABLE_WARNINGS

#define IMPMISC_BEGIN_INTERNAL_NAMESPACE \
IMPMISC_BEGIN_NAMESPACE namespace internal {


#define IMPMISC_END_INTERNAL_NAMESPACE \
} IMPMISC_END_NAMESPACE

#else
#define IMPMISC_BEGIN_NAMESPACE \
namespace IMP { namespace misc {

#define IMPMISC_END_NAMESPACE \
} }

#define IMPMISC_BEGIN_INTERNAL_NAMESPACE \
IMPMISC_BEGIN_NAMESPACE namespace internal {


#define IMPMISC_END_INTERNAL_NAMESPACE \
} IMPMISC_END_NAMESPACE

#endif

#define IMP_MISC_USE_IMP_ALGEBRA
#define IMP_MISC_HAS_IMP_ALGEBRA 1
#define IMP_MISC_USE_IMP_BASE
#define IMP_MISC_HAS_IMP_BASE 1
#define IMP_MISC_USE_IMP_CGAL
#define IMP_MISC_HAS_IMP_CGAL 1
#define IMP_MISC_USE_IMP_CONTAINER
#define IMP_MISC_HAS_IMP_CONTAINER 1
#define IMP_MISC_USE_IMP_DISPLAY
#define IMP_MISC_HAS_IMP_DISPLAY 1
#define IMP_MISC_USE_IMP_KERNEL
#define IMP_MISC_HAS_IMP_KERNEL 1
#define IMP_MISC_USE_IMP_SCORE_FUNCTOR
#define IMP_MISC_HAS_IMP_SCORE_FUNCTOR 1
#define IMP_MISC_USE_BOOST_FILESYSTEM
#define IMP_MISC_HAS_BOOST_FILESYSTEM 1
#define IMP_MISC_USE_BOOST_PROGRAMOPTIONS
#define IMP_MISC_HAS_BOOST_PROGRAMOPTIONS 1
#define IMP_MISC_USE_BOOST_RANDOM
#define IMP_MISC_HAS_BOOST_RANDOM 1
#define IMP_MISC_USE_BOOST_REGEX
#define IMP_MISC_HAS_BOOST_REGEX 1
#define IMP_MISC_USE_BOOST_SYSTEM
#define IMP_MISC_HAS_BOOST_SYSTEM 1
#define IMP_MISC_USE_CGAL
#define IMP_MISC_HAS_CGAL 1

//  functions are defined explicitly for swig

namespace IMP { namespace misc {
/** \name Standard module methods
  All \imp modules have a set of standard methods to help get information
  about the module and about files associated with the module.
  @{
  */
#if !defined(SWIG)
IMPMISCEXPORT std::string get_module_version();
#endif

#if !defined(SWIG)
// swig will whine about duplicate definitions of function
inline std::string get_module_name() {
   return "IMP::misc";
}
#endif

} } //namespace

#if !defined(IMP_DOXYGEN) && !defined(SWIG)

#include <IMP/base/Showable.h>
#include <IMP/base/hash.h>

namespace IMP { namespace misc {
using ::IMP::base::Showable;
using ::IMP::base::operator<<;
using ::IMP::base::hash_value;
} } // namespace
namespace IMP { namespace misc { namespace internal {
using ::IMP::base::Showable;
using ::IMP::base::operator<<;
using ::IMP::base::hash_value;
} } } // namespace

#endif // !defined(SWIG) && !defined(IMP_DOXYGEN)


#if !defined(SWIG)

namespace IMP { namespace misc {

//! Return the full path to installed data
/** Each module has its own data directory, so be sure to use
    the version of this function in the correct module. To read
    the data file "data_library" that was placed in the \c data
    directory of module "mymodule", do something like
    \code
    std::ifstream in(IMP::mymodule::get_data_path("data_library"));
    \endcode
    This will ensure that the code works when \imp is installed or
    used via the \c tools/imppy.sh script.
*/
IMPMISCEXPORT std::string get_data_path(std::string file_name);

//! Return the path to installed example data for this module
/** Each module has its own example directory, so be sure to use
    the version of this function in the correct module.  For example
    to read the file \c example_protein.pdb located in the
    \c examples directory of the IMP::atom module, do
    \code
    IMP::atom::read_pdb(IMP::atom::get_example_path("example_protein.pdb", model));
    \endcode
    This will ensure that the code works when \imp is installed or
    used via the \c tools/imppy.sh script.
*/
IMPMISCEXPORT std::string get_example_path(std::string file_name);
/** @} */


} } // namespace

#endif // SWIG

#include <IMP/base/compiler_macros.h>

#ifdef IMP_DOXYGEN
/** \namespace IMP::misc
    \brief See \ref IMP_misc_overview "IMP.misc Overview" for more information.
    */
#endif

#endif  /* IMPMISC_CONFIG_H */