]> git.pld-linux.org Git - packages/xz.git/blame - lzma-lzmalib.patch
- License is basically LGPL v2.1+;
[packages/xz.git] / lzma-lzmalib.patch
CommitLineData
da8addba
PS
1 C/7zip/Compress/LZMA/LZMADecoder.cpp | 11
2 C/7zip/Compress/LZMA/LZMADecoder.h | 1
3 C/7zip/Compress/LZMA/LZMAEncoder.cpp | 10
4 C/Common/CommandLineParser.h | 2
5 C/Common/String.cpp | 2
6 C/Common/StringConvert.h | 2
7 ZLib.cpp | 4
8 lzmalib.h | 1362 +++++++++++++++++++++++++++++++++++
9 8 files changed, 1386 insertions(+), 8 deletions(-)
10
11Index: lzma/C/7zip/Compress/LZMA/LZMADecoder.cpp
12===================================================================
13--- lzma.orig/C/7zip/Compress/LZMA/LZMADecoder.cpp 2006-10-31 10:49:28.000000000 +1100
14+++ lzma/C/7zip/Compress/LZMA/LZMADecoder.cpp 2006-10-31 10:49:28.000000000 +1100
15@@ -274,12 +274,17 @@ STDMETHODIMP CDecoder::SetDecoderPropert
16 Byte remainder = (Byte)(properties[0] / 9);\r
17 int lp = remainder % 5;\r
18 int pb = remainder / 5;\r
19- if (pb > NLength::kNumPosStatesBitsMax)\r
20- return E_INVALIDARG;\r
21- _posStateMask = (1 << pb) - 1;\r
22 UInt32 dictionarySize = 0;\r
23 for (int i = 0; i < 4; i++)\r
24 dictionarySize += ((UInt32)(properties[1 + i])) << (i * 8);\r
25+ return SetDecoderPropertiesRaw(lc, lp, pb, dictionarySize);\r
26+}\r
27+\r
28+STDMETHODIMP CDecoder::SetDecoderPropertiesRaw(int lc, int lp, int pb, UInt32 dictionarySize)\r
29+{\r
30+ if (pb > NLength::kNumPosStatesBitsMax)\r
31+ return E_INVALIDARG;\r
32+ _posStateMask = (1 << pb) - 1;\r
33 if (!_outWindowStream.Create(dictionarySize))\r
34 return E_OUTOFMEMORY;\r
35 if (!_literalDecoder.Create(lp, lc))\r
36Index: lzma/C/7zip/Compress/LZMA/LZMADecoder.h
37===================================================================
38--- lzma.orig/C/7zip/Compress/LZMA/LZMADecoder.h 2006-10-31 10:49:28.000000000 +1100
39+++ lzma/C/7zip/Compress/LZMA/LZMADecoder.h 2006-10-31 21:05:37.000000000 +1100
40@@ -242,6 +242,7 @@ public:\r
41 STDMETHOD(Read)(void *data, UInt32 size, UInt32 *processedSize);\r
42 #endif\r
43 \r
44+ STDMETHOD(SetDecoderPropertiesRaw)(int lc, int lp, int pb, UInt32 dictionarySize);\r
45 CDecoder(): _outSizeDefined(false) {}\r
46 virtual ~CDecoder() {}\r
47 };\r
48Index: lzma/C/7zip/Compress/LZMA/LZMAEncoder.cpp
49===================================================================
50--- lzma.orig/C/7zip/Compress/LZMA/LZMAEncoder.cpp 2006-10-31 10:49:28.000000000 +1100
51+++ lzma/C/7zip/Compress/LZMA/LZMAEncoder.cpp 2006-10-31 21:21:22.000000000 +1100
52@@ -484,12 +484,22 @@ STDMETHODIMP CEncoder::SetCoderPropertie
53 \r
54 STDMETHODIMP CEncoder::WriteCoderProperties(ISequentialOutStream *outStream)\r
55 { \r
56+ Byte firstByte = (_posStateBits * 5 + _numLiteralPosStateBits) * 9 + _numLiteralContextBits;\r
57+ RINOK(outStream->Write(&firstByte, sizeof(firstByte), NULL));\r
58+ for (int i = 0; i < 4; i++)\r
59+ {\r
60+ Byte b = Byte(_dictionarySize >> (8 * i));\r
61+ RINOK(outStream->Write(&b, sizeof(b), NULL));\r
62+ }\r
63+ return S_OK;\r
64+#if 0\r
65 const UInt32 kPropSize = 5;\r
66 Byte properties[kPropSize];\r
67 properties[0] = (_posStateBits * 5 + _numLiteralPosStateBits) * 9 + _numLiteralContextBits;\r
68 for (int i = 0; i < 4; i++)\r
69 properties[1 + i] = Byte(_dictionarySize >> (8 * i));\r
70 return WriteStream(outStream, properties, kPropSize, NULL);\r
71+#endif\r
72 }\r
73 \r
74 STDMETHODIMP CEncoder::SetOutStream(ISequentialOutStream *outStream)\r
75Index: lzma/lzmalib.h
76===================================================================
77--- /dev/null 1970-01-01 00:00:00.000000000 +0000
4ac3cfc7 78+++ ./C/7zip/Compress/LZMA_Lib/lzmalib.h 2006-10-31 13:56:37.000000000 +1100
da8addba
PS
79@@ -0,0 +1,1362 @@
80+/* lzmalib.h - altered version of zlib.h
81+ zlib.h -- interface of the 'zlib' general purpose compression library
82+ version 1.2.3, July 18th, 2005
83+
84+ Copyright (C) 1995-2005 Jean-loup Gailly and Mark Adler
85+
86+ This software is provided 'as-is', without any express or implied
87+ warranty. In no event will the authors be held liable for any damages
88+ arising from the use of this software.
89+
90+ Permission is granted to anyone to use this software for any purpose,
91+ including commercial applications, and to alter it and redistribute it
92+ freely, subject to the following restrictions:
93+
94+ 1. The origin of this software must not be misrepresented; you must not
95+ claim that you wrote the original software. If you use this software
96+ in a product, an acknowledgment in the product documentation would be
97+ appreciated but is not required.
98+ 2. Altered source versions must be plainly marked as such, and must not be
99+ misrepresented as being the original software.
100+ 3. This notice may not be removed or altered from any source distribution.
101+
102+ Jean-loup Gailly Mark Adler
103+ jloup@gzip.org madler@alumni.caltech.edu
104+
105+
106+ The data format used by the zlib library is described by RFCs (Request for
107+ Comments) 1950 to 1952 in the files http://www.ietf.org/rfc/rfc1950.txt
108+ (zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format).
109+*/
110+
111+#ifndef ZLIB_H
112+#define ZLIB_H
113+
114+#include "zconf.h"
115+
116+#ifdef __cplusplus
117+extern "C" {
118+#endif
119+
120+#define ZLIB_VERSION "1.2.3"
121+#define ZLIB_VERNUM 0x1230
122+
123+/*
124+ The 'zlib' compression library provides in-memory compression and
125+ decompression functions, including integrity checks of the uncompressed
126+ data. This version of the library supports only one compression method
127+ (deflation) but other algorithms will be added later and will have the same
128+ stream interface.
129+
130+ Compression can be done in a single step if the buffers are large
131+ enough (for example if an input file is mmap'ed), or can be done by
132+ repeated calls of the compression function. In the latter case, the
133+ application must provide more input and/or consume the output
134+ (providing more output space) before each call.
135+
136+ The compressed data format used by default by the in-memory functions is
137+ the zlib format, which is a zlib wrapper documented in RFC 1950, wrapped
138+ around a deflate stream, which is itself documented in RFC 1951.
139+
140+ The library also supports reading and writing files in gzip (.gz) format
141+ with an interface similar to that of stdio using the functions that start
142+ with "gz". The gzip format is different from the zlib format. gzip is a
143+ gzip wrapper, documented in RFC 1952, wrapped around a deflate stream.
144+
145+ This library can optionally read and write gzip streams in memory as well.
146+
147+ The zlib format was designed to be compact and fast for use in memory
148+ and on communications channels. The gzip format was designed for single-
149+ file compression on file systems, has a larger header than zlib to maintain
150+ directory information, and uses a different, slower check method than zlib.
151+
152+ The library does not install any signal handler. The decoder checks
153+ the consistency of the compressed data, so the library should never
154+ crash even in case of corrupted input.
155+*/
156+
157+typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size));
158+typedef void (*free_func) OF((voidpf opaque, voidpf address));
159+
160+struct internal_state;
161+
162+typedef struct z_stream_s {
163+ Bytef *next_in; /* next input byte */
164+ uInt avail_in; /* number of bytes available at next_in */
165+ uLong total_in; /* total nb of input bytes read so far */
166+
167+ Bytef *next_out; /* next output byte should be put there */
168+ uInt avail_out; /* remaining free space at next_out */
169+ uLong total_out; /* total nb of bytes output so far */
170+
171+ char *msg; /* last error message, NULL if no error */
172+ struct internal_state FAR *state; /* not visible by applications */
173+
174+ alloc_func zalloc; /* used to allocate the internal state */
175+ free_func zfree; /* used to free the internal state */
176+ voidpf opaque; /* private data object passed to zalloc and zfree */
177+
178+ int data_type; /* best guess about the data type: binary or text */
179+ uLong adler; /* adler32 value of the uncompressed data */
180+ uLong reserved; /* reserved for future use */
181+} z_stream;
182+
183+typedef z_stream FAR *z_streamp;
184+
185+/*
186+ gzip header information passed to and from zlib routines. See RFC 1952
187+ for more details on the meanings of these fields.
188+*/
189+typedef struct gz_header_s {
190+ int text; /* true if compressed data believed to be text */
191+ uLong time; /* modification time */
192+ int xflags; /* extra flags (not used when writing a gzip file) */
193+ int os; /* operating system */
194+ Bytef *extra; /* pointer to extra field or Z_NULL if none */
195+ uInt extra_len; /* extra field length (valid if extra != Z_NULL) */
196+ uInt extra_max; /* space at extra (only when reading header) */
197+ Bytef *name; /* pointer to zero-terminated file name or Z_NULL */
198+ uInt name_max; /* space at name (only when reading header) */
199+ Bytef *comment; /* pointer to zero-terminated comment or Z_NULL */
200+ uInt comm_max; /* space at comment (only when reading header) */
201+ int hcrc; /* true if there was or will be a header crc */
202+ int done; /* true when done reading gzip header (not used
203+ when writing a gzip file) */
204+} gz_header;
205+
206+typedef gz_header FAR *gz_headerp;
207+
208+/*
209+ The application must update next_in and avail_in when avail_in has
210+ dropped to zero. It must update next_out and avail_out when avail_out
211+ has dropped to zero. The application must initialize zalloc, zfree and
212+ opaque before calling the init function. All other fields are set by the
213+ compression library and must not be updated by the application.
214+
215+ The opaque value provided by the application will be passed as the first
216+ parameter for calls of zalloc and zfree. This can be useful for custom
217+ memory management. The compression library attaches no meaning to the
218+ opaque value.
219+
220+ zalloc must return Z_NULL if there is not enough memory for the object.
221+ If zlib is used in a multi-threaded application, zalloc and zfree must be
222+ thread safe.
223+
224+ On 16-bit systems, the functions zalloc and zfree must be able to allocate
225+ exactly 65536 bytes, but will not be required to allocate more than this
226+ if the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS,
227+ pointers returned by zalloc for objects of exactly 65536 bytes *must*
228+ have their offset normalized to zero. The default allocation function
229+ provided by this library ensures this (see zutil.c). To reduce memory
230+ requirements and avoid any allocation of 64K objects, at the expense of
231+ compression ratio, compile the library with -DMAX_WBITS=14 (see zconf.h).
232+
233+ The fields total_in and total_out can be used for statistics or
234+ progress reports. After compression, total_in holds the total size of
235+ the uncompressed data and may be saved for use in the decompressor
236+ (particularly if the decompressor wants to decompress everything in
237+ a single step).
238+*/
239+
240+ /* constants */
241+
242+#define Z_NO_FLUSH 0
243+#define Z_PARTIAL_FLUSH 1 /* will be removed, use Z_SYNC_FLUSH instead */
244+#define Z_SYNC_FLUSH 2
245+#define Z_FULL_FLUSH 3
246+#define Z_FINISH 4
247+#define Z_BLOCK 5
248+/* Allowed flush values; see deflate() and inflate() below for details */
249+
250+#define Z_OK 0
251+#define Z_STREAM_END 1
252+#define Z_NEED_DICT 2
253+#define Z_ERRNO (-1)
254+#define Z_STREAM_ERROR (-2)
255+#define Z_DATA_ERROR (-3)
256+#define Z_MEM_ERROR (-4)
257+#define Z_BUF_ERROR (-5)
258+#define Z_VERSION_ERROR (-6)
259+/* Return codes for the compression/decompression functions. Negative
260+ * values are errors, positive values are used for special but normal events.
261+ */
262+
263+#define Z_NO_COMPRESSION 0
264+#define Z_BEST_SPEED 1
265+#define Z_BEST_COMPRESSION 9
266+#define Z_DEFAULT_COMPRESSION (-1)
267+/* compression levels */
268+
269+#define Z_FILTERED 1
270+#define Z_HUFFMAN_ONLY 2
271+#define Z_RLE 3
272+#define Z_FIXED 4
273+#define Z_DEFAULT_STRATEGY 0
274+/* compression strategy; see deflateInit2() below for details */
275+
276+#define Z_BINARY 0
277+#define Z_TEXT 1
278+#define Z_ASCII Z_TEXT /* for compatibility with 1.2.2 and earlier */
279+#define Z_UNKNOWN 2
280+/* Possible values of the data_type field (though see inflate()) */
281+
282+#define Z_DEFLATED 8
283+/* The deflate compression method (the only one supported in this version) */
284+
285+#define Z_NULL 0 /* for initializing zalloc, zfree, opaque */
286+
287+#define zlib_version zlibVersion()
288+/* for compatibility with versions < 1.0.2 */
289+
290+ /* basic functions */
291+
292+ZEXTERN const char * ZEXPORT zlibVersion OF((void));
293+/* The application can compare zlibVersion and ZLIB_VERSION for consistency.
294+ If the first character differs, the library code actually used is
295+ not compatible with the zlib.h header file used by the application.
296+ This check is automatically made by deflateInit and inflateInit.
297+ */
298+
299+/*
300+ZEXTERN int ZEXPORT deflateInit OF((z_streamp strm, int level));
301+
302+ Initializes the internal stream state for compression. The fields
303+ zalloc, zfree and opaque must be initialized before by the caller.
304+ If zalloc and zfree are set to Z_NULL, deflateInit updates them to
305+ use default allocation functions.
306+
307+ The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9:
308+ 1 gives best speed, 9 gives best compression, 0 gives no compression at
309+ all (the input data is simply copied a block at a time).
310+ Z_DEFAULT_COMPRESSION requests a default compromise between speed and
311+ compression (currently equivalent to level 6).
312+
313+ deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not
314+ enough memory, Z_STREAM_ERROR if level is not a valid compression level,
315+ Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible
316+ with the version assumed by the caller (ZLIB_VERSION).
317+ msg is set to null if there is no error message. deflateInit does not
318+ perform any compression: this will be done by deflate().
319+*/
320+
321+
322+ZEXTERN int ZEXPORT deflate OF((z_streamp strm, int flush));
323+/*
324+ deflate compresses as much data as possible, and stops when the input
325+ buffer becomes empty or the output buffer becomes full. It may introduce some
326+ output latency (reading input without producing any output) except when
327+ forced to flush.
328+
329+ The detailed semantics are as follows. deflate performs one or both of the
330+ following actions:
331+
332+ - Compress more input starting at next_in and update next_in and avail_in
333+ accordingly. If not all input can be processed (because there is not
334+ enough room in the output buffer), next_in and avail_in are updated and
335+ processing will resume at this point for the next call of deflate().
336+
337+ - Provide more output starting at next_out and update next_out and avail_out
338+ accordingly. This action is forced if the parameter flush is non zero.
339+ Forcing flush frequently degrades the compression ratio, so this parameter
340+ should be set only when necessary (in interactive applications).
341+ Some output may be provided even if flush is not set.
342+
343+ Before the call of deflate(), the application should ensure that at least
344+ one of the actions is possible, by providing more input and/or consuming
345+ more output, and updating avail_in or avail_out accordingly; avail_out
346+ should never be zero before the call. The application can consume the
347+ compressed output when it wants, for example when the output buffer is full
348+ (avail_out == 0), or after each call of deflate(). If deflate returns Z_OK
349+ and with zero avail_out, it must be called again after making room in the
350+ output buffer because there might be more output pending.
351+
352+ Normally the parameter flush is set to Z_NO_FLUSH, which allows deflate to
353+ decide how much data to accumualte before producing output, in order to
354+ maximize compression.
355+
356+ If the parameter flush is set to Z_SYNC_FLUSH, all pending output is
357+ flushed to the output buffer and the output is aligned on a byte boundary, so
358+ that the decompressor can get all input data available so far. (In particular
359+ avail_in is zero after the call if enough output space has been provided
360+ before the call.) Flushing may degrade compression for some compression
361+ algorithms and so it should be used only when necessary.
362+
363+ If flush is set to Z_FULL_FLUSH, all output is flushed as with
364+ Z_SYNC_FLUSH, and the compression state is reset so that decompression can
365+ restart from this point if previous compressed data has been damaged or if
366+ random access is desired. Using Z_FULL_FLUSH too often can seriously degrade
367+ compression.
368+
369+ If deflate returns with avail_out == 0, this function must be called again
370+ with the same value of the flush parameter and more output space (updated
371+ avail_out), until the flush is complete (deflate returns with non-zero
372+ avail_out). In the case of a Z_FULL_FLUSH or Z_SYNC_FLUSH, make sure that
373+ avail_out is greater than six to avoid repeated flush markers due to
374+ avail_out == 0 on return.
375+
376+ If the parameter flush is set to Z_FINISH, pending input is processed,
377+ pending output is flushed and deflate returns with Z_STREAM_END if there
378+ was enough output space; if deflate returns with Z_OK, this function must be
379+ called again with Z_FINISH and more output space (updated avail_out) but no
380+ more input data, until it returns with Z_STREAM_END or an error. After
381+ deflate has returned Z_STREAM_END, the only possible operations on the
382+ stream are deflateReset or deflateEnd.
383+
384+ Z_FINISH can be used immediately after deflateInit if all the compression
385+ is to be done in a single step. In this case, avail_out must be at least
386+ the value returned by deflateBound (see below). If deflate does not return
387+ Z_STREAM_END, then it must be called again as described above.
388+
389+ deflate() sets strm->adler to the adler32 checksum of all input read
390+ so far (that is, total_in bytes).
391+
392+ deflate() may update strm->data_type if it can make a good guess about
393+ the input data type (Z_BINARY or Z_TEXT). In doubt, the data is considered
394+ binary. This field is only for information purposes and does not affect
395+ the compression algorithm in any manner.
396+
397+ deflate() returns Z_OK if some progress has been made (more input
398+ processed or more output produced), Z_STREAM_END if all input has been
399+ consumed and all output has been produced (only when flush is set to
400+ Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example
401+ if next_in or next_out was NULL), Z_BUF_ERROR if no progress is possible
402+ (for example avail_in or avail_out was zero). Note that Z_BUF_ERROR is not
403+ fatal, and deflate() can be called again with more input and more output
404+ space to continue compressing.
405+*/
406+
407+
408+ZEXTERN int ZEXPORT deflateEnd OF((z_streamp strm));
409+/*
410+ All dynamically allocated data structures for this stream are freed.
411+ This function discards any unprocessed input and does not flush any
412+ pending output.
413+
414+ deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the
415+ stream state was inconsistent, Z_DATA_ERROR if the stream was freed
416+ prematurely (some input or output was discarded). In the error case,
417+ msg may be set but then points to a static string (which must not be
418+ deallocated).
419+*/
420+
421+
422+/*
423+ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm));
424+
425+ Initializes the internal stream state for decompression. The fields
426+ next_in, avail_in, zalloc, zfree and opaque must be initialized before by
427+ the caller. If next_in is not Z_NULL and avail_in is large enough (the exact
428+ value depends on the compression method), inflateInit determines the
429+ compression method from the zlib header and allocates all data structures
430+ accordingly; otherwise the allocation will be deferred to the first call of
431+ inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them to
432+ use default allocation functions.
433+
434+ inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough
435+ memory, Z_VERSION_ERROR if the zlib library version is incompatible with the
436+ version assumed by the caller. msg is set to null if there is no error
437+ message. inflateInit does not perform any decompression apart from reading
438+ the zlib header if present: this will be done by inflate(). (So next_in and
439+ avail_in may be modified, but next_out and avail_out are unchanged.)
440+*/
441+
442+
443+ZEXTERN int ZEXPORT inflate OF((z_streamp strm, int flush));
444+/*
445+ inflate decompresses as much data as possible, and stops when the input
446+ buffer becomes empty or the output buffer becomes full. It may introduce
447+ some output latency (reading input without producing any output) except when
448+ forced to flush.
449+
450+ The detailed semantics are as follows. inflate performs one or both of the
451+ following actions:
452+
453+ - Decompress more input starting at next_in and update next_in and avail_in
454+ accordingly. If not all input can be processed (because there is not
455+ enough room in the output buffer), next_in is updated and processing
456+ will resume at this point for the next call of inflate().
457+
458+ - Provide more output starting at next_out and update next_out and avail_out
459+ accordingly. inflate() provides as much output as possible, until there
460+ is no more input data or no more space in the output buffer (see below
461+ about the flush parameter).
462+
463+ Before the call of inflate(), the application should ensure that at least
464+ one of the actions is possible, by providing more input and/or consuming
465+ more output, and updating the next_* and avail_* values accordingly.
466+ The application can consume the uncompressed output when it wants, for
467+ example when the output buffer is full (avail_out == 0), or after each
468+ call of inflate(). If inflate returns Z_OK and with zero avail_out, it
469+ must be called again after making room in the output buffer because there
470+ might be more output pending.
471+
472+ The flush parameter of inflate() can be Z_NO_FLUSH, Z_SYNC_FLUSH,
473+ Z_FINISH, or Z_BLOCK. Z_SYNC_FLUSH requests that inflate() flush as much
474+ output as possible to the output buffer. Z_BLOCK requests that inflate() stop
475+ if and when it gets to the next deflate block boundary. When decoding the
476+ zlib or gzip format, this will cause inflate() to return immediately after
477+ the header and before the first block. When doing a raw inflate, inflate()
478+ will go ahead and process the first block, and will return when it gets to
479+ the end of that block, or when it runs out of data.
480+
481+ The Z_BLOCK option assists in appending to or combining deflate streams.
482+ Also to assist in this, on return inflate() will set strm->data_type to the
483+ number of unused bits in the last byte taken from strm->next_in, plus 64
484+ if inflate() is currently decoding the last block in the deflate stream,
485+ plus 128 if inflate() returned immediately after decoding an end-of-block
486+ code or decoding the complete header up to just before the first byte of the
487+ deflate stream. The end-of-block will not be indicated until all of the
488+ uncompressed data from that block has been written to strm->next_out. The
489+ number of unused bits may in general be greater than seven, except when
490+ bit 7 of data_type is set, in which case the number of unused bits will be
491+ less than eight.
492+
493+ inflate() should normally be called until it returns Z_STREAM_END or an
494+ error. However if all decompression is to be performed in a single step
495+ (a single call of inflate), the parameter flush should be set to
496+ Z_FINISH. In this case all pending input is processed and all pending
497+ output is flushed; avail_out must be large enough to hold all the
498+ uncompressed data. (The size of the uncompressed data may have been saved
499+ by the compressor for this purpose.) The next operation on this stream must
500+ be inflateEnd to deallocate the decompression state. The use of Z_FINISH
501+ is never required, but can be used to inform inflate that a faster approach
502+ may be used for the single inflate() call.
503+
504+ In this implementation, inflate() always flushes as much output as
505+ possible to the output buffer, and always uses the faster approach on the
506+ first call. So the only effect of the flush parameter in this implementation
507+ is on the return value of inflate(), as noted below, or when it returns early
508+ because Z_BLOCK is used.
509+
510+ If a preset dictionary is needed after this call (see inflateSetDictionary
511+ below), inflate sets strm->adler to the adler32 checksum of the dictionary
512+ chosen by the compressor and returns Z_NEED_DICT; otherwise it sets
513+ strm->adler to the adler32 checksum of all output produced so far (that is,
514+ total_out bytes) and returns Z_OK, Z_STREAM_END or an error code as described
515+ below. At the end of the stream, inflate() checks that its computed adler32
516+ checksum is equal to that saved by the compressor and returns Z_STREAM_END
517+ only if the checksum is correct.
518+
519+ inflate() will decompress and check either zlib-wrapped or gzip-wrapped
520+ deflate data. The header type is detected automatically. Any information
521+ contained in the gzip header is not retained, so applications that need that
522+ information should instead use raw inflate, see inflateInit2() below, or
523+ inflateBack() and perform their own processing of the gzip header and
524+ trailer.
525+
526+ inflate() returns Z_OK if some progress has been made (more input processed
527+ or more output produced), Z_STREAM_END if the end of the compressed data has
528+ been reached and all uncompressed output has been produced, Z_NEED_DICT if a
529+ preset dictionary is needed at this point, Z_DATA_ERROR if the input data was
530+ corrupted (input stream not conforming to the zlib format or incorrect check
531+ value), Z_STREAM_ERROR if the stream structure was inconsistent (for example
532+ if next_in or next_out was NULL), Z_MEM_ERROR if there was not enough memory,
533+ Z_BUF_ERROR if no progress is possible or if there was not enough room in the
534+ output buffer when Z_FINISH is used. Note that Z_BUF_ERROR is not fatal, and
535+ inflate() can be called again with more input and more output space to
536+ continue decompressing. If Z_DATA_ERROR is returned, the application may then
537+ call inflateSync() to look for a good compression block if a partial recovery
538+ of the data is desired.
539+*/
540+
541+
542+ZEXTERN int ZEXPORT inflateEnd OF((z_streamp strm));
543+/*
544+ All dynamically allocated data structures for this stream are freed.
545+ This function discards any unprocessed input and does not flush any
546+ pending output.
547+
548+ inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state
549+ was inconsistent. In the error case, msg may be set but then points to a
550+ static string (which must not be deallocated).
551+*/
552+
553+ /* Advanced functions */
554+
555+/*
556+ The following functions are needed only in some special applications.
557+*/
558+
559+/*
560+ZEXTERN int ZEXPORT deflateInit2 OF((z_streamp strm,
561+ int level,
562+ int method,
563+ int windowBits,
564+ int memLevel,
565+ int strategy));
566+
567+ This is another version of deflateInit with more compression options. The
568+ fields next_in, zalloc, zfree and opaque must be initialized before by
569+ the caller.
570+
571+ The method parameter is the compression method. It must be Z_DEFLATED in
572+ this version of the library.
573+
574+ The windowBits parameter is the base two logarithm of the window size
575+ (the size of the history buffer). It should be in the range 8..15 for this
576+ version of the library. Larger values of this parameter result in better
577+ compression at the expense of memory usage. The default value is 15 if
578+ deflateInit is used instead.
579+
580+ windowBits can also be -8..-15 for raw deflate. In this case, -windowBits
581+ determines the window size. deflate() will then generate raw deflate data
582+ with no zlib header or trailer, and will not compute an adler32 check value.
583+
584+ windowBits can also be greater than 15 for optional gzip encoding. Add
585+ 16 to windowBits to write a simple gzip header and trailer around the
586+ compressed data instead of a zlib wrapper. The gzip header will have no
587+ file name, no extra data, no comment, no modification time (set to zero),
588+ no header crc, and the operating system will be set to 255 (unknown). If a
589+ gzip stream is being written, strm->adler is a crc32 instead of an adler32.
590+
591+ The memLevel parameter specifies how much memory should be allocated
592+ for the internal compression state. memLevel=1 uses minimum memory but
593+ is slow and reduces compression ratio; memLevel=9 uses maximum memory
594+ for optimal speed. The default value is 8. See zconf.h for total memory
595+ usage as a function of windowBits and memLevel.
596+
597+ The strategy parameter is used to tune the compression algorithm. Use the
598+ value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a
599+ filter (or predictor), Z_HUFFMAN_ONLY to force Huffman encoding only (no
600+ string match), or Z_RLE to limit match distances to one (run-length
601+ encoding). Filtered data consists mostly of small values with a somewhat
602+ random distribution. In this case, the compression algorithm is tuned to
603+ compress them better. The effect of Z_FILTERED is to force more Huffman
604+ coding and less string matching; it is somewhat intermediate between
605+ Z_DEFAULT and Z_HUFFMAN_ONLY. Z_RLE is designed to be almost as fast as
606+ Z_HUFFMAN_ONLY, but give better compression for PNG image data. The strategy
607+ parameter only affects the compression ratio but not the correctness of the
608+ compressed output even if it is not set appropriately. Z_FIXED prevents the
609+ use of dynamic Huffman codes, allowing for a simpler decoder for special
610+ applications.
611+
612+ deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
613+ memory, Z_STREAM_ERROR if a parameter is invalid (such as an invalid
614+ method). msg is set to null if there is no error message. deflateInit2 does
615+ not perform any compression: this will be done by deflate().
616+*/
617+
618+ZEXTERN int ZEXPORT deflateSetDictionary OF((z_streamp strm,
619+ const Bytef *dictionary,
620+ uInt dictLength));
621+/*
622+ Initializes the compression dictionary from the given byte sequence
623+ without producing any compressed output. This function must be called
624+ immediately after deflateInit, deflateInit2 or deflateReset, before any
625+ call of deflate. The compressor and decompressor must use exactly the same
626+ dictionary (see inflateSetDictionary).
627+
628+ The dictionary should consist of strings (byte sequences) that are likely
629+ to be encountered later in the data to be compressed, with the most commonly
630+ used strings preferably put towards the end of the dictionary. Using a
631+ dictionary is most useful when the data to be compressed is short and can be
632+ predicted with good accuracy; the data can then be compressed better than
633+ with the default empty dictionary.
634+
635+ Depending on the size of the compression data structures selected by
636+ deflateInit or deflateInit2, a part of the dictionary may in effect be
637+ discarded, for example if the dictionary is larger than the window size in
638+ deflate or deflate2. Thus the strings most likely to be useful should be
639+ put at the end of the dictionary, not at the front. In addition, the
640+ current implementation of deflate will use at most the window size minus
641+ 262 bytes of the provided dictionary.
642+
643+ Upon return of this function, strm->adler is set to the adler32 value
644+ of the dictionary; the decompressor may later use this value to determine
645+ which dictionary has been used by the compressor. (The adler32 value
646+ applies to the whole dictionary even if only a subset of the dictionary is
647+ actually used by the compressor.) If a raw deflate was requested, then the
648+ adler32 value is not computed and strm->adler is not set.
649+
650+ deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a
651+ parameter is invalid (such as NULL dictionary) or the stream state is
652+ inconsistent (for example if deflate has already been called for this stream
653+ or if the compression method is bsort). deflateSetDictionary does not
654+ perform any compression: this will be done by deflate().
655+*/
656+
657+ZEXTERN int ZEXPORT deflateCopy OF((z_streamp dest,
658+ z_streamp source));
659+/*
660+ Sets the destination stream as a complete copy of the source stream.
661+
662+ This function can be useful when several compression strategies will be
663+ tried, for example when there are several ways of pre-processing the input
664+ data with a filter. The streams that will be discarded should then be freed
665+ by calling deflateEnd. Note that deflateCopy duplicates the internal
666+ compression state which can be quite large, so this strategy is slow and
667+ can consume lots of memory.
668+
669+ deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not
670+ enough memory, Z_STREAM_ERROR if the source stream state was inconsistent
671+ (such as zalloc being NULL). msg is left unchanged in both source and
672+ destination.
673+*/
674+
675+ZEXTERN int ZEXPORT deflateReset OF((z_streamp strm));
676+/*
677+ This function is equivalent to deflateEnd followed by deflateInit,
678+ but does not free and reallocate all the internal compression state.
679+ The stream will keep the same compression level and any other attributes
680+ that may have been set by deflateInit2.
681+
682+ deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
683+ stream state was inconsistent (such as zalloc or state being NULL).
684+*/
685+
686+ZEXTERN int ZEXPORT deflateParams OF((z_streamp strm,
687+ int level,
688+ int strategy));
689+/*
690+ Dynamically update the compression level and compression strategy. The
691+ interpretation of level and strategy is as in deflateInit2. This can be
692+ used to switch between compression and straight copy of the input data, or
693+ to switch to a different kind of input data requiring a different
694+ strategy. If the compression level is changed, the input available so far
695+ is compressed with the old level (and may be flushed); the new level will
696+ take effect only at the next call of deflate().
697+
698+ Before the call of deflateParams, the stream state must be set as for
699+ a call of deflate(), since the currently available input may have to
700+ be compressed and flushed. In particular, strm->avail_out must be non-zero.
701+
702+ deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source
703+ stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR
704+ if strm->avail_out was zero.
705+*/
706+
707+ZEXTERN int ZEXPORT deflateTune OF((z_streamp strm,
708+ int good_length,
709+ int max_lazy,
710+ int nice_length,
711+ int max_chain));
712+/*
713+ Fine tune deflate's internal compression parameters. This should only be
714+ used by someone who understands the algorithm used by zlib's deflate for
715+ searching for the best matching string, and even then only by the most
716+ fanatic optimizer trying to squeeze out the last compressed bit for their
717+ specific input data. Read the deflate.c source code for the meaning of the
718+ max_lazy, good_length, nice_length, and max_chain parameters.
719+
720+ deflateTune() can be called after deflateInit() or deflateInit2(), and
721+ returns Z_OK on success, or Z_STREAM_ERROR for an invalid deflate stream.
722+ */
723+
724+ZEXTERN uLong ZEXPORT deflateBound OF((z_streamp strm,
725+ uLong sourceLen));
726+/*
727+ deflateBound() returns an upper bound on the compressed size after
728+ deflation of sourceLen bytes. It must be called after deflateInit()
729+ or deflateInit2(). This would be used to allocate an output buffer
730+ for deflation in a single pass, and so would be called before deflate().
731+*/
732+
733+ZEXTERN int ZEXPORT deflatePrime OF((z_streamp strm,
734+ int bits,
735+ int value));
736+/*
737+ deflatePrime() inserts bits in the deflate output stream. The intent
738+ is that this function is used to start off the deflate output with the
739+ bits leftover from a previous deflate stream when appending to it. As such,
740+ this function can only be used for raw deflate, and must be used before the
741+ first deflate() call after a deflateInit2() or deflateReset(). bits must be
742+ less than or equal to 16, and that many of the least significant bits of
743+ value will be inserted in the output.
744+
745+ deflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source
746+ stream state was inconsistent.
747+*/
748+
749+ZEXTERN int ZEXPORT deflateSetHeader OF((z_streamp strm,
750+ gz_headerp head));
751+/*
752+ deflateSetHeader() provides gzip header information for when a gzip
753+ stream is requested by deflateInit2(). deflateSetHeader() may be called
754+ after deflateInit2() or deflateReset() and before the first call of
755+ deflate(). The text, time, os, extra field, name, and comment information
756+ in the provided gz_header structure are written to the gzip header (xflag is
757+ ignored -- the extra flags are set according to the compression level). The
758+ caller must assure that, if not Z_NULL, name and comment are terminated with
759+ a zero byte, and that if extra is not Z_NULL, that extra_len bytes are
760+ available there. If hcrc is true, a gzip header crc is included. Note that
761+ the current versions of the command-line version of gzip (up through version
762+ 1.3.x) do not support header crc's, and will report that it is a "multi-part
763+ gzip file" and give up.
764+
765+ If deflateSetHeader is not used, the default gzip header has text false,
766+ the time set to zero, and os set to 255, with no extra, name, or comment
767+ fields. The gzip header is returned to the default state by deflateReset().
768+
769+ deflateSetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source
770+ stream state was inconsistent.
771+*/
772+
773+/*
774+ZEXTERN int ZEXPORT inflateInit2 OF((z_streamp strm,
775+ int windowBits));
776+
777+ This is another version of inflateInit with an extra parameter. The
778+ fields next_in, avail_in, zalloc, zfree and opaque must be initialized
779+ before by the caller.
780+
781+ The windowBits parameter is the base two logarithm of the maximum window
782+ size (the size of the history buffer). It should be in the range 8..15 for
783+ this version of the library. The default value is 15 if inflateInit is used
784+ instead. windowBits must be greater than or equal to the windowBits value
785+ provided to deflateInit2() while compressing, or it must be equal to 15 if
786+ deflateInit2() was not used. If a compressed stream with a larger window
787+ size is given as input, inflate() will return with the error code
788+ Z_DATA_ERROR instead of trying to allocate a larger window.
789+
790+ windowBits can also be -8..-15 for raw inflate. In this case, -windowBits
791+ determines the window size. inflate() will then process raw deflate data,
792+ not looking for a zlib or gzip header, not generating a check value, and not
793+ looking for any check values for comparison at the end of the stream. This
794+ is for use with other formats that use the deflate compressed data format
795+ such as zip. Those formats provide their own check values. If a custom
796+ format is developed using the raw deflate format for compressed data, it is
797+ recommended that a check value such as an adler32 or a crc32 be applied to
798+ the uncompressed data as is done in the zlib, gzip, and zip formats. For
799+ most applications, the zlib format should be used as is. Note that comments
800+ above on the use in deflateInit2() applies to the magnitude of windowBits.
801+
802+ windowBits can also be greater than 15 for optional gzip decoding. Add
803+ 32 to windowBits to enable zlib and gzip decoding with automatic header
804+ detection, or add 16 to decode only the gzip format (the zlib format will
805+ return a Z_DATA_ERROR). If a gzip stream is being decoded, strm->adler is
806+ a crc32 instead of an adler32.
807+
808+ inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
809+ memory, Z_STREAM_ERROR if a parameter is invalid (such as a null strm). msg
810+ is set to null if there is no error message. inflateInit2 does not perform
811+ any decompression apart from reading the zlib header if present: this will
812+ be done by inflate(). (So next_in and avail_in may be modified, but next_out
813+ and avail_out are unchanged.)
814+*/
815+
816+ZEXTERN int ZEXPORT inflateSetDictionary OF((z_streamp strm,
817+ const Bytef *dictionary,
818+ uInt dictLength));
819+/*
820+ Initializes the decompression dictionary from the given uncompressed byte
821+ sequence. This function must be called immediately after a call of inflate,
822+ if that call returned Z_NEED_DICT. The dictionary chosen by the compressor
823+ can be determined from the adler32 value returned by that call of inflate.
824+ The compressor and decompressor must use exactly the same dictionary (see
825+ deflateSetDictionary). For raw inflate, this function can be called
826+ immediately after inflateInit2() or inflateReset() and before any call of
827+ inflate() to set the dictionary. The application must insure that the
828+ dictionary that was used for compression is provided.
829+
830+ inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a
831+ parameter is invalid (such as NULL dictionary) or the stream state is
832+ inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the
833+ expected one (incorrect adler32 value). inflateSetDictionary does not
834+ perform any decompression: this will be done by subsequent calls of
835+ inflate().
836+*/
837+
838+ZEXTERN int ZEXPORT inflateSync OF((z_streamp strm));
839+/*
840+ Skips invalid compressed data until a full flush point (see above the
841+ description of deflate with Z_FULL_FLUSH) can be found, or until all
842+ available input is skipped. No output is provided.
843+
844+ inflateSync returns Z_OK if a full flush point has been found, Z_BUF_ERROR
845+ if no more input was provided, Z_DATA_ERROR if no flush point has been found,
846+ or Z_STREAM_ERROR if the stream structure was inconsistent. In the success
847+ case, the application may save the current current value of total_in which
848+ indicates where valid compressed data was found. In the error case, the
849+ application may repeatedly call inflateSync, providing more input each time,
850+ until success or end of the input data.
851+*/
852+
853+ZEXTERN int ZEXPORT inflateCopy OF((z_streamp dest,
854+ z_streamp source));
855+/*
856+ Sets the destination stream as a complete copy of the source stream.
857+
858+ This function can be useful when randomly accessing a large stream. The
859+ first pass through the stream can periodically record the inflate state,
860+ allowing restarting inflate at those points when randomly accessing the
861+ stream.
862+
863+ inflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not
864+ enough memory, Z_STREAM_ERROR if the source stream state was inconsistent
865+ (such as zalloc being NULL). msg is left unchanged in both source and
866+ destination.
867+*/
868+
869+ZEXTERN int ZEXPORT inflateReset OF((z_streamp strm));
870+/*
871+ This function is equivalent to inflateEnd followed by inflateInit,
872+ but does not free and reallocate all the internal decompression state.
873+ The stream will keep attributes that may have been set by inflateInit2.
874+
875+ inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
876+ stream state was inconsistent (such as zalloc or state being NULL).
877+*/
878+
879+ZEXTERN int ZEXPORT inflatePrime OF((z_streamp strm,
880+ int bits,
881+ int value));
882+/*
883+ This function inserts bits in the inflate input stream. The intent is
884+ that this function is used to start inflating at a bit position in the
885+ middle of a byte. The provided bits will be used before any bytes are used
886+ from next_in. This function should only be used with raw inflate, and
887+ should be used before the first inflate() call after inflateInit2() or
888+ inflateReset(). bits must be less than or equal to 16, and that many of the
889+ least significant bits of value will be inserted in the input.
890+
891+ inflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source
892+ stream state was inconsistent.
893+*/
894+
895+ZEXTERN int ZEXPORT inflateGetHeader OF((z_streamp strm,
896+ gz_headerp head));
897+/*
898+ inflateGetHeader() requests that gzip header information be stored in the
899+ provided gz_header structure. inflateGetHeader() may be called after
900+ inflateInit2() or inflateReset(), and before the first call of inflate().
901+ As inflate() processes the gzip stream, head->done is zero until the header
902+ is completed, at which time head->done is set to one. If a zlib stream is
903+ being decoded, then head->done is set to -1 to indicate that there will be
904+ no gzip header information forthcoming. Note that Z_BLOCK can be used to
905+ force inflate() to return immediately after header processing is complete
906+ and before any actual data is decompressed.
907+
908+ The text, time, xflags, and os fields are filled in with the gzip header
909+ contents. hcrc is set to true if there is a header CRC. (The header CRC
910+ was valid if done is set to one.) If extra is not Z_NULL, then extra_max
911+ contains the maximum number of bytes to write to extra. Once done is true,
912+ extra_len contains the actual extra field length, and extra contains the
913+ extra field, or that field truncated if extra_max is less than extra_len.
914+ If name is not Z_NULL, then up to name_max characters are written there,
915+ terminated with a zero unless the length is greater than name_max. If
916+ comment is not Z_NULL, then up to comm_max characters are written there,
917+ terminated with a zero unless the length is greater than comm_max. When
918+ any of extra, name, or comment are not Z_NULL and the respective field is
919+ not present in the header, then that field is set to Z_NULL to signal its
920+ absence. This allows the use of deflateSetHeader() with the returned
921+ structure to duplicate the header. However if those fields are set to
922+ allocated memory, then the application will need to save those pointers
923+ elsewhere so that they can be eventually freed.
924+
925+ If inflateGetHeader is not used, then the header information is simply
926+ discarded. The header is always checked for validity, including the header
927+ CRC if present. inflateReset() will reset the process to discard the header
928+ information. The application would need to call inflateGetHeader() again to
929+ retrieve the header from the next gzip stream.
930+
931+ inflateGetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source
932+ stream state was inconsistent.
933+*/
934+
935+/*
936+ZEXTERN int ZEXPORT inflateBackInit OF((z_streamp strm, int windowBits,
937+ unsigned char FAR *window));
938+
939+ Initialize the internal stream state for decompression using inflateBack()
940+ calls. The fields zalloc, zfree and opaque in strm must be initialized
941+ before the call. If zalloc and zfree are Z_NULL, then the default library-
942+ derived memory allocation routines are used. windowBits is the base two
943+ logarithm of the window size, in the range 8..15. window is a caller
944+ supplied buffer of that size. Except for special applications where it is
945+ assured that deflate was used with small window sizes, windowBits must be 15
946+ and a 32K byte window must be supplied to be able to decompress general
947+ deflate streams.
948+
949+ See inflateBack() for the usage of these routines.
950+
951+ inflateBackInit will return Z_OK on success, Z_STREAM_ERROR if any of
952+ the paramaters are invalid, Z_MEM_ERROR if the internal state could not
953+ be allocated, or Z_VERSION_ERROR if the version of the library does not
954+ match the version of the header file.
955+*/
956+
957+typedef unsigned (*in_func) OF((void FAR *, unsigned char FAR * FAR *));
958+typedef int (*out_func) OF((void FAR *, unsigned char FAR *, unsigned));
959+
960+ZEXTERN int ZEXPORT inflateBack OF((z_streamp strm,
961+ in_func in, void FAR *in_desc,
962+ out_func out, void FAR *out_desc));
963+/*
964+ inflateBack() does a raw inflate with a single call using a call-back
965+ interface for input and output. This is more efficient than inflate() for
966+ file i/o applications in that it avoids copying between the output and the
967+ sliding window by simply making the window itself the output buffer. This
968+ function trusts the application to not change the output buffer passed by
969+ the output function, at least until inflateBack() returns.
970+
971+ inflateBackInit() must be called first to allocate the internal state
972+ and to initialize the state with the user-provided window buffer.
973+ inflateBack() may then be used multiple times to inflate a complete, raw
974+ deflate stream with each call. inflateBackEnd() is then called to free
975+ the allocated state.
976+
977+ A raw deflate stream is one with no zlib or gzip header or trailer.
978+ This routine would normally be used in a utility that reads zip or gzip
979+ files and writes out uncompressed files. The utility would decode the
980+ header and process the trailer on its own, hence this routine expects
981+ only the raw deflate stream to decompress. This is different from the
982+ normal behavior of inflate(), which expects either a zlib or gzip header and
983+ trailer around the deflate stream.
984+
985+ inflateBack() uses two subroutines supplied by the caller that are then
986+ called by inflateBack() for input and output. inflateBack() calls those
987+ routines until it reads a complete deflate stream and writes out all of the
988+ uncompressed data, or until it encounters an error. The function's
989+ parameters and return types are defined above in the in_func and out_func
990+ typedefs. inflateBack() will call in(in_desc, &buf) which should return the
991+ number of bytes of provided input, and a pointer to that input in buf. If
992+ there is no input available, in() must return zero--buf is ignored in that
993+ case--and inflateBack() will return a buffer error. inflateBack() will call
994+ out(out_desc, buf, len) to write the uncompressed data buf[0..len-1]. out()
995+ should return zero on success, or non-zero on failure. If out() returns
996+ non-zero, inflateBack() will return with an error. Neither in() nor out()
997+ are permitted to change the contents of the window provided to
998+ inflateBackInit(), which is also the buffer that out() uses to write from.
999+ The length written by out() will be at most the window size. Any non-zero
1000+ amount of input may be provided by in().
1001+
1002+ For convenience, inflateBack() can be provided input on the first call by
1003+ setting strm->next_in and strm->avail_in. If that input is exhausted, then
1004+ in() will be called. Therefore strm->next_in must be initialized before
1005+ calling inflateBack(). If strm->next_in is Z_NULL, then in() will be called
1006+ immediately for input. If strm->next_in is not Z_NULL, then strm->avail_in
1007+ must also be initialized, and then if strm->avail_in is not zero, input will
1008+ initially be taken from strm->next_in[0 .. strm->avail_in - 1].
1009+
1010+ The in_desc and out_desc parameters of inflateBack() is passed as the
1011+ first parameter of in() and out() respectively when they are called. These
1012+ descriptors can be optionally used to pass any information that the caller-
1013+ supplied in() and out() functions need to do their job.
1014+
1015+ On return, inflateBack() will set strm->next_in and strm->avail_in to
1016+ pass back any unused input that was provided by the last in() call. The
1017+ return values of inflateBack() can be Z_STREAM_END on success, Z_BUF_ERROR
1018+ if in() or out() returned an error, Z_DATA_ERROR if there was a format
1019+ error in the deflate stream (in which case strm->msg is set to indicate the
1020+ nature of the error), or Z_STREAM_ERROR if the stream was not properly
1021+ initialized. In the case of Z_BUF_ERROR, an input or output error can be
1022+ distinguished using strm->next_in which will be Z_NULL only if in() returned
1023+ an error. If strm->next is not Z_NULL, then the Z_BUF_ERROR was due to
1024+ out() returning non-zero. (in() will always be called before out(), so
1025+ strm->next_in is assured to be defined if out() returns non-zero.) Note
1026+ that inflateBack() cannot return Z_OK.
1027+*/
1028+
1029+ZEXTERN int ZEXPORT inflateBackEnd OF((z_streamp strm));
1030+/*
1031+ All memory allocated by inflateBackInit() is freed.
1032+
1033+ inflateBackEnd() returns Z_OK on success, or Z_STREAM_ERROR if the stream
1034+ state was inconsistent.
1035+*/
1036+
1037+ZEXTERN uLong ZEXPORT zlibCompileFlags OF((void));
1038+/* Return flags indicating compile-time options.
1039+
1040+ Type sizes, two bits each, 00 = 16 bits, 01 = 32, 10 = 64, 11 = other:
1041+ 1.0: size of uInt
1042+ 3.2: size of uLong
1043+ 5.4: size of voidpf (pointer)
1044+ 7.6: size of z_off_t
1045+
1046+ Compiler, assembler, and debug options:
1047+ 8: DEBUG
1048+ 9: ASMV or ASMINF -- use ASM code
1049+ 10: ZLIB_WINAPI -- exported functions use the WINAPI calling convention
1050+ 11: 0 (reserved)
1051+
1052+ One-time table building (smaller code, but not thread-safe if true):
1053+ 12: BUILDFIXED -- build static block decoding tables when needed
1054+ 13: DYNAMIC_CRC_TABLE -- build CRC calculation tables when needed
1055+ 14,15: 0 (reserved)
1056+
1057+ Library content (indicates missing functionality):
1058+ 16: NO_GZCOMPRESS -- gz* functions cannot compress (to avoid linking
1059+ deflate code when not needed)
1060+ 17: NO_GZIP -- deflate can't write gzip streams, and inflate can't detect
1061+ and decode gzip streams (to avoid linking crc code)
1062+ 18-19: 0 (reserved)
1063+
1064+ Operation variations (changes in library functionality):
1065+ 20: PKZIP_BUG_WORKAROUND -- slightly more permissive inflate
1066+ 21: FASTEST -- deflate algorithm with only one, lowest compression level
1067+ 22,23: 0 (reserved)
1068+
1069+ The sprintf variant used by gzprintf (zero is best):
1070+ 24: 0 = vs*, 1 = s* -- 1 means limited to 20 arguments after the format
1071+ 25: 0 = *nprintf, 1 = *printf -- 1 means gzprintf() not secure!
1072+ 26: 0 = returns value, 1 = void -- 1 means inferred string length returned
1073+
1074+ Remainder:
1075+ 27-31: 0 (reserved)
1076+ */
1077+
1078+
1079+ /* utility functions */
1080+
1081+/*
1082+ The following utility functions are implemented on top of the
1083+ basic stream-oriented functions. To simplify the interface, some
1084+ default options are assumed (compression level and memory usage,
1085+ standard memory allocation functions). The source code of these
1086+ utility functions can easily be modified if you need special options.
1087+*/
1088+
1089+ZEXTERN int ZEXPORT compress OF((Bytef *dest, uLongf *destLen,
1090+ const Bytef *source, uLong sourceLen));
1091+/*
1092+ Compresses the source buffer into the destination buffer. sourceLen is
1093+ the byte length of the source buffer. Upon entry, destLen is the total
1094+ size of the destination buffer, which must be at least the value returned
1095+ by compressBound(sourceLen). Upon exit, destLen is the actual size of the
1096+ compressed buffer.
1097+ This function can be used to compress a whole file at once if the
1098+ input file is mmap'ed.
1099+ compress returns Z_OK if success, Z_MEM_ERROR if there was not
1100+ enough memory, Z_BUF_ERROR if there was not enough room in the output
1101+ buffer.
1102+*/
1103+
1104+ZEXTERN int ZEXPORT lzma_compress OF((Bytef *dest, uLongf *destLen,
1105+ const Bytef *source, uLong sourceLen,
1106+ int level));
1107+/*
1108+ Compresses the source buffer into the destination buffer. The level
1109+ parameter has the same meaning as in deflateInit. sourceLen is the byte
1110+ length of the source buffer. Upon entry, destLen is the total size of the
1111+ destination buffer, which must be at least the value returned by
1112+ compressBound(sourceLen). Upon exit, destLen is the actual size of the
1113+ compressed buffer.
1114+
1115+ compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
1116+ memory, Z_BUF_ERROR if there was not enough room in the output buffer,
1117+ Z_STREAM_ERROR if the level parameter is invalid.
1118+*/
1119+
1120+ZEXTERN uLong ZEXPORT compressBound OF((uLong sourceLen));
1121+/*
1122+ compressBound() returns an upper bound on the compressed size after
1123+ compress() or compress2() on sourceLen bytes. It would be used before
1124+ a compress() or compress2() call to allocate the destination buffer.
1125+*/
1126+
1127+ZEXTERN int ZEXPORT lzma_uncompress OF((Bytef *dest, uLongf *destLen,
1128+ const Bytef *source, uLong sourceLen));
1129+/*
1130+ Decompresses the source buffer into the destination buffer. sourceLen is
1131+ the byte length of the source buffer. Upon entry, destLen is the total
1132+ size of the destination buffer, which must be large enough to hold the
1133+ entire uncompressed data. (The size of the uncompressed data must have
1134+ been saved previously by the compressor and transmitted to the decompressor
1135+ by some mechanism outside the scope of this compression library.)
1136+ Upon exit, destLen is the actual size of the compressed buffer.
1137+ This function can be used to decompress a whole file at once if the
1138+ input file is mmap'ed.
1139+
1140+ uncompress returns Z_OK if success, Z_MEM_ERROR if there was not
1141+ enough memory, Z_BUF_ERROR if there was not enough room in the output
1142+ buffer, or Z_DATA_ERROR if the input data was corrupted or incomplete.
1143+*/
1144+
1145+
1146+typedef voidp gzFile;
1147+
1148+ZEXTERN gzFile ZEXPORT gzopen OF((const char *path, const char *mode));
1149+/*
1150+ Opens a gzip (.gz) file for reading or writing. The mode parameter
1151+ is as in fopen ("rb" or "wb") but can also include a compression level
1152+ ("wb9") or a strategy: 'f' for filtered data as in "wb6f", 'h' for
1153+ Huffman only compression as in "wb1h", or 'R' for run-length encoding
1154+ as in "wb1R". (See the description of deflateInit2 for more information
1155+ about the strategy parameter.)
1156+
1157+ gzopen can be used to read a file which is not in gzip format; in this
1158+ case gzread will directly read from the file without decompression.
1159+
1160+ gzopen returns NULL if the file could not be opened or if there was
1161+ insufficient memory to allocate the (de)compression state; errno
1162+ can be checked to distinguish the two cases (if errno is zero, the
1163+ zlib error is Z_MEM_ERROR). */
1164+
1165+ZEXTERN gzFile ZEXPORT gzdopen OF((int fd, const char *mode));
1166+/*
1167+ gzdopen() associates a gzFile with the file descriptor fd. File
1168+ descriptors are obtained from calls like open, dup, creat, pipe or
1169+ fileno (in the file has been previously opened with fopen).
1170+ The mode parameter is as in gzopen.
1171+ The next call of gzclose on the returned gzFile will also close the
1172+ file descriptor fd, just like fclose(fdopen(fd), mode) closes the file
1173+ descriptor fd. If you want to keep fd open, use gzdopen(dup(fd), mode).
1174+ gzdopen returns NULL if there was insufficient memory to allocate
1175+ the (de)compression state.
1176+*/
1177+
1178+ZEXTERN int ZEXPORT gzsetparams OF((gzFile file, int level, int strategy));
1179+/*
1180+ Dynamically update the compression level or strategy. See the description
1181+ of deflateInit2 for the meaning of these parameters.
1182+ gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not
1183+ opened for writing.
1184+*/
1185+
1186+ZEXTERN int ZEXPORT gzread OF((gzFile file, voidp buf, unsigned len));
1187+/*
1188+ Reads the given number of uncompressed bytes from the compressed file.
1189+ If the input file was not in gzip format, gzread copies the given number
1190+ of bytes into the buffer.
1191+ gzread returns the number of uncompressed bytes actually read (0 for
1192+ end of file, -1 for error). */
1193+
1194+ZEXTERN int ZEXPORT gzwrite OF((gzFile file,
1195+ voidpc buf, unsigned len));
1196+/*
1197+ Writes the given number of uncompressed bytes into the compressed file.
1198+ gzwrite returns the number of uncompressed bytes actually written
1199+ (0 in case of error).
1200+*/
1201+
1202+ZEXTERN int ZEXPORTVA gzprintf OF((gzFile file, const char *format, ...));
1203+/*
1204+ Converts, formats, and writes the args to the compressed file under
1205+ control of the format string, as in fprintf. gzprintf returns the number of
1206+ uncompressed bytes actually written (0 in case of error). The number of
1207+ uncompressed bytes written is limited to 4095. The caller should assure that
1208+ this limit is not exceeded. If it is exceeded, then gzprintf() will return
1209+ return an error (0) with nothing written. In this case, there may also be a
1210+ buffer overflow with unpredictable consequences, which is possible only if
1211+ zlib was compiled with the insecure functions sprintf() or vsprintf()
1212+ because the secure snprintf() or vsnprintf() functions were not available.
1213+*/
1214+
1215+ZEXTERN int ZEXPORT gzputs OF((gzFile file, const char *s));
1216+/*
1217+ Writes the given null-terminated string to the compressed file, excluding
1218+ the terminating null character.
1219+ gzputs returns the number of characters written, or -1 in case of error.
1220+*/
1221+
1222+ZEXTERN char * ZEXPORT gzgets OF((gzFile file, char *buf, int len));
1223+/*
1224+ Reads bytes from the compressed file until len-1 characters are read, or
1225+ a newline character is read and transferred to buf, or an end-of-file
1226+ condition is encountered. The string is then terminated with a null
1227+ character.
1228+ gzgets returns buf, or Z_NULL in case of error.
1229+*/
1230+
1231+ZEXTERN int ZEXPORT gzputc OF((gzFile file, int c));
1232+/*
1233+ Writes c, converted to an unsigned char, into the compressed file.
1234+ gzputc returns the value that was written, or -1 in case of error.
1235+*/
1236+
1237+ZEXTERN int ZEXPORT gzgetc OF((gzFile file));
1238+/*
1239+ Reads one byte from the compressed file. gzgetc returns this byte
1240+ or -1 in case of end of file or error.
1241+*/
1242+
1243+ZEXTERN int ZEXPORT gzungetc OF((int c, gzFile file));
1244+/*
1245+ Push one character back onto the stream to be read again later.
1246+ Only one character of push-back is allowed. gzungetc() returns the
1247+ character pushed, or -1 on failure. gzungetc() will fail if a
1248+ character has been pushed but not read yet, or if c is -1. The pushed
1249+ character will be discarded if the stream is repositioned with gzseek()
1250+ or gzrewind().
1251+*/
1252+
1253+ZEXTERN int ZEXPORT gzflush OF((gzFile file, int flush));
1254+/*
1255+ Flushes all pending output into the compressed file. The parameter
1256+ flush is as in the deflate() function. The return value is the zlib
1257+ error number (see function gzerror below). gzflush returns Z_OK if
1258+ the flush parameter is Z_FINISH and all output could be flushed.
1259+ gzflush should be called only when strictly necessary because it can
1260+ degrade compression.
1261+*/
1262+
1263+ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile file,
1264+ z_off_t offset, int whence));
1265+/*
1266+ Sets the starting position for the next gzread or gzwrite on the
1267+ given compressed file. The offset represents a number of bytes in the
1268+ uncompressed data stream. The whence parameter is defined as in lseek(2);
1269+ the value SEEK_END is not supported.
1270+ If the file is opened for reading, this function is emulated but can be
1271+ extremely slow. If the file is opened for writing, only forward seeks are
1272+ supported; gzseek then compresses a sequence of zeroes up to the new
1273+ starting position.
1274+
1275+ gzseek returns the resulting offset location as measured in bytes from
1276+ the beginning of the uncompressed stream, or -1 in case of error, in
1277+ particular if the file is opened for writing and the new starting position
1278+ would be before the current position.
1279+*/
1280+
1281+ZEXTERN int ZEXPORT gzrewind OF((gzFile file));
1282+/*
1283+ Rewinds the given file. This function is supported only for reading.
1284+
1285+ gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET)
1286+*/
1287+
1288+ZEXTERN z_off_t ZEXPORT gztell OF((gzFile file));
1289+/*
1290+ Returns the starting position for the next gzread or gzwrite on the
1291+ given compressed file. This position represents a number of bytes in the
1292+ uncompressed data stream.
1293+
1294+ gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR)
1295+*/
1296+
1297+ZEXTERN int ZEXPORT gzeof OF((gzFile file));
1298+/*
1299+ Returns 1 when EOF has previously been detected reading the given
1300+ input stream, otherwise zero.
1301+*/
1302+
1303+ZEXTERN int ZEXPORT gzdirect OF((gzFile file));
1304+/*
1305+ Returns 1 if file is being read directly without decompression, otherwise
1306+ zero.
1307+*/
1308+
1309+ZEXTERN int ZEXPORT gzclose OF((gzFile file));
1310+/*
1311+ Flushes all pending output if necessary, closes the compressed file
1312+ and deallocates all the (de)compression state. The return value is the zlib
1313+ error number (see function gzerror below). Note that even when an error
1314+ is returned the file will be closed so gzerror cannot be called.
1315+*/
1316+
1317+ZEXTERN const char * ZEXPORT gzerror OF((gzFile file, int *errnum));
1318+/*
1319+ Returns the error message for the last error which occurred on the
1320+ given compressed file. errnum is set to zlib error number. If an
1321+ error occurred in the file system and not in the compression library,
1322+ errnum is set to Z_ERRNO and the application may consult errno
1323+ to get the exact error code.
1324+
1325+ The application must not modify the returned string and future calls to
1326+ this function may invalidate the returned string.
1327+*/
1328+
1329+ZEXTERN void ZEXPORT gzclearerr OF((gzFile file));
1330+/*
1331+ Clears the error and end-of-file flags for file. This is analogous to the
1332+ clearerr() function in stdio. This is useful for continuing to read a gzip
1333+ file that is being written concurrently.
1334+*/
1335+
1336+ /* checksum functions */
1337+
1338+/*
1339+ These functions are not related to compression but are exported
1340+ anyway because they might be useful in applications using the
1341+ compression library.
1342+*/
1343+
1344+ZEXTERN uLong ZEXPORT adler32 OF((uLong adler, const Bytef *buf, uInt len));
1345+/*
1346+ Update a running Adler-32 checksum with the bytes buf[0..len-1] and
1347+ return the updated checksum. If buf is NULL, this function returns
1348+ the required initial value for the checksum.
1349+ An Adler-32 checksum is almost as reliable as a CRC32 but can be computed
1350+ much faster. Usage example:
1351+
1352+ uLong adler = adler32(0L, Z_NULL, 0);
1353+
1354+ while (read_buffer(buffer, length) != EOF) {
1355+ adler = adler32(adler, buffer, length);
1356+ }
1357+ if (adler != original_adler) error();
1358+*/
1359+
1360+ZEXTERN uLong ZEXPORT adler32_combine OF((uLong adler1, uLong adler2,
1361+ z_off_t len2));
1362+/*
1363+ Combine two Adler-32 checksums into one. For two sequences of bytes, seq1
1364+ and seq2 with lengths len1 and len2, Adler-32 checksums were calculated for
1365+ each, adler1 and adler2. adler32_combine() returns the Adler-32 checksum of
1366+ seq1 and seq2 concatenated, requiring only adler1, adler2, and len2.
1367+*/
1368+
1369+ZEXTERN uLong ZEXPORT crc32 OF((uLong crc, const Bytef *buf, uInt len));
1370+/*
1371+ Update a running CRC-32 with the bytes buf[0..len-1] and return the
1372+ updated CRC-32. If buf is NULL, this function returns the required initial
1373+ value for the for the crc. Pre- and post-conditioning (one's complement) is
1374+ performed within this function so it shouldn't be done by the application.
1375+ Usage example:
1376+
1377+ uLong crc = crc32(0L, Z_NULL, 0);
1378+
1379+ while (read_buffer(buffer, length) != EOF) {
1380+ crc = crc32(crc, buffer, length);
1381+ }
1382+ if (crc != original_crc) error();
1383+*/
1384+
1385+ZEXTERN uLong ZEXPORT crc32_combine OF((uLong crc1, uLong crc2, z_off_t len2));
1386+
1387+/*
1388+ Combine two CRC-32 check values into one. For two sequences of bytes,
1389+ seq1 and seq2 with lengths len1 and len2, CRC-32 check values were
1390+ calculated for each, crc1 and crc2. crc32_combine() returns the CRC-32
1391+ check value of seq1 and seq2 concatenated, requiring only crc1, crc2, and
1392+ len2.
1393+*/
1394+
1395+
1396+ /* various hacks, don't look :) */
1397+
1398+/* deflateInit and inflateInit are macros to allow checking the zlib version
1399+ * and the compiler's view of z_stream:
1400+ */
1401+ZEXTERN int ZEXPORT deflateInit_ OF((z_streamp strm, int level,
1402+ const char *version, int stream_size));
1403+ZEXTERN int ZEXPORT inflateInit_ OF((z_streamp strm,
1404+ const char *version, int stream_size));
1405+ZEXTERN int ZEXPORT deflateInit2_ OF((z_streamp strm, int level, int method,
1406+ int windowBits, int memLevel,
1407+ int strategy, const char *version,
1408+ int stream_size));
1409+ZEXTERN int ZEXPORT inflateInit2_ OF((z_streamp strm, int windowBits,
1410+ const char *version, int stream_size));
1411+ZEXTERN int ZEXPORT inflateBackInit_ OF((z_streamp strm, int windowBits,
1412+ unsigned char FAR *window,
1413+ const char *version,
1414+ int stream_size));
1415+#define deflateInit(strm, level) \
1416+ deflateInit_((strm), (level), ZLIB_VERSION, sizeof(z_stream))
1417+#define inflateInit(strm) \
1418+ inflateInit_((strm), ZLIB_VERSION, sizeof(z_stream))
1419+#define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \
1420+ deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\
1421+ (strategy), ZLIB_VERSION, sizeof(z_stream))
1422+#define inflateInit2(strm, windowBits) \
1423+ inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))
1424+#define inflateBackInit(strm, windowBits, window) \
1425+ inflateBackInit_((strm), (windowBits), (window), \
1426+ ZLIB_VERSION, sizeof(z_stream))
1427+
1428+
1429+#if !defined(ZUTIL_H) && !defined(NO_DUMMY_DECL)
1430+ struct internal_state {int dummy;}; /* hack for buggy compilers */
1431+#endif
1432+
1433+ZEXTERN const char * ZEXPORT zError OF((int));
1434+ZEXTERN int ZEXPORT inflateSyncPoint OF((z_streamp z));
1435+ZEXTERN const uLongf * ZEXPORT get_crc_table OF((void));
1436+
1437+#ifdef __cplusplus
1438+}
1439+#endif
1440+
1441+#endif /* ZLIB_H */
This page took 0.159925 seconds and 4 git commands to generate.