version.h File Reference

Describe the mygsl API version. More...

#include <string>

Go to the source code of this file.

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

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

Macros
#define	MYGSL_VERSION_MAJOR   6
	Major version number of mygsl. More...
#define	MYGSL_VERSION_MINOR   2
	Minor version number of mygsl. More...
#define	MYGSL_VERSION_PATCH   0
	Patch version number of mygsl. More...
#define	MYGSL_ENCODE_VERSION(major, minor, patch)
	Encode mygsl to ordered integer available at compile time. More...
#define	MYGSL_VERSION
	Integer encoded mygsl version available at compile time. More...
#define	MYGSL_LIB_VERSION   "6.2.0"
	String encoded full version number, e.g. "1.2.3", available at compile time. More...
#define	MYGSL_IS_AT_LEAST(major, minor, patch)
	Check current version >= (major, minor, patch) at compile time. More...

Detailed Description

Describe the mygsl API version.

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

Macro Definition Documentation

MYGSL_ENCODE_VERSION

#define MYGSL_ENCODE_VERSION	(		major,
			minor,
			patch
	)

Value:

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

Encode mygsl to ordered integer available at compile time.

MYGSL_IS_AT_LEAST

#define MYGSL_IS_AT_LEAST	(		major,
			minor,
			patch
	)

Value:

(                          \
                                              MYGSL_VERSION >=          \
                                              MYGSL_ENCODE_VERSION(major,minor,patch))

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

MYGSL_LIB_VERSION

#define MYGSL_LIB_VERSION   "6.2.0"

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

MYGSL_VERSION

#define MYGSL_VERSION

Value:

MYGSL_ENCODE_VERSION(                     \
                                           MYGSL_VERSION_MAJOR, \
                                           MYGSL_VERSION_MINOR, \
                                           MYGSL_VERSION_PATCH)

Integer encoded mygsl version available at compile time.

MYGSL_VERSION_MAJOR

#define MYGSL_VERSION_MAJOR   6

Major version number of mygsl.

MYGSL_VERSION_MINOR

#define MYGSL_VERSION_MINOR   2

Minor version number of mygsl.

MYGSL_VERSION_PATCH

#define MYGSL_VERSION_PATCH   0

Patch version number of mygsl.