version.h

Go to the documentation of this file.

 
#ifndef __TBOX_VERSION_H__
#define __TBOX_VERSION_H__
#pragma once

 
/* clang-format off */
 
#define TBOX_VERSION_MAJOR 0

#define TBOX_VERSION_MINOR 1

#define TBOX_VERSION_PATCH 0

#define TBOX_VERSION_STRING "0.1.0"

#define TBOX_CONFIGURED_API (TBOX_VERSION_MAJOR * 10000 + TBOX_VERSION_MINOR * 100)

#define TBOX_COMMIT_SHORT "a53dfab"

#define TBOX_COMMIT_LONG "a53dfab9b6df800caf10f0ed5a36b6d083cf0681"

#define TBOX_BUILD_DATE __DATE__

#define TBOX_BUILD_TIME __TIME__
 
/* clang-format on */


 
/* Helper macros for CPP string composition */
#define TBOX_MSTR_HELPER(x) #x
#define TBOX_MSTR(x)        TBOX_MSTR_HELPER(x)
 
/*
 * Generic deprecation macro
 *
 * If TBOX_SUPPRESS_DEPRECATED is defined, then TBOX_DEPRECATED and
 * TBOX_DEPRECATED_FOR become no-ops
 */
#ifndef TBOX_DEPRECATED
#undef TBOX_DEPRECATED_FOR
#ifndef TBOX_SUPPRESS_DEPRECATED
#if defined(_MSC_VER)
/*
 * MSVC supports __declspec(deprecated) since MSVC 2003 (13.10),
 * and __declspec(deprecated(message)) since MSVC 2005 (14.00)
 */
#if _MSC_VER >= 1400
#define TBOX_DEPRECATED(since)              __declspec(deprecated("Since T-Box " #since))
#define TBOX_DEPRECATED_FOR(since, message) __declspec(deprecated("Since T-Box " #since ";" message))
#define TBOX_DEPRECATED_MESSAGE(message)    __declspec(deprecated(message))
#elif _MSC_VER >= 1310
#define TBOX_DEPRECATED(since)              __declspec(deprecated)
#define TBOX_DEPRECATED_FOR(since, message) __declspec(deprecated)
#define TBOX_DEPRECATED_MESSAGE(message)    __declspec(deprecated)
#endif
#define TBOX_BEGIN_ALLOW_DEPRECATED __pragma(warning(push)) __pragma(warning(disable : 4996))
#define TBOX_END_ALLOW_DEPRECATED   __pragma(warning(pop))
#elif defined(__GNUC__)
/*
 * According to GCC documentation, deprecations with message appeared in
 * GCC 4.5.0
 */
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
#define TBOX_DEPRECATED(since)              __attribute__((deprecated("Since T-Box " #since)))
#define TBOX_DEPRECATED_FOR(since, message) __attribute__((deprecated("Since T-Box " #since ";" message)))
#define TBOX_DEPRECATED_MESSAGE(message)    __attribute__((deprecated(message)))
#elif __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ > 0)
#define TBOX_DEPRECATED(since)              __attribute__((deprecated))
#define TBOX_DEPRECATED_FOR(since, message) __attribute__((deprecated))
#define TBOX_DEPRECATED_MESSAGE(message)    __attribute__((deprecated))
#endif
#define TBOX_BEGIN_ALLOW_DEPRECATED                                                                                    \
    _Pragma("GCC diagnostic push") _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
#define TBOX_END_ALLOW_DEPRECATED _Pragma("GCC diagnostic pop")
#elif defined(__SUNPRO_C)
#if (__SUNPRO_C >= 0x5130)
#define TBOX_DEPRECATED(since)              __attribute__((deprecated))
#define TBOX_DEPRECATED_FOR(since, message) __attribute__((deprecated))
#define TBOX_DEPRECATED_MESSAGE(message)    __attribute__((deprecated))
#endif /* (__SUNPRO_C >= 0x5130) */
#define TBOX_BEGIN_ALLOW_DEPRECATED #pragma error_messages(off, E_DEPRECATED_ATT, E_DEPRECATED_ATT_MESS)
#define TBOX_END_ALLOW_DEPRECATED   #pragma error_messages(on, E_DEPRECATED_ATT, E_DEPRECATED_ATT_MESS)
#endif /* __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5) */
#endif /* _MSC_VER */
#endif /* TBOX_DEPRECATED */
 
