version.h File Reference

Describe the dpp API version. More...

#include <string>

Go to the source code of this file.

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

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

Macros
#define	DPP_VERSION_MAJOR   3
	Major version number of dpp. More...
#define	DPP_VERSION_MINOR   2
	Minor version number of dpp. More...
#define	DPP_VERSION_PATCH   0
	Patch version number of dpp. More...
#define	DPP_ENCODE_VERSION(major_, minor_, patch_)
	Encode dpp to ordered integer available at compile time. More...
#define	DPP_VERSION
	Integer encoded dpp version available at compile time. More...
#define	DPP_LIB_VERSION   "3.2.0"
	String encoded full version number, e.g. "1.2.3", available at compile time. More...
#define	DPP_IS_AT_LEAST(major, minor, patch)
	Check current version >= (major, minor, patch) at compile time. More...

Detailed Description

Describe the dpp API version.

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

Macro Definition Documentation

DPP_ENCODE_VERSION

#define DPP_ENCODE_VERSION	(		major_,
			minor_,
			patch_
	)

Value:

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

Encode dpp to ordered integer available at compile time.

DPP_IS_AT_LEAST

#define DPP_IS_AT_LEAST	(		major,
			minor,
			patch
	)

Value:

(DPP_VERSION >=              \
                                            DPP_ENCODE_VERSION(major,minor,patch))

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

DPP_LIB_VERSION

#define DPP_LIB_VERSION   "3.2.0"

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

DPP_VERSION

#define DPP_VERSION

Value:

DPP_ENCODE_VERSION(DPP_VERSION_MAJOR, \
                                       DPP_VERSION_MINOR, \
                                       DPP_VERSION_PATCH)

Integer encoded dpp version available at compile time.

DPP_VERSION_MAJOR

#define DPP_VERSION_MAJOR   3

Major version number of dpp.

DPP_VERSION_MINOR

#define DPP_VERSION_MINOR   2

Minor version number of dpp.

DPP_VERSION_PATCH

#define DPP_VERSION_PATCH   0

Patch version number of dpp.