version.hpp

Go to the documentation of this file.

/***************************************************************************
 *  foxxll/version.hpp
 *
 *  Part of FOXXLL. See http://foxxll.org
 *
 *  Copyright (C) 2007, 2011 Andreas Beckmann <[email protected]>
 *  Copyright (C) 2013 Timo Bingmann <[email protected]>
 *
 *  Distributed under the Boost Software License, Version 1.0.
 *  (See accompanying file LICENSE_1_0.txt or copy at
 *  http://www.boost.org/LICENSE_1_0.txt)
 **************************************************************************/

#ifndef FOXXLL_VERSION_HEADER
#define FOXXLL_VERSION_HEADER

#include <string>

#include <tlx/die/core.hpp>

#include <foxxll/config.hpp>

namespace foxxll {

// FOXXLL_VERSION_{MAJOR,MINOR,PATCH} are defined in cmake generated config.h

// construct an integer version number, like "10400" for "1.4.0".
#define FOXXLL_VERSION_INTEGER (FOXXLL_VERSION_MAJOR * 10000 + FOXXLL_VERSION_MINOR * 100 + FOXXLL_VERSION_PATCH)

#define stringify_(x) #x
#define stringify(x) stringify_(x)

//! Return "X.Y.Z" version string (of headers)
inline std::string get_version_string()
{
    return FOXXLL_VERSION_STRING;
}

//! Return longer "X.Y.Z (feature) (version)" version string (of headers)
inline std::string get_version_string_long()
{
    return "FOXXLL"
           " v" FOXXLL_VERSION_STRING
#ifdef FOXXLL_VERSION_PHASE
           " (" FOXXLL_VERSION_PHASE ")"
#endif
#ifdef FOXXLL_VERSION_GIT_SHA1
           " (git " FOXXLL_VERSION_GIT_SHA1 ")"
#endif // FOXXLL_VERSION_GIT_SHA1
    ;     // NOLINT
}

#undef stringify
#undef stringify_

//! return X if the FOXXLL library version is X.Y.Z
int version_major();
//! return Y if the FOXXLL library version is X.Y.Z
int version_minor();
//! return Z if the FOXXLL library version is X.Y.Z
int version_patch();
//! return integer version number of the FOXXLL library
int version_integer();

//! returns "X.Y.Z" version string of library
std::string get_library_version_string();

//! returns longer "X.Y.Z (feature) (version)" string of library
std::string get_library_version_string_long();

//! Check for a mismatch between library and headers
inline int check_library_version()
{
    if (version_major() != FOXXLL_VERSION_MAJOR)
        return 1;
    if (version_minor() != FOXXLL_VERSION_MINOR)
        return 2;
    if (version_patch() != FOXXLL_VERSION_PATCH)
        return 3;
    return 0;
}

//! Check and print mismatch between header and library versions
inline void print_library_version_mismatch()
{
    if (foxxll::check_library_version() != 0)
    {
        tlx_die(
            "version mismatch between headers"
            " (" << FOXXLL_VERSION_STRING ") and library"
                " (" << get_library_version_string() << ")"
        );
    }
}

} // namespace foxxll

#endif // !FOXXLL_VERSION_HEADER

/**************************************************************************/