/*
 * Still not defined?  Then define no-op macros. This means these macros
 * are unsuitable for use in a typedef except TBOX_DEPRECATED_MESSAGE.
 */
#ifndef TBOX_DEPRECATED
#define TBOX_DEPRECATED(since)              extern
#define TBOX_DEPRECATED_FOR(since, message) extern
#define TBOX_DEPRECATED_MESSAGE(message)
#define TBOX_BEGIN_ALLOW_DEPRECATED
#define TBOX_END_ALLOW_DEPRECATED
#endif /* TBOX_DEPRECATED */
 
/*
 * Applications should use -DTBOX_API_COMPAT=<version> to suppress the
 * declarations of functions deprecated in or before <version>.  If this is
 * undefined, the value of the macro TBOX_CONFIGURED_API is the default.
 *
 * For our version numbering scheme, <version> is expected to be a computation
 * of the major and minor numbers in decimal using this formula:
 *
 *     MAJOR * 10000 + MINOR * 100
 *
 * So version 1.0 becomes 10000, version 2.2 becomes 20200, etc.
 */
 
/*
 * We use the TBOX_API_COMPAT value to define API level macros.  These
 * macros are used to enable or disable features at that API version boundary.
 */
 
#ifdef TBOX_API_LEVEL
#error "TBOX_API_LEVEL must not be defined by application"
#endif
 
/*
 * We figure out what API level was intended by simple numeric comparison.
 * The lowest old style number we recognise is 0x10000L, so we take some
 * safety margin and assume that anything below 0x00900000L is a new style
 * number. This allows new versions up to and including v943.71.83.
 */
#ifdef TBOX_API_COMPAT
#if TBOX_API_COMPAT < 0x00900000L
#define TBOX_API_LEVEL TBOX_API_COMPAT
#else
#define TBOX_API_LEVEL                                                                                                 \
    (((TBOX_API_COMPAT >> 28) & 0xF) * 10000 + ((TBOX_API_COMPAT >> 20) & 0xFF) * 100 +                                \
     ((TBOX_API_COMPAT >> 12) & 0xFF))
#endif
#endif
 
/*
 * If TBOX_API_COMPAT wasn't given, we use default numbers to set
 * the API compatibility level.
 */
#ifndef TBOX_API_LEVEL
#if TBOX_CONFIGURED_API > 0
#define TBOX_API_LEVEL (TBOX_CONFIGURED_API)
#else
#define TBOX_API_LEVEL (TBOX_VERSION_MAJOR * 10000 + TBOX_VERSION_MINOR * 100)
#endif
#endif
 
#if TBOX_API_LEVEL > TBOX_CONFIGURED_API
#error "The requested API level higher than the configured API compatibility level"
#endif
 
/*
 * Check of sane values.
 */
/* Can't go higher than the current version. */
#if TBOX_API_LEVEL > (TBOX_VERSION_MAJOR * 10000 + TBOX_VERSION_MINOR * 100)
#error "TBOX_API_COMPAT expresses an impossible API compatibility level"
#endif
 
/*
 * Define macros for deprecation and simulated removal purposes.
 *
 * The macros TBOX_DEPRECATEDIN_{major}_{minor} are always defined for
 * all SSS Application versions we care for. They can be used as attributes
 * in function declarations where appropriate.
 *
 * The macros TBOX_NO_DEPRECATED_{major}_{minor} are defined for
 * all SSS Application versions up to or equal to the version given with
 * TBOX_API_COMPAT.  They are used as guards around anything that's
 * deprecated up to that version, as an effect of the developer option
 * 'no-deprecated'.
 */
 
#undef TBOX_NO_DEPRECATED_1_0_0
 
#if TBOX_API_LEVEL >= 10000
#ifndef TBOX_NO_DEPRECATED
#define TBOX_DEPRECATEDIN_1_0_0          TBOX_DEPRECATED(1.0.0)
#define TBOX_DEPRECATEDIN_1_0_0_FOR(msg) TBOX_DEPRECATED_FOR(1.0.0, msg)
#else
#define TBOX_NO_DEPRECATED_1_0_0
#endif
#else
#define TBOX_DEPRECATEDIN_1_0_0
#define TBOX_DEPRECATEDIN_1_0_0_FOR(msg)
#endif

 
#endif /* __TBOX_VERSION_H__ */