scratch_config.h

/*
 * \file IMP/scratch/scratch_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, IMPSCRATCH_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
 * IMPSCRATCHEXPORT 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::scratch namespace.
 * This is simply achieved by wrapping things with the
 * IMPSCRATCH_BEGIN_NAMESPACE and IMPSCRATCH_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-2014 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPSCRATCH_CONFIG_H
#define IMPSCRATCH_CONFIG_H

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

#ifdef _MSC_VER

#ifdef IMPSCRATCH_EXPORTS
#define IMPSCRATCHEXPORT __declspec(dllexport)
#else  // EXPORTS
#define IMPSCRATCHEXPORT __declspec(dllimport)
#endif  // EXPORTS

#else  // _MSC_VER

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

#endif  // _MSC_VER

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

#define IMPSCRATCH_EXPORT_TEMPLATE(name)     \
  template class __declspec(dllexport) name

#else  //EXPORTS

#define IMPSCRATCH_EXPORT_TEMPLATE(name)     \
  template class __declspec(dllimport) name

#endif  // EXPORTS

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

#endif  // MSC and SWIG

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

#define IMPSCRATCH_BEGIN_NAMESPACE \
  IMP_COMPILER_ENABLE_WARNINGS namespace IMP{namespace scratch {

#define IMPSCRATCH_END_NAMESPACE } } \
IMP_COMPILER_DISABLE_WARNINGS

#define IMPSCRATCH_BEGIN_INTERNAL_NAMESPACE IMPSCRATCH_BEGIN_NAMESPACE \
  namespace internal {

#define IMPSCRATCH_END_INTERNAL_NAMESPACE } IMPSCRATCH_END_NAMESPACE

#else  // SWIG and DOXYGEN
#define IMPSCRATCH_BEGIN_NAMESPACE namespace IMP{namespace scratch {

#define IMPSCRATCH_END_NAMESPACE } }

#define IMPSCRATCH_BEGIN_INTERNAL_NAMESPACE IMPSCRATCH_BEGIN_NAMESPACE\
  namespace internal {

#define IMPSCRATCH_END_INTERNAL_NAMESPACE } IMPSCRATCH_END_NAMESPACE

#endif  // SWIG AND DOXYGEN

#define IMP_SCRATCH_USE_IMP_ALGEBRA
#define IMP_SCRATCH_HAS_IMP_ALGEBRA 1
#define IMP_SCRATCH_USE_IMP_BASE
#define IMP_SCRATCH_HAS_IMP_BASE 1
#define IMP_SCRATCH_USE_IMP_CGAL
#define IMP_SCRATCH_HAS_IMP_CGAL 1
#define IMP_SCRATCH_USE_IMP_DISPLAY
#define IMP_SCRATCH_HAS_IMP_DISPLAY 1
#define IMP_SCRATCH_USE_IMP_KERNEL
#define IMP_SCRATCH_HAS_IMP_KERNEL 1
#define IMP_SCRATCH_USE_IMP_SCORE_FUNCTOR
#define IMP_SCRATCH_HAS_IMP_SCORE_FUNCTOR 1
#define IMP_SCRATCH_USE_BOOST_FILESYSTEM
#define IMP_SCRATCH_HAS_BOOST_FILESYSTEM 1
#define IMP_SCRATCH_USE_BOOST_PROGRAMOPTIONS
#define IMP_SCRATCH_HAS_BOOST_PROGRAMOPTIONS 1
#define IMP_SCRATCH_USE_BOOST_RANDOM
#define IMP_SCRATCH_HAS_BOOST_RANDOM 1
#define IMP_SCRATCH_USE_BOOST_SYSTEM
#define IMP_SCRATCH_HAS_BOOST_SYSTEM 1
#define IMP_SCRATCH_USE_CGAL
#define IMP_SCRATCH_HAS_CGAL 1
#define IMP_SCRATCH_USE_HDF5
#define IMP_SCRATCH_HAS_HDF5 1

    //  functions are defined explicitly for SWIG
    namespace IMP {
  namespace scratch {
/** \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)
    IMPSCRATCHEXPORT 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::scratch"; }
#endif

  }
}  //namespace

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

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

namespace IMP { namespace scratch {
using ::IMP::base::Showable;
using ::IMP::base::operator<<;
using ::IMP::base::hash_value;
} } // namespace
namespace IMP { namespace scratch { 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 scratch {

    //! 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 setup_environment.sh script.
    */
    IMPSCRATCHEXPORT 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 setup_environment.sh script.
    */
    IMPSCRATCHEXPORT std::string get_example_path(std::string file_name);
    /** @} */

  }
}  // namespace

#endif  // SWIG

#include <IMP/base/compiler_macros.h>

#ifdef IMP_DOXYGEN
/** \namespace IMP::scratch
    \brief See [IMP.scratch](\ref impscratch) for more information.
    */
#endif

#endif /* IMPSCRATCH_CONFIG_H */

// Here so it is always parsed

