config.h

Go to the documentation of this file.

/**
 * @file  config.h
 * @brief Default include file with project configuration.
 *
 * @note The config.h file is automatically generated by BASIS from the
 *       file config.h.in which is part of BASIS.
 *
 * Copyright (c) 2011 University of Pennsylvania. All rights reserved.<br />
 * See https://www.cbica.upenn.edu/sbia/software/license.html or COPYING file.
 *
 * Contact: SBIA Group <sbia-software at uphs.upenn.edu>
 */

#pragma once
#ifndef _SBIA_BASIS_CONFIG_H
#define _SBIA_BASIS_CONFIG_H


/// @addtogroup BasisCxxUtilities
/// @{


// ===========================================================================
// system
// ===========================================================================

/// @def   LINUX
/// @brief Whether the sources are compiled on a Linux system.
#ifndef LINUX
#  define LINUX (defined (linux) || defined (__linux))
#endif

/// @def   WINDOWS
/// @brief Whether the sources are compiled on a Windows system.
#ifndef WINDOWS
#  define WINDOWS (defined (_WIN32) || defined (WIN32) || defined (_WINDOWS))
#endif

/// @def   MACOS
/// @brief Whether the sources are compiled on a Mac OS system.
#ifndef MACOS
#  define MACOS (defined (__APPLE__) || defined (__OSX__))
#endif

/// @def   UNIX
/// @brief Whether the sources are compiled on a Unix-based system.
#ifndef UNIX
#  define UNIX (!WINDOWS)
#endif

/// @def   HAVE_LONG_LONG
/// @brief Whether the long long type is supported by the compiler.
#ifndef HAVE_LONG_LONG
#  define HAVE_LONG_LONG 1
#endif

/// @def HAVE_SSTREAM
/// @brief Whether the ANSI string stream classes are available.
#ifndef HAVE_SSTREAM
#  define HAVE_SSTREAM 1
#endif

/**
 * @def   HAVE_STRSTREAM
 * @brief Whether the obsolete string stream classes are available.
 *
 * @note As the strstream implementations are obsolete already for a long
 *       time, this macro always evaluates to 0.
 */
#ifdef HAVE_STRSTREAM
#  undef HAVE_STRSTREAM
#endif
#define HAVE_STRSTREAM 0

/// @def HAVE_PTHREAD
/// @brief Whether the pthread library is available.
#ifndef HAVE_PTHREAD
#  define HAVE_PTHREAD 1
#endif

/**
 * @def HAVE_TR1_TUPLE
 * @brief Whether the tr1/tuple header file is available.
 *
 * @note This header file is only more recently supported by compilers
 *       and be used by Google Test, for example. If not supported by
 *       the compiler, Google Test can use it's own implementation.
 */
#ifndef HAVE_TR1_TUPLE
#  define HAVE_TR1_TUPLE 1
#endif

// ===========================================================================
// namespace
// ===========================================================================

/**
 * @brief Full project own namespace identifier.
 *
 * This macro should preferably be used when referring to the project own
 * namespace. The namespace can then be renamed later on without affecting
 * written source code.
 *
 * @note Namespace identifier may reflect a nested namespace.
 */
#define SBIA_BASIS_NAMESPACE \
    ::sbia::basis

/**
 * @brief Macro used to enter project own namespace.
 *
 * Example: 
 * @code
 * SBIA_BASIS_NAMESPACE_BEGIN
 *
 * // project source code within project own namespace
 *
 * SBIA_BASIS_NAMESPACE_END
 * @endcode 
 */ 
