version.h File Reference

Go to the source code of this file.

Macros
#define	LZMA_VERSION_MAJOR   5
	Major version number of the liblzma release.
#define	LZMA_VERSION_MINOR   6
	Minor version number of the liblzma release.
#define	LZMA_VERSION_PATCH   2
	Patch version number of the liblzma release.
#define	LZMA_VERSION_STABILITY   LZMA_VERSION_STABILITY_STABLE
	Version stability marker.
#define	LZMA_VERSION_COMMIT   ""
	Commit version number of the liblzma release.
#define	LZMA_VERSION_STABILITY_ALPHA   0
#define	LZMA_VERSION_STABILITY_BETA   1
#define	LZMA_VERSION_STABILITY_STABLE   2
#define	LZMA_VERSION
	Compile-time version number.
#define	LZMA_VERSION_STABILITY_STRING   ""
#define	LZMA_VERSION_STRING_C_(major, minor, patch, stability, commit)
#define	LZMA_VERSION_STRING_C(major, minor, patch, stability, commit)
#define	LZMA_VERSION_STRING
	Compile-time version as a string.

Functions
	LZMA_API (uint32_t) lzma_version_number(void) lzma_nothrow lzma_attr_const
	Run-time version number as an integer.
	LZMA_API (const char *) lzma_version_string(void) lzma_nothrow lzma_attr_const
	Run-time version as a string.

Macro Definition Documentation

LZMA_VERSION

#define LZMA_VERSION

Value:

        (LZMA_VERSION_MAJOR * UINT32_C(10000000) \
        + LZMA_VERSION_MINOR * UINT32_C(10000) \
        + LZMA_VERSION_PATCH * UINT32_C(10) \
        + LZMA_VERSION_STABILITY)

Compile-time version number.

The version number is of format xyyyzzzs where

• x = major
• yyy = minor
• zzz = revision
• s indicates stability: 0 = alpha, 1 = beta, 2 = stable

The same xyyyzzz triplet is never reused with different stability levels. For example, if 5.1.0alpha has been released, there will never be 5.1.0beta or 5.1.0 stable.

Note

The version number of liblzma has nothing to with the version number of Igor Pavlov's LZMA SDK.

LZMA_VERSION_COMMIT

#define LZMA_VERSION_COMMIT   ""

Commit version number of the liblzma release.

LZMA_VERSION_MAJOR

#define LZMA_VERSION_MAJOR   5

Major version number of the liblzma release.

LZMA_VERSION_MINOR

#define LZMA_VERSION_MINOR   6

Minor version number of the liblzma release.

LZMA_VERSION_PATCH

#define LZMA_VERSION_PATCH   2

Patch version number of the liblzma release.

LZMA_VERSION_STABILITY

#define LZMA_VERSION_STABILITY   LZMA_VERSION_STABILITY_STABLE

Version stability marker.

This will always be one of three values:

• LZMA_VERSION_STABILITY_ALPHA
• LZMA_VERSION_STABILITY_BETA
• LZMA_VERSION_STABILITY_STABLE

LZMA_VERSION_STABILITY_ALPHA

#define LZMA_VERSION_STABILITY_ALPHA   0

LZMA_VERSION_STABILITY_BETA

#define LZMA_VERSION_STABILITY_BETA   1

LZMA_VERSION_STABILITY_STABLE

#define LZMA_VERSION_STABILITY_STABLE   2

LZMA_VERSION_STABILITY_STRING

#define LZMA_VERSION_STABILITY_STRING   ""

LZMA_VERSION_STRING

#define LZMA_VERSION_STRING

Value:

        LZMA_VERSION_STRING_C( \
        LZMA_VERSION_MAJOR, LZMA_VERSION_MINOR, \
        LZMA_VERSION_PATCH, LZMA_VERSION_STABILITY_STRING, \
        LZMA_VERSION_COMMIT)

Compile-time version as a string.

This can be for example "4.999.5alpha", "4.999.8beta", or "5.0.0" (stable versions don't have any "stable" suffix). In future, a snapshot built from source code repository may include an additional suffix, for example "4.999.8beta-21-g1d92". The commit ID won't be available in numeric form in LZMA_VERSION macro.

LZMA_VERSION_STRING_C

#define LZMA_VERSION_STRING_C	(		major,
			minor,
			patch,
			stability,
			commit )

Value:

        LZMA_VERSION_STRING_C_(major, minor, patch, stability, commit)

LZMA_VERSION_STRING_C_

#define LZMA_VERSION_STRING_C_	(		major,
			minor,
			patch,
			stability,
			commit )

Value:

        #major "." #minor "." #patch stability commit

Function Documentation

LZMA_API() [1/2]

LZMA_API ( const char * ) const

extern

Run-time version as a string.

This function may be useful to display which version of liblzma an application is currently using.

Returns

Run-time version of liblzma

This function may be useful if you want to display which version of liblzma your application is currently using.

LZMA_API() [2/2]

LZMA_API ( uint32_t ) const

extern

Run-time version number as an integer.

This allows an application to compare if it was built against the same, older, or newer version of liblzma that is currently running.

Returns

The value of LZMA_VERSION macro at the compile time of liblzma

Get the number of bytes required to encode a VLI.

Run-time version number as an integer.

Get the number of processor cores or threads.

Calculate CRC32.

Although not all Check IDs have a check algorithm associated, the size of every Check is already frozen. This function returns the size (in bytes) of the Check field with the specified Check ID. The values are: { 0, 4, 4, 4, 8, 8, 8, 16, 16, 16, 32, 32, 32, 64, 64, 64 }

If the argument is not in the range [0, 15], UINT32_MAX is returned.

Calculate CRC32 using the polynomial from the IEEE 802.3 standard.

Parameters

buf	Pointer to the input buffer
size	Size of the input buffer
crc	Previously returned CRC value. This is used to calculate the CRC of a big buffer in smaller chunks. Set to zero when starting a new calculation.

Returns

Updated CRC value, which can be passed to this function again to continue CRC calculation.