3 * \brief The public API of liblzma
5 * liblzma is a LZMA compression library with a zlib-like API.
6 * liblzma is based on LZMA SDK found from http://7-zip.org/sdk.html.
8 * \author Copyright (C) 1999-2006 Igor Pavlov
9 * \author Copyright (C) 2007 Lasse Collin
11 * This library is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public
13 * License as published by the Free Software Foundation; either
14 * version 2.1 of the License, or (at your option) any later version.
16 * This library is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
25 /*****************************
26 * Required standard headers *
27 *****************************/
30 * liblzma API headers need some standard types and macros. To allow
31 * including lzma.h without requiring the application to include other
32 * headers first, lzma.h includes the required standard headers unless
33 * they already seem to be included already or if LZMA_MANUAL_HEADERS
36 * Here's what types and macros are needed and from which headers:
37 * - stddef.h: size_t, NULL
38 * - stdint.h: uint8_t, uint32_t, uint64_t, UINT32_C(n), uint64_C(n),
39 * UINT32_MAX, UINT64_MAX
41 * However, inttypes.h is a little more portable than stdint.h, although
42 * inttypes.h declares some unneeded things compared to plain stdint.h.
44 * The hacks below aren't perfect, specifically they assume that inttypes.h
45 * exists and that it typedefs at least uint8_t, uint32_t, and uint64_t,
46 * and that, in case of incomplete inttypes.h, unsigned int is 32-bit.
47 * If the application already takes care of setting up all the types and
48 * macros properly (for example by using gnulib's stdint.h or inttypes.h),
49 * we try to detect that the macros are already defined and don't include
50 * inttypes.h here again. However, you may define LZMA_MANUAL_HEADERS to
51 * force this file to never include any system headers.
53 * Some could argue that liblzma API should provide all the required types,
54 * for example lzma_uint64, LZMA_UINT64_C(n), and LZMA_UINT64_MAX. This was
55 * seen unnecessary mess, since most systems already provide all the necessary
56 * types and macros in the standard headers.
58 * Note that liblzma API still has lzma_bool, because using stdbool.h would
59 * break C89 and C++ programs on many systems. sizeof(bool) in C99 isn't
60 * necessarily the same as sizeof(bool) in C++.
63 #ifndef LZMA_MANUAL_HEADERS
65 * I suppose this works portably also in C++. Note that in C++,
66 * we need to get size_t into the global namespace.
71 * Skip inttypes.h if we already have all the required macros. If we
72 * have the macros, we assume that we have the matching typedefs too.
74 # if !defined(UINT32_C) || !defined(UINT64_C) \
75 || !defined(UINT32_MAX) || !defined(UINT64_MAX)
77 * MSVC has no C99 support, and thus it cannot be used to
78 * compile liblzma. The liblzma API has to still be usable
79 * from MSVC, so we need to define the required standard
82 # if defined(_WIN32) && defined(_MSC_VER)
83 typedef unsigned __int8 uint8_t;
84 typedef unsigned __int32 uint32_t;
85 typedef unsigned __int64 uint64_t;
87 /* Use the standard inttypes.h. */
90 * C99 sections 7.18.2 and 7.18.4 specify that
91 * in C++ implementations define the limit
92 * and constant macros only if specifically
93 * requested. Note that if you want the
94 * format macros (PRIu64 etc.) too, you need
95 * to define __STDC_FORMAT_MACROS before
96 * including lzma.h, since re-including
97 * inttypes.h with __STDC_FORMAT_MACROS
98 * defined doesn't necessarily work.
100 # ifndef __STDC_LIMIT_MACROS
101 # define __STDC_LIMIT_MACROS 1
103 # ifndef __STDC_CONSTANT_MACROS
104 # define __STDC_CONSTANT_MACROS 1
108 # include <inttypes.h>
112 * Some old systems have only the typedefs in inttypes.h, and
113 * lack all the macros. For those systems, we need a few more
114 * hacks. We assume that unsigned int is 32-bit and unsigned
115 * long is either 32-bit or 64-bit. If these hacks aren't
116 * enough, the application has to setup the types manually
117 * before including lzma.h.
120 # if defined(_WIN32) && defined(_MSC_VER)
121 # define UINT32_C(n) n ## UI32
123 # define UINT32_C(n) n ## U
128 # if defined(_WIN32) && defined(_MSC_VER)
129 # define UINT64_C(n) n ## UI64
133 # if ULONG_MAX == 4294967295UL
134 # define UINT64_C(n) n ## ULL
136 # define UINT64_C(n) n ## UL
142 # define UINT32_MAX (UINT32_C(4294967295))
146 # define UINT64_MAX (UINT64_C(18446744073709551615))
149 #endif /* ifdef LZMA_MANUAL_HEADERS */
157 * Some systems require (or at least recommend) that the functions and
158 * function pointers are declared specially in the headers.
161 # define LZMA_API_IMPORT __declspec(dllimport)
162 # define LZMA_API_CALL __cdecl
164 # define LZMA_API_IMPORT
165 # define LZMA_API_CALL
169 # define LZMA_API(type) LZMA_API_IMPORT type LZMA_API_CALL
173 /********************
175 ********************/
178 * GNU C extensions are used conditionally in the public API. It doesn't
179 * break anything if these are sometimes enabled and sometimes not, only
180 * affects warnings and optimizations.
183 # ifndef lzma_attribute
184 # define lzma_attribute(attr) __attribute__(attr)
187 # ifndef lzma_restrict
188 # define lzma_restrict __restrict__
191 /* warn_unused_result was added in GCC 3.4. */
192 # ifndef lzma_attr_warn_unused_result
193 # if __GNUC__ == 3 && __GNUC_MINOR__ < 4
194 # define lzma_attr_warn_unused_result
199 # ifndef lzma_attribute
200 # define lzma_attribute(attr)
203 # ifndef lzma_restrict
204 # if __STDC_VERSION__ >= 199901L
205 # define lzma_restrict restrict
207 # define lzma_restrict
213 #ifndef lzma_attr_pure
214 # define lzma_attr_pure lzma_attribute((__pure__))
217 #ifndef lzma_attr_const
218 # define lzma_attr_const lzma_attribute((__const__))
221 #ifndef lzma_attr_warn_unused_result
222 # define lzma_attr_warn_unused_result \
223 lzma_attribute((__warn_unused_result__))
236 * Subheaders check that this is defined. It is to prevent including
237 * them directly from applications.
239 #define LZMA_H_INTERNAL 1
242 #include "lzma/version.h"
243 #include "lzma/base.h"
244 #include "lzma/vli.h"
245 #include "lzma/check.h"
248 #include "lzma/filter.h"
249 #include "lzma/subblock.h"
250 #include "lzma/bcj.h"
251 #include "lzma/delta.h"
252 #include "lzma/lzma.h"
254 /* Container formats */
255 #include "lzma/container.h"
257 /* Advanced features */
258 #include "lzma/stream_flags.h"
259 #include "lzma/block.h"
260 #include "lzma/index.h"
261 #include "lzma/index_hash.h"
264 * All subheaders included. Undefine LZMA_H_INTERNAL to prevent applications
265 * re-including the subheaders.
267 #undef LZMA_H_INTERNAL
273 #endif /* ifndef LZMA_H */