#define SBIA_BASIS_NAMESPACE_BEGIN \
    namespace sbia { namespace basis {

/**
 * @brief Macro used to exit project own namespace.
 *
 * Example: 
 * @code
 * SBIA_BASIS_NAMESPACE_BEGIN
 *
 * // project source code within project own namespace
 *
 * SBIA_BASIS_NAMESPACE_END
 * @endcode 
 */
#define SBIA_BASIS_NAMESPACE_END } }

// ===========================================================================
// constants
// ===========================================================================

namespace sbia
{

namespace basis
{


// ---------------------------------------------------------------------------
// project attributes

/// @brief The project name.
extern const char* cProjectName;

/// @brief The project name in lowercase only.
extern const char* cProjectNameLower;

/// @brief The project name in uppercase only.
extern const char* cProjectNameUpper;

/// @brief The major version number.
extern const unsigned int cVersionMajor;

/// @brief The minor version number.
extern const unsigned int cVersionMinor;

/// @brief The patch number.
extern const unsigned int cVersionPatch;

/// @brief The version string given as "<major>.<minor>.<patch>".
extern const char* cVersion;

/**
 * @brief The Subversion revision number of the project.
 *
 * Note that the revision number is not known when the software is built
 * from a source distribution package instead of a Subversion working copy.
 * In this case, the revision number is set to 0, an invalid revision number.
 * Therefore, the revision number should only be used within the version
 * information of executables, but not for conditional execution.
 */
extern const unsigned int cRevision;

/// @brief Complete version information as output by --version option.
extern const char* cVersionAndRevision;

// ---------------------------------------------------------------------------
// paths - build tree

/**
 * @brief Absolute path of top directory of build tree.
 *
 * This constant is set to the absolute path of the top directory of the build
 * tree in which the software was built. It can be used to determine whether
 * an executable is executing from within the build tree rather than an
 * installation. Given that we tend to build software in a directory with the
 * prefix "-build", but never choose such directory for the installation prefix,
 * a check whether or not the location of the executable file is inside this
 * build tree is enough to know whether or not it is executed from within the
 * build tree or an installation.
 *
 * @sa get_installation_directory()
 */
extern const char* cBuildRoot;

/**
 * @brief Absolute path to runtime executables in build tree.
 *
 * @sa get_runtime_directory()
 */
extern const char* cRuntimeBuildPath;

/**
 * @brief Absolute path to auxiliary executables in build tree.
 *
 * @sa get_libexec_directory()
 */
extern const char* cLibexecBuildPath;

/**
 * @brief Absolute path to modules and shared libraries in build tree.
 *
 * @sa get_library_directory()
 */
extern const char* cLibraryBuildPath;

/**
 * @brief Absolute path to auxiliary data files in build tree.
 *
 * @sa get_data_directory()
 */
extern const char* cDataBuildPath;

// ---------------------------------------------------------------------------
// paths - installation

/**
 * @brief Path prefix used by runtime executables.
 *
 * This path prefix is used by runtime executables as prefix for any of the
 * relative path constants defined globally.
 *
 * Example:
 * @code
 * std::string path = get_executable_directory() + cRuntimePathPrefix + cDataPath;
 * @endcode
 *
 * The resulting path is the absolute path to the shared data directory if
 * executed by a main executable which is located in the runtime directory.
 *
 * @sa get_installation_directory()
 */
extern const char* cRuntimePathPrefix;

/**
 * @brief Path prefix used by auxiliary executables.
 *
 * This path prefix is used by auxiliary executables as prefix for any of the
 * relative path constants defined globally.
 *
 * Example:
 * @code
 * std::string path = get_executable_directory() + cLibexecPathPrefix + cDataPath;
 * @endcode
 *
 * The resulting path is the absolute path to the shared data directory if
 * executed by an auxiliary executable which is located in the libexec directory.
 *
 * @sa get_installation_directory()
 */
extern const char* cLibexecPathPrefix;

/**
 * @brief Path to runtime executables relative to executable directory.
 *
 * @sa cRuntimePathPrefix
 * @sa cLibexecPathPrefix
 *
 * @sa get_runtime_directory()
 */
extern const char* cRuntimePath;

/**
 * @brief Path to auxiliary executables relative to executable directory.
 *
 * @sa cRuntimePathPrefix
 * @sa cLibexecPathPrefix
 *
 * @sa get_libexec_directory()
 */
extern const char* cLibexecPath;

/**
 * @brief Path to modules and shared libraries relative to executable directory.
 *
 * @sa cRuntimePathPrefix
 * @sa cLibexecPathPrefix
 *
 * @sa get_library_directory()
 */
extern const char* cLibraryPath;

/**
 * @brief Path to shared data relative to executable path prefix.
 *
 * @sa cRuntimePathPrefix
 * @sa cLibexecPathPrefix
 *
 * @sa get_data_directory()
 */
extern const char* cDataPath;


} // namespace basis

} // namespace sbia


/// @}
// end of Doxygen group

#endif // _SBIA_BASIS_CONFIG_H