version.h File Reference

Describe the genbb_help API version. More...

#include <string>

Go to the source code of this file.

Classes
struct	genbb::version
	Describe the genbb_help API version and features. More...

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

Macros
#define	GENBB_HELP_VERSION_MAJOR   6
	Major version number of genbb_help. More...
#define	GENBB_HELP_VERSION_MINOR   2
	Minor version number of genbb_help. More...
#define	GENBB_HELP_VERSION_PATCH   0
	Patch version number of genbb_help. More...
#define	GENBB_HELP_ENCODE_VERSION(major, minor, patch)
	Encode genbb_help to ordered integer available at compile time. More...
#define	GENBB_HELP_VERSION
	Integer encoded genbb_help version available at compile time. More...
#define	GENBB_HELP_LIB_VERSION   "6.2.0"
	String encoded full version number, e.g. "1.2.3", available at compile time. More...
#define	GENBB_HELP_IS_AT_LEAST(major, minor, patch)
	Check current version >= (major, minor, patch) at compile time. More...

Detailed Description

Describe the genbb_help API version.

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

Macro Definition Documentation

GENBB_HELP_ENCODE_VERSION

#define GENBB_HELP_ENCODE_VERSION	(		major,
			minor,
			patch
	)

Value:

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

Encode genbb_help to ordered integer available at compile time.

GENBB_HELP_IS_AT_LEAST

#define GENBB_HELP_IS_AT_LEAST	(		major,
			minor,
			patch
	)

Value:

(                     \
                                                   GENBB_HELP_VERSION >= \
                                                   GENBB_HELP_ENCODE_VERSION(major,minor,patch))

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

GENBB_HELP_LIB_VERSION

#define GENBB_HELP_LIB_VERSION   "6.2.0"

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

GENBB_HELP_VERSION

#define GENBB_HELP_VERSION

Value:

GENBB_HELP_ENCODE_VERSION(                   \
                                                     GENBB_HELP_VERSION_MAJOR, \
                                                     GENBB_HELP_VERSION_MINOR, \
                                                     GENBB_HELP_VERSION_PATCH)

Integer encoded genbb_help version available at compile time.

GENBB_HELP_VERSION_MAJOR

#define GENBB_HELP_VERSION_MAJOR   6

Major version number of genbb_help.

GENBB_HELP_VERSION_MINOR

#define GENBB_HELP_VERSION_MINOR   2

Minor version number of genbb_help.

GENBB_HELP_VERSION_PATCH

#define GENBB_HELP_VERSION_PATCH   0

Patch version number of genbb_help.