Version information module

Access version information and check version.

Functions

auto api_version_is_at_least(const int major, const int minor, const int patch) -> bool
Compares specified version to actual version.

Variables

const std::string LIBARCSTK_GIT_VERSION
Version info as shown by git describe --always HEAD.
const std::string LIBARCSTK_NAME
Library name.
const std::string LIBARCSTK_VERSION
Complete semantic version information.
const int LIBARCSTK_VERSION_MAJOR
Major version number.
const int LIBARCSTK_VERSION_MINOR
Minor version number.
const int LIBARCSTK_VERSION_PATCH
Patch level.
const std::string LIBARCSTK_VERSION_SUFFIX
Version suffix (e.g. 'alpha.1', 'beta.6', 'rc.3' etc.).

Function documentation

bool api_version_is_at_least(const int major, const int minor, const int patch)
#include <version.hpp>

Compares specified version to actual version.

Parameters
major in Major version number to test
minor in Minor version number to test
patch in Patch level number to test
Returns TRUE if actual version is at least specified version

Variable documentation

const std::string LIBARCSTK_GIT_VERSION
#include <version.hpp>

Version info as shown by git describe --always HEAD.

const std::string LIBARCSTK_NAME
#include <version.hpp>

Library name.

const std::string LIBARCSTK_VERSION
#include <version.hpp>

Complete semantic version information.

const int LIBARCSTK_VERSION_MAJOR
#include <version.hpp>

Major version number.

const int LIBARCSTK_VERSION_MINOR
#include <version.hpp>

Minor version number.

const int LIBARCSTK_VERSION_PATCH
#include <version.hpp>

Patch level.

const std::string LIBARCSTK_VERSION_SUFFIX
#include <version.hpp>

Version suffix (e.g. 'alpha.1', 'beta.6', 'rc.3' etc.).