version.h File Reference

Describe the cuts API version. More...

#include <string>

Go to the source code of this file.

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

Namespaces
	cuts
	Top-level namespace of the Bayeux/cuts module library.

Macros
#define	CUTS_VERSION_MAJOR   6
	Major version number of cuts. More...
#define	CUTS_VERSION_MINOR   2
	Minor version number of cuts. More...
#define	CUTS_VERSION_PATCH   0
	Patch version number of cuts. More...
#define	CUTS_ENCODE_VERSION(major, minor, patch)
	Encode cuts to ordered integer available at compile time. More...
#define	CUTS_VERSION
	Integer encoded cuts version available at compile time. More...
#define	CUTS_LIB_VERSION   "6.2."
	String encoded full version number, e.g. "1.2.3", available at compile time. More...
#define	CUTS_IS_AT_LEAST(major, minor, patch)
	Check current version >= (major, minor, patch) at compile time. More...

Detailed Description

Describe the cuts API version.

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

Macro Definition Documentation

CUTS_ENCODE_VERSION

#define CUTS_ENCODE_VERSION	(		major,
			minor,
			patch
	)

Value:

(     \
              ((major) * 10000) \
              + ((minor) *   100) \
              + ((patch) *     1))

Encode cuts to ordered integer available at compile time.

CUTS_IS_AT_LEAST

#define CUTS_IS_AT_LEAST	(		major,
			minor,
			patch
	)

Value:

(       \
               CUTS_VERSION >=    \
               CUTS_ENCODE_VERSION(major,minor,patch))

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

CUTS_LIB_VERSION

#define CUTS_LIB_VERSION   "6.2."

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

CUTS_VERSION

#define CUTS_VERSION

Value:

CUTS_ENCODE_VERSION(      \
           CUTS_VERSION_MAJOR,  \
           CUTS_VERSION_MINOR,  \
           CUTS_VERSION_PATCH)

Integer encoded cuts version available at compile time.

CUTS_VERSION_MAJOR

#define CUTS_VERSION_MAJOR   6

Major version number of cuts.

CUTS_VERSION_MINOR

#define CUTS_VERSION_MINOR   2

Minor version number of cuts.

CUTS_VERSION_PATCH

#define CUTS_VERSION_PATCH   0

Patch version number of cuts.