version.h File Reference

Describe the mctools API version. More...

#include <string>

Go to the source code of this file.

Classes
struct	mctools::version
	Describe the mctools API version and features. More...

Namespaces
	mctools

Macros
#define	MCTOOLS_VERSION_MAJOR   2
	Major version number of mctools. More...
#define	MCTOOLS_VERSION_MINOR   2
	Minor version number of mctools. More...
#define	MCTOOLS_VERSION_PATCH   0
	Patch version number of mctools. More...
#define	MCTOOLS_ENCODE_VERSION(major_, minor_, patch_)
	Encode mctools to ordered integer available at compile time. More...
#define	MCTOOLS_VERSION
	Integer encoded mctools version available at compile time. More...
#define	MCTOOLS_LIB_VERSION   "2.2.0"
	String encoded full version number, e.g. "1.2.3", available at compile time. More...
#define	MCTOOLS_IS_AT_LEAST(major_, minor_, patch_)
	Check current version >= (major, minor, patch) at compile time. More...

Detailed Description

Describe the mctools API version.

Querying the version of mctools is needed at both compile and runtime by clients so that they may adjust their usage.

Macro Definition Documentation

MCTOOLS_ENCODE_VERSION

#define MCTOOLS_ENCODE_VERSION	(		major_,
			minor_,
			patch_
	)

Value:

(                \
                                                        ((major_) * 10000) \
                                                        + ((minor_) *   100) \
                                                        + ((patch_) *     1))

Encode mctools to ordered integer available at compile time.

MCTOOLS_IS_AT_LEAST

#define MCTOOLS_IS_AT_LEAST	(		major_,
			minor_,
			patch_
	)

Value:

(                     \
                                                   MCTOOLS_VERSION >=   \
                                                   MCTOOLS_ENCODE_VERSION(major_,minor_,patch_))

Check current version >= (major, minor, patch) at compile time.

MCTOOLS_LIB_VERSION

#define MCTOOLS_LIB_VERSION   "2.2.0"

String encoded full version number, e.g. "1.2.3", available at compile time.

MCTOOLS_VERSION

#define MCTOOLS_VERSION

Value:

MCTOOLS_ENCODE_VERSION(                       \
                                               MCTOOLS_VERSION_MAJOR, \
                                               MCTOOLS_VERSION_MINOR, \
                                               MCTOOLS_VERSION_PATCH)

Integer encoded mctools version available at compile time.

MCTOOLS_VERSION_MAJOR

#define MCTOOLS_VERSION_MAJOR   2

Major version number of mctools.

MCTOOLS_VERSION_MINOR

#define MCTOOLS_VERSION_MINOR   2

Minor version number of mctools.

MCTOOLS_VERSION_PATCH

#define MCTOOLS_VERSION_PATCH   0

Patch version number of mctools.