#ifdef IMPSCRATCH_DEPRECATED_HEADER
#undef IMPSCRATCH_DEPRECATED_HEADER
#undef IMPSCRATCH_DEPRECATED_VALUE_DEF
#undef IMPSCRATCH_DEPRECATED_VALUE_DECL
#undef IMPSCRATCH_DEPRECATED_OBJECT_DEF
#undef IMPSCRATCH_DEPRECATED_OBJECT_DECL
#undef IMPSCRATCH_DEPRECATED_FUNCTION_DEF
#undef IMPSCRATCH_DEPRECATED_FUNCTION_DECL
#undef IMPSCRATCH_DEPRECATED_METHOD_DEF
#undef IMPSCRATCH_DEPRECATED_METHOD_DECL
#undef IMPSCRATCH_DEPRECATED_MACRO
#undef IMPSCRATCH_SHOW_WARNINGS
#endif

// the central modules we can update easily, so don't warn in them
#if defined( IMPSCRATCH_COMPILATION)                                 \
  || defined(SWIG) || defined(IMP_SWIG_WRAPPER)                         \
  || defined( IMPSCRATCH_ALL) || defined(IMP_DOXYGEN)                \
  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION)     \
  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION)       \
  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
  || defined(IMPSCOREFUNCTOR_COMPILATION) || defined(IMPRMF_COMPILATION) \
  || defined(IMPGSL_COMPILATION)
#define IMPSCRATCH_SHOW_WARNINGS 0
#else
#define IMPSCRATCH_SHOW_WARNINGS 1
#endif

// suppress header warnings with all header, SWIG wrapper and in the module
#if IMPSCRATCH_SHOW_WARNINGS
#define IMPSCRATCH_DEPRECATED_HEADER(version, help_message)          \
    IMP_PRAGMA(message(__FILE__ " is deprecated: " help_message))
#define IMPSCRATCH_DEPRECATED_VALUE_DECL(version)    \
  IMP_DEPRECATED_ATTRIBUTE
#define IMPSCRATCH_DEPRECATED_OBJECT_DECL(version)    \
  IMP_DEPRECATED_ATTRIBUTE
#define IMPSCRATCH_DEPRECATED_FUNCTION_DECL(version) \
  IMP_DEPRECATED_ATTRIBUTE
#define IMPSCRATCH_DEPRECATED_METHOD_DECL(version) \
  IMP_DEPRECATED_ATTRIBUTE

#else //IMPSCRATCH_SHOW_WARNINGS
/** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
#define IMPSCRATCH_DEPRECATED_HEADER(version, help_message) \
/** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
#define IMPSCRATCH_DEPRECATED_VALUE_DECL(version)
/** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
#define IMPSCRATCH_DEPRECATED_OBJECT_DECL(version)
/** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
#define IMPSCRATCH_DEPRECATED_FUNCTION_DECL(version)
/** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
#define IMPSCRATCH_DEPRECATED_METHOD_DECL(version)

#endif // IMPSCRATCH_SHOW_WARNINGS

// only warn about it in the all inclusion to cut down on copies
#if !defined(IMP_ALL) || defined(SWIG) || defined(IMP_DOXYGEN)          \
  || defined(IMPBASE_COMPILATION) || defined(IMPKERNEL_COMPILATION)     \
  || defined(IMPCORE_COMPILATION) || defined(IMPATOM_COMPILATION)       \
  || defined(IMPSTATISTICS_COMPILATION) || defined(IMPDOMINO_COMPILATION) \
  || defined(IMPCONTAINER_COMPILATION) || defined(IMPDISPLAY_COMPILATION) \
  || defined(IMPSCOREFUNCTOR_COMPILATION)
/** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
#define IMPSCRATCH_DEPRECATED_MACRO(version, message)

#else
#define IMPSCRATCH_DEPRECATED_MACRO(version, message)        \
  IMP_DEPRECATED_MACRO(version, message)
#endif

/** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
#define IMPSCRATCH_DEPRECATED_VALUE_DEF(version, message) \
  IMP_DEPRECATED_VALUE_RUNTIME_WARNING(version, message)

/** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
#define IMPSCRATCH_DEPRECATED_OBJECT_DEF(version, message) \
  IMP_DEPRECATED_OBJECT_RUNTIME_WARNING(version, message)

/** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
#define IMPSCRATCH_DEPRECATED_FUNCTION_DEF(version, message) \
  IMP_DEPRECATED_FUNCTION_RUNTIME_WARNING(version, message)

/** See [deprecation support](https://github.com/salilab/imp/wiki/Deprecation). */
#define IMPSCRATCH_DEPRECATED_METHOD_DEF(version, message) \
  IMP_DEPRECATED_METHOD_RUNTIME_WARNING(version, message)


#include <IMP/base/compiler_macros.h>

#if defined(IMP_EXECUTABLE) && !defined(IMP_EXECUTABLE_WARNINGS)
IMP_COMPILER_ENABLE_WARNINGS
#define IMP_EXECUTABLE_WARNINGS
#endif