| 1 | /** |
|---|
| 2 | * \file api/lzma.h |
|---|
| 3 | * \brief The public API of liblzma data compression library |
|---|
| 4 | * |
|---|
| 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 |
|---|
| 7 | * format and raw (no headers) streams are supported. Multiple compression |
|---|
| 8 | * algorithms (filters) are supported. Currently LZMA2 is the primary filter. |
|---|
| 9 | * |
|---|
| 10 | * liblzma is part of XZ Utils <http://tukaani.org/xz/>. XZ Utils includes |
|---|
| 11 | * a gzip-like command line tool named xz and some other tools. XZ Utils |
|---|
| 12 | * is developed and maintained by Lasse Collin. |
|---|
| 13 | * |
|---|
| 14 | * Major parts of liblzma are based on Igor Pavlov's public domain LZMA SDK |
|---|
| 15 | * <http://7-zip.org/sdk.html>. |
|---|
| 16 | * |
|---|
| 17 | * The SHA-256 implementation is based on the public domain code found from |
|---|
| 18 | * 7-Zip <http://7-zip.org/>, which has a modified version of the public |
|---|
| 19 | * domain SHA-256 code found from Crypto++ <http://www.cryptopp.com/>. |
|---|
| 20 | * The SHA-256 code in Crypto++ was written by Kevin Springle and Wei Dai. |
|---|
| 21 | */ |
|---|
| 22 | |
|---|
| 23 | /* |
|---|
| 24 | * Author: Lasse Collin |
|---|
| 25 | * |
|---|
| 26 | * This file has been put into the public domain. |
|---|
| 27 | * You can do whatever you want with this file. |
|---|
| 28 | */ |
|---|
| 29 | |
|---|
| 30 | #ifndef LZMA_H |
|---|
| 31 | #define LZMA_H |
|---|
| 32 | |
|---|
| 33 | /***************************** |
|---|
| 34 | * Required standard headers * |
|---|
| 35 | *****************************/ |
|---|
| 36 | |
|---|
| 37 | /* |
|---|
| 38 | * liblzma API headers need some standard types and macros. To allow |
|---|
| 39 | * including lzma.h without requiring the application to include other |
|---|
| 40 | * headers first, lzma.h includes the required standard headers unless |
|---|
| 41 | * they already seem to be included already or if LZMA_MANUAL_HEADERS |
|---|
| 42 | * has been defined. |
|---|
| 43 | * |
|---|
| 44 | * Here's what types and macros are needed and from which headers: |
|---|
| 45 | * - stddef.h: size_t, NULL |
|---|
| 46 | * - stdint.h: uint8_t, uint32_t, uint64_t, UINT32_C(n), uint64_C(n), |
|---|
| 47 | * UINT32_MAX, UINT64_MAX |
|---|
| 48 | * |
|---|
| 49 | * However, inttypes.h is a little more portable than stdint.h, although |
|---|
| 50 | * inttypes.h declares some unneeded things compared to plain stdint.h. |
|---|
| 51 | * |
|---|
| 52 | * The hacks below aren't perfect, specifically they assume that inttypes.h |
|---|
| 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. |
|---|
| 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), |
|---|
| 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 |
|---|
| 59 | * force this file to never include any system headers. |
|---|
| 60 | * |
|---|
| 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 |
|---|
| 63 | * seen as an unnecessary mess, since most systems already provide all the |
|---|
| 64 | * necessary types and macros in the standard headers. |
|---|
| 65 | * |
|---|
| 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 |
|---|
| 68 | * necessarily the same as sizeof(bool) in C++. |
|---|
| 69 | */ |
|---|
| 70 | |
|---|
| 71 | #ifndef LZMA_MANUAL_HEADERS |
|---|
| 72 | /* |
|---|
| 73 | * I suppose this works portably also in C++. Note that in C++, |
|---|
| 74 | * we need to get size_t into the global namespace. |
|---|
| 75 | */ |
|---|
| 76 | # include <stddef.h> |
|---|
| 77 | |
|---|
| 78 | /* |
|---|
| 79 | * Skip inttypes.h if we already have all the required macros. If we |
|---|
| 80 | * have the macros, we assume that we have the matching typedefs too. |
|---|
| 81 | */ |
|---|
| 82 | # if !defined(UINT32_C) || !defined(UINT64_C) \ |
|---|
| 83 | || !defined(UINT32_MAX) || !defined(UINT64_MAX) |
|---|
| 84 | /* |
|---|
| 85 | * MSVC versions older than 2013 have no C99 support, and |
|---|
| 86 | * thus they cannot be used to compile liblzma. Using an |
|---|
| 87 | * existing liblzma.dll with old MSVC can work though(*), |
|---|
| 88 | * but we need to define the required standard integer |
|---|
| 89 | * types here in a MSVC-specific way. |
|---|
| 90 | * |
|---|
| 91 | * (*) If you do this, the existing liblzma.dll probably uses |
|---|
| 92 | * a different runtime library than your MSVC-built |
|---|
| 93 | * application. Mixing runtimes is generally bad, but |
|---|
| 94 | * in this case it should work as long as you avoid |
|---|
| 95 | * the few rarely-needed liblzma functions that allocate |
|---|
| 96 | * memory and expect the caller to free it using free(). |
|---|
| 97 | */ |
|---|
| 98 | # if defined(_WIN32) && defined(_MSC_VER) && _MSC_VER < 1800 |
|---|
| 99 | typedef unsigned __int8 uint8_t; |
|---|
| 100 | typedef unsigned __int32 uint32_t; |
|---|
| 101 | typedef unsigned __int64 uint64_t; |
|---|
| 102 | # else |
|---|
| 103 | /* Use the standard inttypes.h. */ |
|---|
| 104 | # ifdef __cplusplus |
|---|
| 105 | /* |
|---|
| 106 | * C99 sections 7.18.2 and 7.18.4 specify |
|---|
| 107 | * that C++ implementations define the limit |
|---|
| 108 | * and constant macros only if specifically |
|---|
| 109 | * requested. Note that if you want the |
|---|
| 110 | * format macros (PRIu64 etc.) too, you need |
|---|
| 111 | * to define __STDC_FORMAT_MACROS before |
|---|
| 112 | * including lzma.h, since re-including |
|---|
| 113 | * inttypes.h with __STDC_FORMAT_MACROS |
|---|
| 114 | * defined doesn't necessarily work. |
|---|
| 115 | */ |
|---|
| 116 | # ifndef __STDC_LIMIT_MACROS |
|---|
| 117 | # define __STDC_LIMIT_MACROS 1 |
|---|
| 118 | # endif |
|---|
| 119 | # ifndef __STDC_CONSTANT_MACROS |
|---|
| 120 | # define __STDC_CONSTANT_MACROS 1 |
|---|
| 121 | # endif |
|---|
| 122 | # endif |
|---|
| 123 | |
|---|
| 124 | # include <inttypes.h> |
|---|
| 125 | # endif |
|---|
| 126 | |
|---|
| 127 | /* |
|---|
| 128 | * Some old systems have only the typedefs in inttypes.h, and |
|---|
| 129 | * lack all the macros. For those systems, we need a few more |
|---|
| 130 | * hacks. We assume that unsigned int is 32-bit and unsigned |
|---|
| 131 | * long is either 32-bit or 64-bit. If these hacks aren't |
|---|
| 132 | * enough, the application has to setup the types manually |
|---|
| 133 | * before including lzma.h. |
|---|
| 134 | */ |
|---|
| 135 | # ifndef UINT32_C |
|---|
| 136 | # if defined(_WIN32) && defined(_MSC_VER) |
|---|
| 137 | # define UINT32_C(n) n ## UI32 |
|---|
| 138 | # else |
|---|
| 139 | # define UINT32_C(n) n ## U |
|---|
| 140 | # endif |
|---|
| 141 | # endif |
|---|
| 142 | |
|---|
| 143 | # ifndef UINT64_C |
|---|
| 144 | # if defined(_WIN32) && defined(_MSC_VER) |
|---|
| 145 | # define UINT64_C(n) n ## UI64 |
|---|
| 146 | # else |
|---|
| 147 | /* Get ULONG_MAX. */ |
|---|
| 148 | # include <limits.h> |
|---|
| 149 | # if ULONG_MAX == 4294967295UL |
|---|
| 150 | # define UINT64_C(n) n ## ULL |
|---|
| 151 | # else |
|---|
| 152 | # define UINT64_C(n) n ## UL |
|---|
| 153 | # endif |
|---|
| 154 | # endif |
|---|
| 155 | # endif |
|---|
| 156 | |
|---|
| 157 | # ifndef UINT32_MAX |
|---|
| 158 | # define UINT32_MAX (UINT32_C(4294967295)) |
|---|
| 159 | # endif |
|---|
| 160 | |
|---|
| 161 | # ifndef UINT64_MAX |
|---|
| 162 | # define UINT64_MAX (UINT64_C(18446744073709551615)) |
|---|
| 163 | # endif |
|---|
| 164 | # endif |
|---|
| 165 | #endif /* ifdef LZMA_MANUAL_HEADERS */ |
|---|
| 166 | |
|---|
| 167 | |
|---|
| 168 | /****************** |
|---|
| 169 | * LZMA_API macro * |
|---|
| 170 | ******************/ |
|---|
| 171 | |
|---|
| 172 | /* |
|---|
| 173 | * Some systems require that the functions and function pointers are |
|---|
| 174 | * declared specially in the headers. LZMA_API_IMPORT is for importing |
|---|
| 175 | * symbols and LZMA_API_CALL is to specify the calling convention. |
|---|
| 176 | * |
|---|
| 177 | * By default it is assumed that the application will link dynamically |
|---|
| 178 | * against liblzma. #define LZMA_API_STATIC in your application if you |
|---|
| 179 | * want to link against static liblzma. If you don't care about portability |
|---|
| 180 | * to operating systems like Windows, or at least don't care about linking |
|---|
| 181 | * against static liblzma on them, don't worry about LZMA_API_STATIC. That |
|---|
| 182 | * is, most developers will never need to use LZMA_API_STATIC. |
|---|
| 183 | * |
|---|
| 184 | * The GCC variants are a special case on Windows (Cygwin and MinGW). |
|---|
| 185 | * We rely on GCC doing the right thing with its auto-import feature, |
|---|
| 186 | * and thus don't use __declspec(dllimport). This way developers don't |
|---|
| 187 | * need to worry about LZMA_API_STATIC. Also the calling convention is |
|---|
| 188 | * omitted on Cygwin but not on MinGW. |
|---|
| 189 | */ |
|---|
| 190 | #ifndef LZMA_API_IMPORT |
|---|
| 191 | # if !defined(LZMA_API_STATIC) && defined(_WIN32) && !defined(__GNUC__) |
|---|
| 192 | # define LZMA_API_IMPORT __declspec(dllimport) |
|---|
| 193 | # else |
|---|
| 194 | # define LZMA_API_IMPORT |
|---|
| 195 | # endif |
|---|
| 196 | #endif |
|---|
| 197 | |
|---|
| 198 | #ifndef LZMA_API_CALL |
|---|
| 199 | # if defined(_WIN32) && !defined(__CYGWIN__) |
|---|
| 200 | # define LZMA_API_CALL __cdecl |
|---|
| 201 | # else |
|---|
| 202 | # define LZMA_API_CALL |
|---|
| 203 | # endif |
|---|
| 204 | #endif |
|---|
| 205 | |
|---|
| 206 | #ifndef LZMA_API |
|---|
| 207 | # define LZMA_API(type) LZMA_API_IMPORT type LZMA_API_CALL |
|---|
| 208 | #endif |
|---|
| 209 | |
|---|
| 210 | |
|---|
| 211 | /*********** |
|---|
| 212 | * nothrow * |
|---|
| 213 | ***********/ |
|---|
| 214 | |
|---|
| 215 | /* |
|---|
| 216 | * None of the functions in liblzma may throw an exception. Even |
|---|
| 217 | * the functions that use callback functions won't throw exceptions, |
|---|
| 218 | * because liblzma would break if a callback function threw an exception. |
|---|
| 219 | */ |
|---|
| 220 | #ifndef lzma_nothrow |
|---|
| 221 | # if defined(__cplusplus) |
|---|
| 222 | # if __cplusplus >= 201103L |
|---|
| 223 | # define lzma_nothrow noexcept |
|---|
| 224 | # else |
|---|
| 225 | # define lzma_nothrow throw() |
|---|
| 226 | # endif |
|---|
| 227 | # elif defined(__GNUC__) && (__GNUC__ > 3 \ |
|---|
| 228 | || (__GNUC__ == 3 && __GNUC_MINOR__ >= 3)) |
|---|
| 229 | # define lzma_nothrow __attribute__((__nothrow__)) |
|---|
| 230 | # else |
|---|
| 231 | # define lzma_nothrow |
|---|
| 232 | # endif |
|---|
| 233 | #endif |
|---|
| 234 | |
|---|
| 235 | |
|---|
| 236 | /******************** |
|---|
| 237 | * GNU C extensions * |
|---|
| 238 | ********************/ |
|---|
| 239 | |
|---|
| 240 | /* |
|---|
| 241 | * GNU C extensions are used conditionally in the public API. It doesn't |
|---|
| 242 | * break anything if these are sometimes enabled and sometimes not, only |
|---|
| 243 | * affects warnings and optimizations. |
|---|
| 244 | */ |
|---|
| 245 | #if defined(__GNUC__) && __GNUC__ >= 3 |
|---|
| 246 | # ifndef lzma_attribute |
|---|
| 247 | # define lzma_attribute(attr) __attribute__(attr) |
|---|
| 248 | # endif |
|---|
| 249 | |
|---|
| 250 | /* warn_unused_result was added in GCC 3.4. */ |
|---|
| 251 | # ifndef lzma_attr_warn_unused_result |
|---|
| 252 | # if __GNUC__ == 3 && __GNUC_MINOR__ < 4 |
|---|
| 253 | # define lzma_attr_warn_unused_result |
|---|
| 254 | # endif |
|---|
| 255 | # endif |
|---|
| 256 | |
|---|
| 257 | #else |
|---|
| 258 | # ifndef lzma_attribute |
|---|
| 259 | # define lzma_attribute(attr) |
|---|
| 260 | # endif |
|---|
| 261 | #endif |
|---|
| 262 | |
|---|
| 263 | |
|---|
| 264 | #ifndef lzma_attr_pure |
|---|
| 265 | # define lzma_attr_pure lzma_attribute((__pure__)) |
|---|
| 266 | #endif |
|---|
| 267 | |
|---|
| 268 | #ifndef lzma_attr_const |
|---|
| 269 | # define lzma_attr_const lzma_attribute((__const__)) |
|---|
| 270 | #endif |
|---|
| 271 | |
|---|
| 272 | #ifndef lzma_attr_warn_unused_result |
|---|
| 273 | # define lzma_attr_warn_unused_result \ |
|---|
| 274 | lzma_attribute((__warn_unused_result__)) |
|---|
| 275 | #endif |
|---|
| 276 | |
|---|
| 277 | |
|---|
| 278 | /************** |
|---|
| 279 | * Subheaders * |
|---|
| 280 | **************/ |
|---|
| 281 | |
|---|
| 282 | #ifdef __cplusplus |
|---|
| 283 | extern "C" { |
|---|
| 284 | #endif |
|---|
| 285 | |
|---|
| 286 | /* |
|---|
| 287 | * Subheaders check that this is defined. It is to prevent including |
|---|
| 288 | * them directly from applications. |
|---|
| 289 | */ |
|---|
| 290 | #define LZMA_H_INTERNAL 1 |
|---|
| 291 | |
|---|
| 292 | /* Basic features */ |
|---|
| 293 | #include "lzma/version.h" |
|---|
| 294 | #include "lzma/base.h" |
|---|
| 295 | #include "lzma/vli.h" |
|---|
| 296 | #include "lzma/check.h" |
|---|
| 297 | |
|---|
| 298 | /* Filters */ |
|---|
| 299 | #include "lzma/filter.h" |
|---|
| 300 | #include "lzma/bcj.h" |
|---|
| 301 | #include "lzma/delta.h" |
|---|
| 302 | #include "lzma/lzma12.h" |
|---|
| 303 | |
|---|
| 304 | /* Container formats */ |
|---|
| 305 | #include "lzma/container.h" |
|---|
| 306 | |
|---|
| 307 | /* Advanced features */ |
|---|
| 308 | #include "lzma/stream_flags.h" |
|---|
| 309 | #include "lzma/block.h" |
|---|
| 310 | #include "lzma/index.h" |
|---|
| 311 | #include "lzma/index_hash.h" |
|---|
| 312 | |
|---|
| 313 | /* Hardware information */ |
|---|
| 314 | #include "lzma/hardware.h" |
|---|
| 315 | |
|---|
| 316 | /* |
|---|
| 317 | * All subheaders included. Undefine LZMA_H_INTERNAL to prevent applications |
|---|
| 318 | * re-including the subheaders. |
|---|
| 319 | */ |
|---|
| 320 | #undef LZMA_H_INTERNAL |
|---|
| 321 | |
|---|
| 322 | #ifdef __cplusplus |
|---|
| 323 | } |
|---|
| 324 | #endif |
|---|
| 325 | |
|---|
| 326 | #endif /* ifndef LZMA_H */ |
|---|
| 327 | |
|---|
