Falaise  4.0.1
SuperNEMO Software Toolkit
Classes | Namespaces | Macros
version.h File Reference

Describe the Falaise API version. More...

#include <string>

Go to the source code of this file.

Classes

struct  falaise::version
 Describe the falaise API version and features. More...
 

Namespaces

 falaise
 

Macros

#define FALAISE_VERSION_MAJOR   4
 Major version number of falaise. More...
 
#define FALAISE_VERSION_MINOR   0
 Minor version number of falaise. More...
 
#define FALAISE_VERSION_PATCH   1
 Patch version number of falaise. More...
 
#define FALAISE_VERSION_REVISION   -1
 
#define FALAISE_VERSION_COMMIT   "d63b6200"
 First 8 characters of the current Git HEAD hash, empty outside a working. More...
 
#define FALAISE_VERSION_IS_DIRTY   0
 Defined if this build has uncommited changes. More...
 
#define FALAISE_ENCODE_VERSION(major, minor, patch)
 Encode falaise to ordered integer available at compile time. More...
 
#define FALAISE_VERSION
 Integer encoded falaise version available at compile time. More...
 
#define FALAISE_LIB_VERSION   "4.0.1"
 String encoded full version number, e.g. "1.2.3", available at compile time. More...
 
#define FALAISE_IS_AT_LEAST(major, minor, patch)
 Check current version >= (major, minor, patch) at compile time. More...
 

Detailed Description

Describe the Falaise API version.

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

Macro Definition Documentation

◆ FALAISE_ENCODE_VERSION

#define FALAISE_ENCODE_VERSION (   major,
  minor,
  patch 
)
Value:
( \
((major) * 10000) \
+ ((minor) * 100) \
+ ((patch) * 1))

Encode falaise to ordered integer available at compile time.

◆ FALAISE_IS_AT_LEAST

#define FALAISE_IS_AT_LEAST (   major,
  minor,
  patch 
)
Value:
( \
FALAISE_VERSION >= \
FALAISE_ENCODE_VERSION(major,minor,patch))

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

◆ FALAISE_LIB_VERSION

#define FALAISE_LIB_VERSION   "4.0.1"

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

◆ FALAISE_VERSION

#define FALAISE_VERSION
Value:
#define FALAISE_VERSION_MINOR
Minor version number of falaise.
Definition: version.h:44
#define FALAISE_VERSION_MAJOR
Major version number of falaise.
Definition: version.h:41
#define FALAISE_VERSION_PATCH
Patch version number of falaise.
Definition: version.h:47
#define FALAISE_ENCODE_VERSION(major, minor, patch)
Encode falaise to ordered integer available at compile time.
Definition: version.h:62

Integer encoded falaise version available at compile time.

◆ FALAISE_VERSION_COMMIT

#define FALAISE_VERSION_COMMIT   "d63b6200"

First 8 characters of the current Git HEAD hash, empty outside a working.

◆ FALAISE_VERSION_IS_DIRTY

#define FALAISE_VERSION_IS_DIRTY   0

Defined if this build has uncommited changes.

◆ FALAISE_VERSION_MAJOR

#define FALAISE_VERSION_MAJOR   4

Major version number of falaise.

◆ FALAISE_VERSION_MINOR

#define FALAISE_VERSION_MINOR   0

Minor version number of falaise.

◆ FALAISE_VERSION_PATCH

#define FALAISE_VERSION_PATCH   1

Patch version number of falaise.

◆ FALAISE_VERSION_REVISION

#define FALAISE_VERSION_REVISION   -1

Current revision/build number of falaise, 0 for a release

Deprecated:
Since 3.1
See also
FALAISE_VERSION_COMMIT