include/lzma/version.h

0001 /**
0002  * \file        lzma/version.h
0003  * \brief       Version number
0004  * \note        Never include this file directly. Use <lzma.h> instead.
0005  */
0006
0007 /*
0008  * Author: Lasse Collin
0009  *
0010  * This file has been put into the public domain.
0011  * You can do whatever you want with this file.
0012  */
0013
0014 #ifndef LZMA_H_INTERNAL
0015 #   error Never include this file directly. Use <lzma.h> instead.
0016 #endif
0017
0018
0019 /** \brief Major version number of the liblzma release. */
0020 #define LZMA_VERSION_MAJOR 5
0021
0022 /** \brief Minor version number of the liblzma release. */
0023 #define LZMA_VERSION_MINOR 4
0024
0025 /** \brief Patch version number of the liblzma release. */
0026 #define LZMA_VERSION_PATCH 6
0027
0028 /**
0029  * \brief Version stability marker
0030  *
0031  * This will always be one of three values:
0032  *   - LZMA_VERSION_STABILITY_ALPHA
0033  *   - LZMA_VERSION_STABILITY_BETA
0034  *   - LZMA_VERSION_STABILITY_STABLE
0035  */
0036 #define LZMA_VERSION_STABILITY LZMA_VERSION_STABILITY_STABLE
0037
0038 /** \brief Commit version number of the liblzma release */
0039 #ifndef LZMA_VERSION_COMMIT
0040 #   define LZMA_VERSION_COMMIT ""
0041 #endif
0042
0043
0044 /*
0045  * Map symbolic stability levels to integers.
0046  */
0047 #define LZMA_VERSION_STABILITY_ALPHA 0
0048 #define LZMA_VERSION_STABILITY_BETA 1
0049 #define LZMA_VERSION_STABILITY_STABLE 2
0050
0051
0052 /**
0053  * \brief       Compile-time version number
0054  *
0055  * The version number is of format xyyyzzzs where
0056  *  - x = major
0057  *  - yyy = minor
0058  *  - zzz = revision
0059  *  - s indicates stability: 0 = alpha, 1 = beta, 2 = stable
0060  *
0061  * The same xyyyzzz triplet is never reused with different stability levels.
0062  * For example, if 5.1.0alpha has been released, there will never be 5.1.0beta
0063  * or 5.1.0 stable.
0064  *
0065  * \note        The version number of liblzma has nothing to with
0066  *              the version number of Igor Pavlov's LZMA SDK.
0067  */
0068 #define LZMA_VERSION (LZMA_VERSION_MAJOR * UINT32_C(10000000) \
0069         + LZMA_VERSION_MINOR * UINT32_C(10000) \
0070         + LZMA_VERSION_PATCH * UINT32_C(10) \
0071         + LZMA_VERSION_STABILITY)
0072
0073
0074 /*
0075  * Macros to construct the compile-time version string
0076  */
0077 #if LZMA_VERSION_STABILITY == LZMA_VERSION_STABILITY_ALPHA
0078 #   define LZMA_VERSION_STABILITY_STRING "alpha"
0079 #elif LZMA_VERSION_STABILITY == LZMA_VERSION_STABILITY_BETA
0080 #   define LZMA_VERSION_STABILITY_STRING "beta"
0081 #elif LZMA_VERSION_STABILITY == LZMA_VERSION_STABILITY_STABLE
0082 #   define LZMA_VERSION_STABILITY_STRING ""
0083 #else
0084 #   error Incorrect LZMA_VERSION_STABILITY
0085 #endif
0086
0087 #define LZMA_VERSION_STRING_C_(major, minor, patch, stability, commit) \
0088         #major "." #minor "." #patch stability commit
0089
0090 #define LZMA_VERSION_STRING_C(major, minor, patch, stability, commit) \
0091         LZMA_VERSION_STRING_C_(major, minor, patch, stability, commit)
0092
0093
0094 /**
0095  * \brief       Compile-time version as a string
0096  *
0097  * This can be for example "4.999.5alpha", "4.999.8beta", or "5.0.0" (stable
0098  * versions don't have any "stable" suffix). In future, a snapshot built
0099  * from source code repository may include an additional suffix, for example
0100  * "4.999.8beta-21-g1d92". The commit ID won't be available in numeric form
0101  * in LZMA_VERSION macro.
0102  */
0103 #define LZMA_VERSION_STRING LZMA_VERSION_STRING_C( \
0104         LZMA_VERSION_MAJOR, LZMA_VERSION_MINOR, \
0105         LZMA_VERSION_PATCH, LZMA_VERSION_STABILITY_STRING, \
0106         LZMA_VERSION_COMMIT)
0107
0108
0109 /* #ifndef is needed for use with windres (MinGW-w64 or Cygwin). */
0110 #ifndef LZMA_H_INTERNAL_RC
0111
0112 /**
0113  * \brief       Run-time version number as an integer
0114  *
0115  * This allows an application to compare if it was built against the same,
0116  * older, or newer version of liblzma that is currently running.
0117  *
0118  * \return The value of LZMA_VERSION macro at the compile time of liblzma
0119  */
0120 extern LZMA_API(uint32_t) lzma_version_number(void)
0121         lzma_nothrow lzma_attr_const;
0122
0123
0124 /**
0125  * \brief       Run-time version as a string
0126  *
0127  * This function may be useful to display which version of liblzma an
0128  * application is currently using.
0129  *
0130  * \return      Run-time version of liblzma
0131  */
0132 extern LZMA_API(const char *) lzma_version_string(void)
0133         lzma_nothrow lzma_attr_const;
0134
0135 #endif