diff options
Diffstat (limited to 'src/utils/version.h')
| -rw-r--r-- | src/utils/version.h | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/src/utils/version.h b/src/utils/version.h index 6604b1885..1b6bd1c97 100644 --- a/src/utils/version.h +++ b/src/utils/version.h @@ -14,9 +14,29 @@ namespace Botan { /************************************************* * Get information describing the version * *************************************************/ + +/** +* Get the version string identifying the version of Botan. +* @return the version string +*/ BOTAN_DLL std::string version_string(); + +/** +* Get the major version number. +* @return the major version number +*/ BOTAN_DLL u32bit version_major(); + +/** +* Get the minor version number. +* @return the minor version number +*/ BOTAN_DLL u32bit version_minor(); + +/** +* Get the patch number. +* @return the patch number +*/ BOTAN_DLL u32bit version_patch(); /************************************************* @@ -24,6 +44,12 @@ BOTAN_DLL u32bit version_patch(); *************************************************/ #define BOTAN_VERSION_CODE_FOR(a,b,c) ((a << 16) | (b << 8) | (c)) +/** +* Compare using BOTAN_VERSION_CODE_FOR, as in +* #if BOTAN_VERSION_CODE < BOTAN_VERSION_CODE_FOR(1,8,0) +* #error "Botan version too old" +* #endif +*/ #define BOTAN_VERSION_CODE BOTAN_VERSION_CODE_FOR(BOTAN_VERSION_MAJOR, \ BOTAN_VERSION_MINOR, \ BOTAN_VERSION_PATCH) |