version.h

Go to the documentation of this file.

/***************************************************************************
 *  include/stxxl/bits/version.h
 *
 *  Part of the STXXL. See http://stxxl.sourceforge.net
 *
 *  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 STXXL_VERSION_HEADER
#define STXXL_VERSION_HEADER

#include <stxxl/bits/namespace.h>
#include <stxxl/bits/config.h>
#include <stxxl/bits/verbose.h>

STXXL_BEGIN_NAMESPACE

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

// construct an integer version number, like "10400" for "1.4.0".
#define STXXL_VERSION_INTEGER (STXXL_VERSION_MAJOR* 10000 + STXXL_VERSION_MINOR* 100 + STXXL_VERSION_PATCH)

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

//! Return "X.Y.Z" version string (of headers)
inline const char * get_version_string()
{
    return STXXL_VERSION_STRING;
}

//! Return longer "X.Y.Z (feature) (version)" version string (of headers)
inline const char * get_version_string_long()
{
    return "STXXL"
           " v" STXXL_VERSION_STRING
#ifdef STXXL_VERSION_PHASE
           " (" STXXL_VERSION_PHASE ")"
#endif
#ifdef STXXL_VERSION_GIT_SHA1
           " (git " STXXL_VERSION_GIT_SHA1 ")"
#endif // STXXL_VERSION_GIT_SHA1
#if STXXL_PARALLEL
           " + gnu parallel(" stringify(__GLIBCXX__) ")"
#endif // STXXL_PARALLEL
#if STXXL_BOOST_CONFIG
           " + Boost " stringify(BOOST_VERSION)
#endif
    ;
}

#undef stringify
#undef stringify_

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

//! returns "X.Y.Z" version string of library
const char * get_library_version_string();

//! returns longer "X.Y.Z (feature) (version)" string of library
const char * get_library_version_string_long();

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

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

STXXL_END_NAMESPACE

#endif // !STXXL_VERSION_HEADER