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.
21 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
23 * Before #including this file, you must make the following types available:
31 * Before #including this file, you must make the following macros available:
37 * Easiest way to achieve the above is to #include sys/types.h and inttypes.h
38 * before #including lzma.h. However, some pre-C99 libc headers don't provide
39 * all the required types in inttypes.h (that file may even be missing).
40 * Portable applications need to provide these types themselves. This way
41 * liblzma API can use the standard types instead of defining its own
44 * Note that the API still has lzma_bool, because using stdbool.h would
45 * break C89 and C++ programs on many systems.
56 * GCC extensions are used conditionally in the public API. It doesn't
57 * break anything if these are sometimes enabled and sometimes not, only
58 * affects warnings and optimizations.
60 #if defined(__GNUC__) && __GNUC__ >= 3
61 # ifndef lzma_attribute
62 # define lzma_attribute(attr) __attribute__(attr)
64 # ifndef lzma_restrict
65 # define lzma_restrict __restrict__
68 # ifndef lzma_attribute
69 # define lzma_attribute(attr)
71 # ifndef lzma_restrict
72 # define lzma_restrict
86 * Subheaders check that this is defined. It is to prevent including
87 * them directly from applications.
89 #define LZMA_H_INTERNAL 1
92 #include "lzma/init.h"
93 #include "lzma/base.h"
95 #include "lzma/filter.h"
96 #include "lzma/check.h"
99 #include "lzma/subblock.h"
100 #include "lzma/simple.h"
101 #include "lzma/delta.h"
102 #include "lzma/lzma.h"
104 /* Container formats */
105 #include "lzma/block.h"
106 #include "lzma/stream.h"
107 #include "lzma/alone.h"
108 #include "lzma/raw.h"
109 #include "lzma/auto.h"
110 #include "lzma/easy.h"
112 /* Advanced features */
113 #include "lzma/index.h"
114 #include "lzma/index_hash.h"
115 #include "lzma/alignment.h"
116 #include "lzma/stream_flags.h"
117 #include "lzma/memlimit.h"
120 #include "lzma/version.h"
123 * All subheaders included. Undefine LZMA_H_INTERNAL to prevent applications
124 * re-including the subheaders.
126 #undef LZMA_H_INTERNAL
132 #endif /* ifndef LZMA_H */