version.hpp File Reference

Provides SHARG version macros and global variables. More...

#include <cstdint>

Include dependency graph for version.hpp:

Go to the source code of this file.

Macros
#define	SHARG_RELEASE_CANDIDATE   0
	The release candidate number. 0 means stable release, >= 1 means release candidate.
#define	SHARG_RELEASE_CANDIDATE_HELPER(RC)   ""
	A helper function that expands to a suitable release candidate suffix.
#define	SHARG_VERSION   (SHARG_VERSION_MAJOR * 10000 + SHARG_VERSION_MINOR * 100 + SHARG_VERSION_PATCH)
	The full version as MACRO (number).
#define	SHARG_VERSION_CSTRING
	The full version as null terminated string. More...
#define	SHARG_VERSION_CSTRING_HELPER_FUNC(MAJOR, MINOR, PATCH)
	Converts version numbers to string. More...
#define	SHARG_VERSION_CSTRING_HELPER_STR(str)   #str
	Converts a number to a string. Preprocessor needs this indirection to properly expand the values to strings.
#define	SHARG_VERSION_MAJOR   1
	The major version as MACRO.
#define	SHARG_VERSION_MINOR   0
	The minor version as MACRO.
#define	SHARG_VERSION_PATCH   0
	The patch version as MACRO.

Variables
constexpr std::size_t	sharg::sharg_version = SHARG_VERSION
	The full version as std::size_t.
constexpr char const *	sharg::sharg_version_cstring = SHARG_VERSION_CSTRING
	The full version as null terminated string.
constexpr uint8_t	sharg::sharg_version_major = SHARG_VERSION_MAJOR
	The major version.
constexpr uint8_t	sharg::sharg_version_minor = SHARG_VERSION_MINOR
	The minor version.
constexpr uint8_t	sharg::sharg_version_patch = SHARG_VERSION_PATCH
	The patch version.

Detailed Description

Provides SHARG version macros and global variables.

Author

Svenja Mehringer <svenja.mehringer AT fu-berlin.de>

Macro Definition Documentation

SHARG_VERSION_CSTRING

#define SHARG_VERSION_CSTRING

Value:

    SHARG_VERSION_CSTRING_HELPER_FUNC(SHARG_VERSION_MAJOR, SHARG_VERSION_MINOR, SHARG_VERSION_PATCH)                   \
    SHARG_RELEASE_CANDIDATE_HELPER(SHARG_RELEASE_CANDIDATE)

The full version as null terminated string.

SHARG_VERSION_CSTRING_HELPER_FUNC

#define SHARG_VERSION_CSTRING_HELPER_FUNC	(		MAJOR,
			MINOR,
			PATCH
	)

Value:

    SHARG_VERSION_CSTRING_HELPER_STR(MAJOR)                                                                            \
    "." SHARG_VERSION_CSTRING_HELPER_STR(MINOR) "." SHARG_VERSION_CSTRING_HELPER_STR(PATCH)

Converts version numbers to string.