Version Namespace Reference
Enumerations | |
| enum | Class { DEV, ALPHA, BETA, RC, FINAL } |
Functions | |
| std::string | Short () |
| The short version string. | |
| std::string | Long () |
| The long version string. | |
| int | Major () |
| The major version number. | |
| int | Minor () |
| The minor version number. | |
| int | Revision () |
| The revision number. | |
| int | Build () |
| The build number. | |
| Class | ReleaseType () |
| The release class. | |
| int | ReleaseID () |
| The release ID. | |
| std::string | Compiler () |
| The compiler used. | |
| std::string | BuildOS () |
| The compiling operating system. | |
| std::string | BuildOSVersion () |
| The compiling operating system's version. | |
| std::string | BuildMachine () |
| The machine type. | |
| std::string | BuildProcessor () |
| The processor type. | |
| std::string | CFLAGS () |
| The CFLAGS. | |
| std::string | LDFLAGS () |
| The LDFLAGS. | |
Enumeration Type Documentation
| enum Version::Class |
Function Documentation
| int Version::Build | ( | ) |
The build number.
This is the fourth number to appear in a version tag. For instance, if the tag is '0.1.2.3', this function would return '3'.
| std::string Version::BuildMachine | ( | ) |
The machine type.
Names the machine type (e.g., "i686") the executable was compiled on.
| std::string Version::BuildOS | ( | ) |
The compiling operating system.
Names the operating system that the executable was compiled on.
| std::string Version::BuildOSVersion | ( | ) |
The compiling operating system's version.
Specifies the version of the OS that the executable was compiled on.
| std::string Version::BuildProcessor | ( | ) |
The processor type.
Names the processor type the executable was compiled on.
| std::string Version::CFLAGS | ( | ) |
The CFLAGS.
Returns the CFLAGS the executable was compiled with.
| std::string Version::Compiler | ( | ) |
The compiler used.
Names the compiler used to genrate the executable.
| std::string Version::LDFLAGS | ( | ) |
The LDFLAGS.
Returns the flags the executable was linked with.
| std::string Version::Long | ( | ) |
The long version string.
This string contains detailed version information about the CrissCross build in use. The string will always start with the Git tag that this build descended from. If this build is not an exact match for a given tag, this string will also include the number of commits since the tag and the Git commit id (the SHA-1 hash).
| int Version::Major | ( | ) |
The major version number.
This is the first number to appear in a version tag. For instance, if the tag is '0.1.2.3', this function would return '0'.
| int Version::Minor | ( | ) |
The minor version number.
This is the second number to appear in a version tag. For instance, if the tag is '0.1.2.3', this function would return '1'.
| int Version::ReleaseID | ( | ) |
The release ID.
If this is a special type of release (alpha, beta, rc), then this will return the alpha/beta/rc number. Otherwise, this returns 0.
| Class Version::ReleaseType | ( | ) |
The release class.
Indicates the type of release. For instance, if you have a tag such as '0.1.2-b1', the class is 'BETA'. Valid suffixes are '-a', '-b', '-rc'. If the version string does not precisely match a tag, then it is considered an in-development version.
| int Version::Revision | ( | ) |
The revision number.
This is the third number to appear in a version tag. For instance, if the tag is '0.1.2.3', this function would return '2'.
| std::string Version::Short | ( | ) |
The short version string.
This version will generally match the last version tag. For instance, if the last tag of Crawl before this build was '0.1.2', you'd see '0.1.2'. This version number does not include some rather important extra information useful for getting the exact revision (the Git commit hash and the number of revisions since the tag). For that extra information, use Version::Long() instead.
For extracting individual components of the version, you should use the Major(), Minor(), Revision() and Build() functions.
