tr_version.h

Go to the documentation of this file.

/**
 * @file tr_version.h
 * @brief Version information for the tr_datastructures library
 *
 * This file is automatically generated by CMake from
 * @c cmake/tr_version.h.in — do not edit manually.
 * The version numbers are taken directly from the @c VERSION
 * field in the root @c CMakeLists.txt.
 *
 * Example usage:
 * @code
 * #include "tr_datastructures/tr_version.h"
 *
 * #if TR_VERSION_AT_LEAST(1, 0, 0)
 *     // use features from 1.0.0 onwards
 * #endif
 *
 * printf("TR_datastructures version: %s\n", TR_VERSION_STRING);
 * @endcode
 */
/*******************************************************************************************************
* NAME: tr_version.h
*
* PURPOSE: Version information for the tr_datastructures library
*          This file is generated by CMake - do not edit manually
*
* GLOBAL VARIABLES: None
*
* DEVELOPMENT HISTORY:
*
* Date          Author          Change Id       Release         Description Of Change
* ----------    --------------- ---------       -------         -----------------------------------
* 24-05-2026    Tiago Rodrigues                       1         File preparation
*
*******************************************************************************************************/
#ifndef TR_VERSION_H
#define TR_VERSION_H
 
/* 0 copyright/licensing */
/*******************************************************************************************************
*
* This is free and unencumbered software released into the public domain (Unlicense).
*
********************************************************************************************************/
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/* 1 includes */
/*****************************************************/
/*****************************************************/
 
 
/* 2 defines */
/*****************************************************/
 
/* ------------------------------------------------------------------
 * 2.1 Version numbers
 * These are automatically populated by CMake from the project()
 * VERSION field in the root CMakeLists.txt
 * ------------------------------------------------------------------ */
 
 /**
 * @defgroup tr_version_numbers Version Number Macros
 * @{
 *
 * @brief Individual version component macros
 *
 * These are set automatically by CMake from the project VERSION field.
 * Prefer @ref TR_VERSION_AT_LEAST for version comparisons.
 *
 * | Macro              | Description              | Example |
 * |--------------------|--------------------------|---------|
 * | TR_VERSION_MAJOR   | Major version number     | 0       |
 * | TR_VERSION_MINOR   | Minor version number     | 1       |
 * | TR_VERSION_PATCH   | Patch version number     | 0       |
 * | TR_VERSION_STRING  | Full version as a string | "0.1.0" |
 */
 
#define TR_VERSION_MAJOR 0  /**< Major version number     */
#define TR_VERSION_MINOR 1  /**< Minor version number     */
#define TR_VERSION_PATCH 0  /**< Patch version number     */
#define TR_VERSION_STRING "0.1.0"     /**< Full version string      */
 
/** @} */ /* end of tr_version_numbers group */
 
 
/* ------------------------------------------------------------------
 * 2.2 Version encoding
 * Encodes the full version into a single integer for easy comparison
 * e.g. version 1.2.3 becomes 0x00010203
 * Usage: #if TR_VERSION >= TR_VERSION_ENCODE(1, 2, 0)
 * ------------------------------------------------------------------ */
/**
 * @brief Encodes major, minor and patch into a single integer
 *
 * Packs three version components into a single 32 bit integer
 * for easy numerical comparison. The encoding is:
 * @code
 * (major << 16) | (minor << 8) | patch
 * @endcode
 *
 * Example — version 1.2.3 encodes to 0x00010203:
 * @code
 * #if TR_VERSION >= TR_VERSION_ENCODE(1, 2, 0)
 *     // version is at least 1.2.0
 * #endif
 * @endcode
 *
 * @param major Major version component
 * @param minor Minor version component
 * @param patch Patch version component
 */
#define TR_VERSION_ENCODE(major, minor, patch) \
    (((major) << 16) | ((minor) << 8) | (patch))
 
/**
 * @brief Current library version encoded as a single integer
 *
 * Combines @ref TR_VERSION_MAJOR, @ref TR_VERSION_MINOR and
 * @ref TR_VERSION_PATCH into a single integer using
 * @ref TR_VERSION_ENCODE. Use with @ref TR_VERSION_AT_LEAST
 * for version checks.
 *
 * Example:
 * @code
 * printf("Version code: 0x%06X\n", TR_VERSION);
 * @endcode
 */
#define TR_VERSION \
    TR_VERSION_ENCODE(TR_VERSION_MAJOR, TR_VERSION_MINOR, TR_VERSION_PATCH)
 
 
/* ------------------------------------------------------------------
 * 2.3 Version check macro
 * Returns 1 if the current version is at least major.minor.patch
 * Usage: #if TR_VERSION_AT_LEAST(1, 2, 0)
 * ------------------------------------------------------------------ */
/**
 * @brief Checks if the current version is at least major.minor.patch
 *
 * The recommended way to perform compile time version checks.
 * Evaluates to 1 if the current library version is greater than
 * or equal to the specified version, 0 otherwise.
 *
 * Example:
 * @code
 * #if TR_VERSION_AT_LEAST(1, 0, 0)
 *     // safe to use features added in 1.0.0
 * #endif
 * @endcode
 *
 * @param major Required major version
 * @param minor Required minor version
 * @param patch Required patch version
 */
#define TR_VERSION_AT_LEAST(major, minor, patch) \
    (TR_VERSION >= TR_VERSION_ENCODE(major, minor, patch))
 
 
// clang-format off
/*****************************************************/
 
/* 3 external declarations */
/*****************************************************/
/*****************************************************/
 
/* 4 typedefs */
/*****************************************************/
/*****************************************************/
 
/* 5 global variable declarations */
/*****************************************************/
/*****************************************************/
 
/* 6 function prototypes */
/*****************************************************/
/*****************************************************/
// clang-format on
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* TR_VERSION_H */