version.h

Go to the documentation of this file.

#ifndef VERSION_H
#define VERSION_H
 
#include <stdint.h>
#include <assert.h>
 
#define XSTR(x)  #x
#define STR(x)   XSTR(x)
 
#define PIXELKEY_VERSION_MAJOR   0      // Valid range: 0-255; do not add parentheses.
#define PIXELKEY_VERSION_MINOR   1      // Valid range: 0-255; do not add parentheses.
#define PIXELKEY_VERSION_PATCH   0      // Valid range: 0-999; do not add parentheses.
 
#define PIXELKEY_VERSION_STR     STR(PIXELKEY_VERSION_MAJOR)"."STR(PIXELKEY_VERSION_MINOR)"."STR(PIXELKEY_VERSION_PATCH)
 
static_assert(PIXELKEY_VERSION_MAJOR >= 0 && PIXELKEY_VERSION_MAJOR <= 255 && sizeof(STR(PIXELKEY_VERSION_MAJOR)) <= 4, "Major version field invalid.");
static_assert(PIXELKEY_VERSION_MINOR >= 0 && PIXELKEY_VERSION_MINOR <= 255 && sizeof(STR(PIXELKEY_VERSION_MINOR)) <= 4, "Minor version field invalid.");
static_assert(PIXELKEY_VERSION_PATCH >= 0 && PIXELKEY_VERSION_PATCH <= 999 && sizeof(STR(PIXELKEY_VERSION_PATCH)) <= 4, "Patch version field invalid.");
 
#define PIXELKEY_VERSION_STR_MAX_LENGTH     (12)    // 3 major + . + 3 minor + . + 3 patch + \0
 
#define PIXELKEY_PRODUCT_STR        "PixelKey"
#define PIXELKEY_PRODUCT_STR_LENGTH sizeof(PIXELKEY_PRODUCT_STR)
 
typedef union u_version
{
    struct
    {
        uint16_t patch; 
        uint8_t  minor; 
        uint8_t  major; 
    } version_b;        
    uint32_t version;   
} version_t;
 
static_assert(sizeof(version_t) == sizeof(uint32_t), "Version must be 32-bits.");
 
extern const version_t g_pixelkey_version;
extern const char g_pixelkey_version_str[PIXELKEY_VERSION_STR_MAX_LENGTH];
extern const char g_pixelkey_product_str[PIXELKEY_PRODUCT_STR_LENGTH];
 
#endif