version.h File Reference

Describe the brio API version. More...

#include <string>

Go to the source code of this file.

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

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

Macros
#define	BRIO_VERSION_MAJOR   6
	Major version number of brio. More...
#define	BRIO_VERSION_MINOR   2
	Minor version number of brio. More...
#define	BRIO_VERSION_PATCH   0
	Patch version number of brio. More...
#define	BRIO_ENCODE_VERSION(major, minor, patch)
	Encode brio to ordered integer available at compile time. More...
#define	BRIO_VERSION
	Integer encoded brio version available at compile time. More...
#define	BRIO_LIB_VERSION   "6.2.0"
	String encoded full version number, e.g. "1.2.3", available at compile time. More...
#define	BRIO_IS_AT_LEAST(major_, minor_, patch_)
	Check current version >= (major, minor, patch) at compile time. More...

Detailed Description

Describe the brio API version.

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

Macro Definition Documentation

BRIO_ENCODE_VERSION

#define BRIO_ENCODE_VERSION	(		major,
			minor,
			patch
	)

Value:

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

Encode brio to ordered integer available at compile time.

BRIO_IS_AT_LEAST

#define BRIO_IS_AT_LEAST	(		major_,
			minor_,
			patch_
	)

Value:

(                        \
                                                BRIO_VERSION >=         \
                                                BRIO_ENCODE_VERSION(major_,minor_,patch_))

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

BRIO_LIB_VERSION

#define BRIO_LIB_VERSION   "6.2.0"

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

BRIO_VERSION

#define BRIO_VERSION

Value:

BRIO_ENCODE_VERSION(                     \
                                         BRIO_VERSION_MAJOR,  \
                                         BRIO_VERSION_MINOR,  \
                                         BRIO_VERSION_PATCH)

Integer encoded brio version available at compile time.

BRIO_VERSION_MAJOR

#define BRIO_VERSION_MAJOR   6

Major version number of brio.

BRIO_VERSION_MINOR

#define BRIO_VERSION_MINOR   2

Minor version number of brio.

BRIO_VERSION_PATCH

#define BRIO_VERSION_PATCH   0

Patch version number of brio.