Skip to content

Version API

Markdown

This file provides the utility macros and constants needed for implementing compile/link-time version checking of the SH4ZAM library. SHZ_VERSION_INIT() packs major, minor and patch fields into a single unsigned 32-bit value that can be compared for equality or inequality. shz_version_linked() returns the version of the library you actually linked against, so it can be checked against the headers you compiled with.

  • C header: #include <sh4zam/shz_version.h>
  • C++ header: #include <sh4zam/shz_version.hpp>
  • C++ types: shz::version
  • Symbols: 9

Constants and methods for checking the compile-time SH4ZAM version.

SymbolDescription
SHZ_VERSION_MAJORCompile-time SH4ZAM major version.
SHZ_VERSION_MINORCompile-time SH4ZAM minor version.
SHZ_VERSION_PATCHCompile-time Sh4ZAM patch version.
SHZ_VERSIONCurrent SH4ZAM full compile-time version identifier, integer-compatible.
SHZ_VERSION_INITPacks values of individual version components into a SH4ZAM full version value.

Methods for checking the link-time SH4ZAM version.

SymbolDescription
shz_version_tInteger-compatible value type containing a full SH4ZAM version.
shz_versionVersion typedef for those who hate POSIX-style.
shz_version_linkedReturns the full version of SH4ZAM that was linked against.
shz_version_fieldsExtracts the individual version component values from a full version.