OLD | NEW |
1 /** | 1 /** |
2 * \file api/lzma.h | 2 * \file api/lzma.h |
3 * \brief The public API of liblzma data compression library | 3 * \brief The public API of liblzma data compression library |
4 * | 4 * |
5 * liblzma is a public domain general-purpose data compression library with | 5 * liblzma is a public domain general-purpose data compression library with |
6 * a zlib-like API. The native file format is .xz, but also the old .lzma | 6 * a zlib-like API. The native file format is .xz, but also the old .lzma |
7 * format and raw (no headers) streams are supported. Multiple compression | 7 * format and raw (no headers) streams are supported. Multiple compression |
8 * algorithms (filters) are supported. Currently LZMA2 is the primary filter. | 8 * algorithms (filters) are supported. Currently LZMA2 is the primary filter. |
9 * | 9 * |
10 * liblzma is part of XZ Utils <http://tukaani.org/xz/>. XZ Utils includes | 10 * liblzma is part of XZ Utils <http://tukaani.org/xz/>. XZ Utils includes |
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
53 * exists and that it typedefs at least uint8_t, uint32_t, and uint64_t, | 53 * exists and that it typedefs at least uint8_t, uint32_t, and uint64_t, |
54 * and that, in case of incomplete inttypes.h, unsigned int is 32-bit. | 54 * and that, in case of incomplete inttypes.h, unsigned int is 32-bit. |
55 * If the application already takes care of setting up all the types and | 55 * If the application already takes care of setting up all the types and |
56 * macros properly (for example by using gnulib's stdint.h or inttypes.h), | 56 * macros properly (for example by using gnulib's stdint.h or inttypes.h), |
57 * we try to detect that the macros are already defined and don't include | 57 * we try to detect that the macros are already defined and don't include |
58 * inttypes.h here again. However, you may define LZMA_MANUAL_HEADERS to | 58 * inttypes.h here again. However, you may define LZMA_MANUAL_HEADERS to |
59 * force this file to never include any system headers. | 59 * force this file to never include any system headers. |
60 * | 60 * |
61 * Some could argue that liblzma API should provide all the required types, | 61 * Some could argue that liblzma API should provide all the required types, |
62 * for example lzma_uint64, LZMA_UINT64_C(n), and LZMA_UINT64_MAX. This was | 62 * for example lzma_uint64, LZMA_UINT64_C(n), and LZMA_UINT64_MAX. This was |
63 * seen unnecessary mess, since most systems already provide all the necessary | 63 * seen as an unnecessary mess, since most systems already provide all the |
64 * types and macros in the standard headers. | 64 * necessary types and macros in the standard headers. |
65 * | 65 * |
66 * Note that liblzma API still has lzma_bool, because using stdbool.h would | 66 * Note that liblzma API still has lzma_bool, because using stdbool.h would |
67 * break C89 and C++ programs on many systems. sizeof(bool) in C99 isn't | 67 * break C89 and C++ programs on many systems. sizeof(bool) in C99 isn't |
68 * necessarily the same as sizeof(bool) in C++. | 68 * necessarily the same as sizeof(bool) in C++. |
69 */ | 69 */ |
70 | 70 |
71 #ifndef LZMA_MANUAL_HEADERS | 71 #ifndef LZMA_MANUAL_HEADERS |
72 /* | 72 /* |
73 * I suppose this works portably also in C++. Note that in C++, | 73 * I suppose this works portably also in C++. Note that in C++, |
74 * we need to get size_t into the global namespace. | 74 * we need to get size_t into the global namespace. |
(...skipping 229 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
304 * All subheaders included. Undefine LZMA_H_INTERNAL to prevent applications | 304 * All subheaders included. Undefine LZMA_H_INTERNAL to prevent applications |
305 * re-including the subheaders. | 305 * re-including the subheaders. |
306 */ | 306 */ |
307 #undef LZMA_H_INTERNAL | 307 #undef LZMA_H_INTERNAL |
308 | 308 |
309 #ifdef __cplusplus | 309 #ifdef __cplusplus |
310 } | 310 } |
311 #endif | 311 #endif |
312 | 312 |
313 #endif /* ifndef LZMA_H */ | 313 #endif /* ifndef LZMA_H */ |
OLD | NEW |