§tiro/version.h
Contains version information both at compile time and runtime.
§Functions
Name | |
---|---|
uint32_t | tiro_version_number() Returns the value of TIRO_VERSION_NUMBER at the time the library was built. |
const char * | tiro_version() The value of TIRO_VERSION at the time the library was built. |
const char * | tiro_source_id() The value of TIRO_SOURCE_ID at the time the library was built. |
const char * | tiro_full_version() The value of TIRO_FULL_VERSION at the time the library was built. |
§Defines
Name | |
---|---|
TIRO_MAKE_VERSION(major, minor, patch) Tiro uses semantic versioning. | |
TIRO_VERSION_NUMBER The library's version number as a build-time constant. | |
TIRO_VERSION The library's version string as a build-time constant. | |
TIRO_SOURCE_ID The full source id (from version control) as a build-time constant. | |
TIRO_FULL_VERSION The full version string as a build-time constant. |
§Functions Documentation
§function tiro_version_number
uint32_t tiro_version_number()
Returns the value of TIRO_VERSION_NUMBER
at the time the library was built.
This may be different than the value observed in TIRO_VERSION_NUMBER
if the application uses a different library version than it was originally compiled with.
§function tiro_version
const char * tiro_version()
The value of TIRO_VERSION
at the time the library was built.
The returned string points into static storage and must not be modified.
§function tiro_source_id
const char * tiro_source_id()
The value of TIRO_SOURCE_ID
at the time the library was built.
The returned string points into static storage and must not be modified.
§function tiro_full_version
const char * tiro_full_version()
The value of TIRO_FULL_VERSION
at the time the library was built.
The returned string points into static storage and must not be modified.
§Macros Documentation
§define TIRO_MAKE_VERSION
#define TIRO_MAKE_VERSION(major,minor,patch)(uint32_t)((major) * 1000000 + (minor) * 1000 + (patch))
Tiro uses semantic versioning.
The version number is incremented for every api change. The following macro constructs a single version number by combining the major, minor and patch version parts. The final version number supports comparison through relational operators.
Note that the individual version number parts must be smaller than 1000.
§define TIRO_VERSION_NUMBER
#define TIRO_VERSION_NUMBER TIRO_MAKE_VERSION(0, 1, 0)
The library's version number as a build-time constant.
§define TIRO_VERSION
#define TIRO_VERSION "0.1.0-dev"
The library's version string as a build-time constant.
§define TIRO_SOURCE_ID
#define TIRO_SOURCE_ID "git:8f21b87fc4ef55245e87a2b7708119149ba035cf"
The full source id (from version control) as a build-time constant.
§define TIRO_FULL_VERSION
#define TIRO_FULL_VERSION "tiro 0.1.0-dev (git:8f21b87fc4ef55245e87a2b7708119149ba035cf)"
The full version string as a build-time constant.
Updated on 2022-02-27 at 21:17:13 +0100