version.h File Reference

Describe the emfield API version. More...

#include <string>

Go to the source code of this file.

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

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

Macros
#define	EMFIELD_VERSION_MAJOR   2
	Major version number of emfield. More...
#define	EMFIELD_VERSION_MINOR   2
	Minor version number of emfield. More...
#define	EMFIELD_VERSION_PATCH   0
	Patch version number of emfield. More...
#define	EMFIELD_ENCODE_VERSION(major, minor, patch)
	Encode emfield to ordered integer available at compile time. More...
#define	EMFIELD_VERSION
	Integer encoded emfield version available at compile time. More...
#define	EMFIELD_LIB_VERSION   "2.2.0"
	String encoded full version number, e.g. "1.2.3", available at compile time. More...
#define	EMFIELD_IS_AT_LEAST(major, minor, patch)
	Check current version >= (major, minor, patch) at compile time. More...

Detailed Description

Describe the emfield API version.

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

Macro Definition Documentation

EMFIELD_ENCODE_VERSION

#define EMFIELD_ENCODE_VERSION	(		major,
			minor,
			patch
	)

Value:

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

Encode emfield to ordered integer available at compile time.

EMFIELD_IS_AT_LEAST

#define EMFIELD_IS_AT_LEAST	(		major,
			minor,
			patch
	)

Value:

(                        \
                                                EMFIELD_VERSION >=      \
                                                EMFIELD_ENCODE_VERSION(major,minor,patch))

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

EMFIELD_LIB_VERSION

#define EMFIELD_LIB_VERSION   "2.2.0"

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

EMFIELD_VERSION

#define EMFIELD_VERSION

Value:

EMFIELD_ENCODE_VERSION(                         \
                                               EMFIELD_VERSION_MAJOR,   \
                                               EMFIELD_VERSION_MINOR,   \
                                               EMFIELD_VERSION_PATCH)

Integer encoded emfield version available at compile time.

EMFIELD_VERSION_MAJOR

#define EMFIELD_VERSION_MAJOR   2

Major version number of emfield.

EMFIELD_VERSION_MINOR

#define EMFIELD_VERSION_MINOR   2

Minor version number of emfield.

EMFIELD_VERSION_PATCH

#define EMFIELD_VERSION_PATCH   0

Patch version number of emfield.