mbed-os-example-blinky - ex

Users » tmboy » Code » mbed-os-example-blinky

bowen liu / Mbed OS mbed-os-example-blinky

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

DuerOS-Light-SDK-v1.1.0/duer-os-light/src/iot-baidu-ota/baidu_ota_unpack/zliblite/zlib.h@47:9e361da97763, 2017-07-18 (annotated)

Committer:: TMBOY
Date:: Tue Jul 18 16:54:45 2017 +0800
Revision:: 47:9e361da97763

Who changed what in which revision?

User	Revision	Line number	New contents of line
TMBOY	47:9e361da97763	1	/* zlib.h -- interface of the 'zlib' general purpose compression library
TMBOY	47:9e361da97763	2	version 1.2.8, April 28th, 2013
TMBOY	47:9e361da97763	3
TMBOY	47:9e361da97763	4	Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler
TMBOY	47:9e361da97763	5
TMBOY	47:9e361da97763	6	This software is provided 'as-is', without any express or implied
TMBOY	47:9e361da97763	7	warranty. In no event will the authors be held liable for any damages
TMBOY	47:9e361da97763	8	arising from the use of this software.
TMBOY	47:9e361da97763	9
TMBOY	47:9e361da97763	10	Permission is granted to anyone to use this software for any purpose,
TMBOY	47:9e361da97763	11	including commercial applications, and to alter it and redistribute it
TMBOY	47:9e361da97763	12	freely, subject to the following restrictions:
TMBOY	47:9e361da97763	13
TMBOY	47:9e361da97763	14	1. The origin of this software must not be misrepresented; you must not
TMBOY	47:9e361da97763	15	claim that you wrote the original software. If you use this software
TMBOY	47:9e361da97763	16	in a product, an acknowledgment in the product documentation would be
TMBOY	47:9e361da97763	17	appreciated but is not required.
TMBOY	47:9e361da97763	18	2. Altered source versions must be plainly marked as such, and must not be
TMBOY	47:9e361da97763	19	misrepresented as being the original software.
TMBOY	47:9e361da97763	20	3. This notice may not be removed or altered from any source distribution.
TMBOY	47:9e361da97763	21
TMBOY	47:9e361da97763	22	Jean-loup Gailly Mark Adler
TMBOY	47:9e361da97763	23	jloup@gzip.org madler@alumni.caltech.edu
TMBOY	47:9e361da97763	24
TMBOY	47:9e361da97763	25
TMBOY	47:9e361da97763	26	The data format used by the zlib library is described by RFCs (Request for
TMBOY	47:9e361da97763	27	Comments) 1950 to 1952 in the files http://tools.ietf.org/html/rfc1950
TMBOY	47:9e361da97763	28	(zlib format), rfc1951 (deflate format) and rfc1952 (gzip format).
TMBOY	47:9e361da97763	29	*/
TMBOY	47:9e361da97763	30
TMBOY	47:9e361da97763	31	#ifndef ZLIB_H
TMBOY	47:9e361da97763	32	#define ZLIB_H
TMBOY	47:9e361da97763	33
TMBOY	47:9e361da97763	34	#include "zconf.h"
TMBOY	47:9e361da97763	35
TMBOY	47:9e361da97763	36	#ifdef __cplusplus
TMBOY	47:9e361da97763	37	extern "C" {
TMBOY	47:9e361da97763	38	#endif
TMBOY	47:9e361da97763	39
TMBOY	47:9e361da97763	40	#define ZLIB_VERSION "1.2.8"
TMBOY	47:9e361da97763	41	#define ZLIB_VERNUM 0x1280
TMBOY	47:9e361da97763	42	#define ZLIB_VER_MAJOR 1
TMBOY	47:9e361da97763	43	#define ZLIB_VER_MINOR 2
TMBOY	47:9e361da97763	44	#define ZLIB_VER_REVISION 8
TMBOY	47:9e361da97763	45	#define ZLIB_VER_SUBREVISION 0
TMBOY	47:9e361da97763	46
TMBOY	47:9e361da97763	47	/*
TMBOY	47:9e361da97763	48	The 'zlib' compression library provides in-memory compression and
TMBOY	47:9e361da97763	49	decompression functions, including integrity checks of the uncompressed data.
TMBOY	47:9e361da97763	50	This version of the library supports only one compression method (deflation)
TMBOY	47:9e361da97763	51	but other algorithms will be added later and will have the same stream
TMBOY	47:9e361da97763	52	interface.
TMBOY	47:9e361da97763	53
TMBOY	47:9e361da97763	54	Compression can be done in a single step if the buffers are large enough,
TMBOY	47:9e361da97763	55	or can be done by repeated calls of the compression function. In the latter
TMBOY	47:9e361da97763	56	case, the application must provide more input and/or consume the output
TMBOY	47:9e361da97763	57	(providing more output space) before each call.
TMBOY	47:9e361da97763	58
TMBOY	47:9e361da97763	59	The compressed data format used by default by the in-memory functions is
TMBOY	47:9e361da97763	60	the zlib format, which is a zlib wrapper documented in RFC 1950, wrapped
TMBOY	47:9e361da97763	61	around a deflate stream, which is itself documented in RFC 1951.
TMBOY	47:9e361da97763	62
TMBOY	47:9e361da97763	63	The library also supports reading and writing files in gzip (.gz) format
TMBOY	47:9e361da97763	64	with an interface similar to that of stdio using the functions that start
TMBOY	47:9e361da97763	65	with "gz". The gzip format is different from the zlib format. gzip is a
TMBOY	47:9e361da97763	66	gzip wrapper, documented in RFC 1952, wrapped around a deflate stream.
TMBOY	47:9e361da97763	67
TMBOY	47:9e361da97763	68	This library can optionally read and write gzip streams in memory as well.
TMBOY	47:9e361da97763	69
TMBOY	47:9e361da97763	70	The zlib format was designed to be compact and fast for use in memory
TMBOY	47:9e361da97763	71	and on communications channels. The gzip format was designed for single-
TMBOY	47:9e361da97763	72	file compression on file systems, has a larger header than zlib to maintain
TMBOY	47:9e361da97763	73	directory information, and uses a different, slower check method than zlib.
TMBOY	47:9e361da97763	74
TMBOY	47:9e361da97763	75	The library does not install any signal handler. The decoder checks
TMBOY	47:9e361da97763	76	the consistency of the compressed data, so the library should never crash
TMBOY	47:9e361da97763	77	even in case of corrupted input.
TMBOY	47:9e361da97763	78	*/
TMBOY	47:9e361da97763	79
TMBOY	47:9e361da97763	80	typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size));
TMBOY	47:9e361da97763	81	typedef void (*free_func) OF((voidpf opaque, voidpf address));
TMBOY	47:9e361da97763	82
TMBOY	47:9e361da97763	83	struct internal_state;
TMBOY	47:9e361da97763	84
TMBOY	47:9e361da97763	85	typedef struct z_stream_s {
TMBOY	47:9e361da97763	86	z_const Bytef next_in; / next input byte */
TMBOY	47:9e361da97763	87	uInt avail_in; /* number of bytes available at next_in */
TMBOY	47:9e361da97763	88	uLong total_in; /* total number of input bytes read so far */
TMBOY	47:9e361da97763	89
TMBOY	47:9e361da97763	90	Bytef next_out; / next output byte should be put there */
TMBOY	47:9e361da97763	91	uInt avail_out; /* remaining free space at next_out */
TMBOY	47:9e361da97763	92	uLong total_out; /* total number of bytes output so far */
TMBOY	47:9e361da97763	93
TMBOY	47:9e361da97763	94	z_const char msg; / last error message, NULL if no error */
TMBOY	47:9e361da97763	95	struct internal_state FAR state; / not visible by applications */
TMBOY	47:9e361da97763	96
TMBOY	47:9e361da97763	97	alloc_func zalloc; /* used to allocate the internal state */
TMBOY	47:9e361da97763	98	free_func zfree; /* used to free the internal state */
TMBOY	47:9e361da97763	99	voidpf opaque; /* private data object passed to zalloc and zfree */
TMBOY	47:9e361da97763	100
TMBOY	47:9e361da97763	101	int data_type; /* best guess about the data type: binary or text */
TMBOY	47:9e361da97763	102	uLong adler; /* adler32 value of the uncompressed data */
TMBOY	47:9e361da97763	103	uLong reserved; /* reserved for future use */
TMBOY	47:9e361da97763	104	} z_stream;
TMBOY	47:9e361da97763	105
TMBOY	47:9e361da97763	106	typedef z_stream FAR *z_streamp;
TMBOY	47:9e361da97763	107
TMBOY	47:9e361da97763	108	/*
TMBOY	47:9e361da97763	109	gzip header information passed to and from zlib routines. See RFC 1952
TMBOY	47:9e361da97763	110	for more details on the meanings of these fields.
TMBOY	47:9e361da97763	111	*/
TMBOY	47:9e361da97763	112	typedef struct gz_header_s {
TMBOY	47:9e361da97763	113	int text; /* true if compressed data believed to be text */
TMBOY	47:9e361da97763	114	uLong time; /* modification time */
TMBOY	47:9e361da97763	115	int xflags; /* extra flags (not used when writing a gzip file) */
TMBOY	47:9e361da97763	116	int os; /* operating system */
TMBOY	47:9e361da97763	117	Bytef extra; / pointer to extra field or Z_NULL if none */
TMBOY	47:9e361da97763	118	uInt extra_len; /* extra field length (valid if extra != Z_NULL) */
TMBOY	47:9e361da97763	119	uInt extra_max; /* space at extra (only when reading header) */
TMBOY	47:9e361da97763	120	Bytef name; / pointer to zero-terminated file name or Z_NULL */
TMBOY	47:9e361da97763	121	uInt name_max; /* space at name (only when reading header) */
TMBOY	47:9e361da97763	122	Bytef comment; / pointer to zero-terminated comment or Z_NULL */
TMBOY	47:9e361da97763	123	uInt comm_max; /* space at comment (only when reading header) */
TMBOY	47:9e361da97763	124	int hcrc; /* true if there was or will be a header crc */
TMBOY	47:9e361da97763	125	int done; /* true when done reading gzip header (not used
TMBOY	47:9e361da97763	126	when writing a gzip file) */
TMBOY	47:9e361da97763	127	} gz_header;
TMBOY	47:9e361da97763	128
TMBOY	47:9e361da97763	129	typedef gz_header FAR *gz_headerp;
TMBOY	47:9e361da97763	130
TMBOY	47:9e361da97763	131	/*
TMBOY	47:9e361da97763	132	The application must update next_in and avail_in when avail_in has dropped
TMBOY	47:9e361da97763	133	to zero. It must update next_out and avail_out when avail_out has dropped
TMBOY	47:9e361da97763	134	to zero. The application must initialize zalloc, zfree and opaque before
TMBOY	47:9e361da97763	135	calling the init function. All other fields are set by the compression
TMBOY	47:9e361da97763	136	library and must not be updated by the application.
TMBOY	47:9e361da97763	137
TMBOY	47:9e361da97763	138	The opaque value provided by the application will be passed as the first
TMBOY	47:9e361da97763	139	parameter for calls of zalloc and zfree. This can be useful for custom
TMBOY	47:9e361da97763	140	memory management. The compression library attaches no meaning to the
TMBOY	47:9e361da97763	141	opaque value.
TMBOY	47:9e361da97763	142
TMBOY	47:9e361da97763	143	zalloc must return Z_NULL if there is not enough memory for the object.
TMBOY	47:9e361da97763	144	If zlib is used in a multi-threaded application, zalloc and zfree must be
TMBOY	47:9e361da97763	145	thread safe.
TMBOY	47:9e361da97763	146
TMBOY	47:9e361da97763	147	On 16-bit systems, the functions zalloc and zfree must be able to allocate
TMBOY	47:9e361da97763	148	exactly 65536 bytes, but will not be required to allocate more than this if
TMBOY	47:9e361da97763	149	the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS, pointers
TMBOY	47:9e361da97763	150	returned by zalloc for objects of exactly 65536 bytes must have their
TMBOY	47:9e361da97763	151	offset normalized to zero. The default allocation function provided by this
TMBOY	47:9e361da97763	152	library ensures this (see zutil.c). To reduce memory requirements and avoid
TMBOY	47:9e361da97763	153	any allocation of 64K objects, at the expense of compression ratio, compile
TMBOY	47:9e361da97763	154	the library with -DMAX_WBITS=14 (see zconf.h).
TMBOY	47:9e361da97763	155
TMBOY	47:9e361da97763	156	The fields total_in and total_out can be used for statistics or progress
TMBOY	47:9e361da97763	157	reports. After compression, total_in holds the total size of the
TMBOY	47:9e361da97763	158	uncompressed data and may be saved for use in the decompressor (particularly
TMBOY	47:9e361da97763	159	if the decompressor wants to decompress everything in a single step).
TMBOY	47:9e361da97763	160	*/
TMBOY	47:9e361da97763	161
TMBOY	47:9e361da97763	162	/* constants */
TMBOY	47:9e361da97763	163
TMBOY	47:9e361da97763	164	#define Z_NO_FLUSH 0
TMBOY	47:9e361da97763	165	#define Z_PARTIAL_FLUSH 1
TMBOY	47:9e361da97763	166	#define Z_SYNC_FLUSH 2
TMBOY	47:9e361da97763	167	#define Z_FULL_FLUSH 3
TMBOY	47:9e361da97763	168	#define Z_FINISH 4
TMBOY	47:9e361da97763	169	#define Z_BLOCK 5
TMBOY	47:9e361da97763	170	#define Z_TREES 6
TMBOY	47:9e361da97763	171	/* Allowed flush values; see deflate() and inflate() below for details */
TMBOY	47:9e361da97763	172
TMBOY	47:9e361da97763	173	#define Z_OK 0
TMBOY	47:9e361da97763	174	#define Z_STREAM_END 1
TMBOY	47:9e361da97763	175	#define Z_NEED_DICT 2
TMBOY	47:9e361da97763	176	#define Z_ERRNO (-1)
TMBOY	47:9e361da97763	177	#define Z_STREAM_ERROR (-2)
TMBOY	47:9e361da97763	178	#define Z_DATA_ERROR (-3)
TMBOY	47:9e361da97763	179	#define Z_MEM_ERROR (-4)
TMBOY	47:9e361da97763	180	#define Z_BUF_ERROR (-5)
TMBOY	47:9e361da97763	181	#define Z_VERSION_ERROR (-6)
TMBOY	47:9e361da97763	182	/* Return codes for the compression/decompression functions. Negative values
TMBOY	47:9e361da97763	183	* are errors, positive values are used for special but normal events.
TMBOY	47:9e361da97763	184	*/
TMBOY	47:9e361da97763	185
TMBOY	47:9e361da97763	186	#define Z_NO_COMPRESSION 0
TMBOY	47:9e361da97763	187	#define Z_BEST_SPEED 1
TMBOY	47:9e361da97763	188	#define Z_BEST_COMPRESSION 9
TMBOY	47:9e361da97763	189	#define Z_DEFAULT_COMPRESSION (-1)
TMBOY	47:9e361da97763	190	/* compression levels */
TMBOY	47:9e361da97763	191
TMBOY	47:9e361da97763	192	#define Z_FILTERED 1
TMBOY	47:9e361da97763	193	#define Z_HUFFMAN_ONLY 2
TMBOY	47:9e361da97763	194	#define Z_RLE 3
TMBOY	47:9e361da97763	195	#define Z_FIXED 4
TMBOY	47:9e361da97763	196	#define Z_DEFAULT_STRATEGY 0
TMBOY	47:9e361da97763	197	/* compression strategy; see deflateInit2() below for details */
TMBOY	47:9e361da97763	198
TMBOY	47:9e361da97763	199	#define Z_BINARY 0
TMBOY	47:9e361da97763	200	#define Z_TEXT 1
TMBOY	47:9e361da97763	201	#define Z_ASCII Z_TEXT /* for compatibility with 1.2.2 and earlier */
TMBOY	47:9e361da97763	202	#define Z_UNKNOWN 2
TMBOY	47:9e361da97763	203	/* Possible values of the data_type field (though see inflate()) */
TMBOY	47:9e361da97763	204
TMBOY	47:9e361da97763	205	#define Z_DEFLATED 8
TMBOY	47:9e361da97763	206	/* The deflate compression method (the only one supported in this version) */
TMBOY	47:9e361da97763	207
TMBOY	47:9e361da97763	208	#define Z_NULL 0 /* for initializing zalloc, zfree, opaque */
TMBOY	47:9e361da97763	209
TMBOY	47:9e361da97763	210	#define zlib_version zlibVersion()
TMBOY	47:9e361da97763	211	/* for compatibility with versions < 1.0.2 */
TMBOY	47:9e361da97763	212
TMBOY	47:9e361da97763	213
TMBOY	47:9e361da97763	214	/* basic functions */
TMBOY	47:9e361da97763	215
TMBOY	47:9e361da97763	216	ZEXTERN const char * ZEXPORT zlibVersion OF((void));
TMBOY	47:9e361da97763	217	/* The application can compare zlibVersion and ZLIB_VERSION for consistency.
TMBOY	47:9e361da97763	218	If the first character differs, the library code actually used is not
TMBOY	47:9e361da97763	219	compatible with the zlib.h header file used by the application. This check
TMBOY	47:9e361da97763	220	is automatically made by deflateInit and inflateInit.
TMBOY	47:9e361da97763	221	*/
TMBOY	47:9e361da97763	222
TMBOY	47:9e361da97763	223	/*
TMBOY	47:9e361da97763	224	ZEXTERN int ZEXPORT deflateInit OF((z_streamp strm, int level));
TMBOY	47:9e361da97763	225
TMBOY	47:9e361da97763	226	Initializes the internal stream state for compression. The fields
TMBOY	47:9e361da97763	227	zalloc, zfree and opaque must be initialized before by the caller. If
TMBOY	47:9e361da97763	228	zalloc and zfree are set to Z_NULL, deflateInit updates them to use default
TMBOY	47:9e361da97763	229	allocation functions.
TMBOY	47:9e361da97763	230
TMBOY	47:9e361da97763	231	The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9:
TMBOY	47:9e361da97763	232	1 gives best speed, 9 gives best compression, 0 gives no compression at all
TMBOY	47:9e361da97763	233	(the input data is simply copied a block at a time). Z_DEFAULT_COMPRESSION
TMBOY	47:9e361da97763	234	requests a default compromise between speed and compression (currently
TMBOY	47:9e361da97763	235	equivalent to level 6).
TMBOY	47:9e361da97763	236
TMBOY	47:9e361da97763	237	deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough
TMBOY	47:9e361da97763	238	memory, Z_STREAM_ERROR if level is not a valid compression level, or
TMBOY	47:9e361da97763	239	Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible
TMBOY	47:9e361da97763	240	with the version assumed by the caller (ZLIB_VERSION). msg is set to null
TMBOY	47:9e361da97763	241	if there is no error message. deflateInit does not perform any compression:
TMBOY	47:9e361da97763	242	this will be done by deflate().
TMBOY	47:9e361da97763	243	*/
TMBOY	47:9e361da97763	244
TMBOY	47:9e361da97763	245
TMBOY	47:9e361da97763	246	ZEXTERN int ZEXPORT deflate OF((z_streamp strm, int flush));
TMBOY	47:9e361da97763	247	/*
TMBOY	47:9e361da97763	248	deflate compresses as much data as possible, and stops when the input
TMBOY	47:9e361da97763	249	buffer becomes empty or the output buffer becomes full. It may introduce
TMBOY	47:9e361da97763	250	some output latency (reading input without producing any output) except when
TMBOY	47:9e361da97763	251	forced to flush.
TMBOY	47:9e361da97763	252
TMBOY	47:9e361da97763	253	The detailed semantics are as follows. deflate performs one or both of the
TMBOY	47:9e361da97763	254	following actions:
TMBOY	47:9e361da97763	255
TMBOY	47:9e361da97763	256	- Compress more input starting at next_in and update next_in and avail_in
TMBOY	47:9e361da97763	257	accordingly. If not all input can be processed (because there is not
TMBOY	47:9e361da97763	258	enough room in the output buffer), next_in and avail_in are updated and
TMBOY	47:9e361da97763	259	processing will resume at this point for the next call of deflate().
TMBOY	47:9e361da97763	260
TMBOY	47:9e361da97763	261	- Provide more output starting at next_out and update next_out and avail_out
TMBOY	47:9e361da97763	262	accordingly. This action is forced if the parameter flush is non zero.
TMBOY	47:9e361da97763	263	Forcing flush frequently degrades the compression ratio, so this parameter
TMBOY	47:9e361da97763	264	should be set only when necessary (in interactive applications). Some
TMBOY	47:9e361da97763	265	output may be provided even if flush is not set.
TMBOY	47:9e361da97763	266
TMBOY	47:9e361da97763	267	Before the call of deflate(), the application should ensure that at least
TMBOY	47:9e361da97763	268	one of the actions is possible, by providing more input and/or consuming more
TMBOY	47:9e361da97763	269	output, and updating avail_in or avail_out accordingly; avail_out should
TMBOY	47:9e361da97763	270	never be zero before the call. The application can consume the compressed
TMBOY	47:9e361da97763	271	output when it wants, for example when the output buffer is full (avail_out
TMBOY	47:9e361da97763	272	== 0), or after each call of deflate(). If deflate returns Z_OK and with
TMBOY	47:9e361da97763	273	zero avail_out, it must be called again after making room in the output
TMBOY	47:9e361da97763	274	buffer because there might be more output pending.
TMBOY	47:9e361da97763	275
TMBOY	47:9e361da97763	276	Normally the parameter flush is set to Z_NO_FLUSH, which allows deflate to
TMBOY	47:9e361da97763	277	decide how much data to accumulate before producing output, in order to
TMBOY	47:9e361da97763	278	maximize compression.
TMBOY	47:9e361da97763	279
TMBOY	47:9e361da97763	280	If the parameter flush is set to Z_SYNC_FLUSH, all pending output is
TMBOY	47:9e361da97763	281	flushed to the output buffer and the output is aligned on a byte boundary, so
TMBOY	47:9e361da97763	282	that the decompressor can get all input data available so far. (In
TMBOY	47:9e361da97763	283	particular avail_in is zero after the call if enough output space has been
TMBOY	47:9e361da97763	284	provided before the call.) Flushing may degrade compression for some
TMBOY	47:9e361da97763	285	compression algorithms and so it should be used only when necessary. This
TMBOY	47:9e361da97763	286	completes the current deflate block and follows it with an empty stored block
TMBOY	47:9e361da97763	287	that is three bits plus filler bits to the next byte, followed by four bytes
TMBOY	47:9e361da97763	288	(00 00 ff ff).
TMBOY	47:9e361da97763	289
TMBOY	47:9e361da97763	290	If flush is set to Z_PARTIAL_FLUSH, all pending output is flushed to the
TMBOY	47:9e361da97763	291	output buffer, but the output is not aligned to a byte boundary. All of the
TMBOY	47:9e361da97763	292	input data so far will be available to the decompressor, as for Z_SYNC_FLUSH.
TMBOY	47:9e361da97763	293	This completes the current deflate block and follows it with an empty fixed
TMBOY	47:9e361da97763	294	codes block that is 10 bits long. This assures that enough bytes are output
TMBOY	47:9e361da97763	295	in order for the decompressor to finish the block before the empty fixed code
TMBOY	47:9e361da97763	296	block.
TMBOY	47:9e361da97763	297
TMBOY	47:9e361da97763	298	If flush is set to Z_BLOCK, a deflate block is completed and emitted, as
TMBOY	47:9e361da97763	299	for Z_SYNC_FLUSH, but the output is not aligned on a byte boundary, and up to
TMBOY	47:9e361da97763	300	seven bits of the current block are held to be written as the next byte after
TMBOY	47:9e361da97763	301	the next deflate block is completed. In this case, the decompressor may not
TMBOY	47:9e361da97763	302	be provided enough bits at this point in order to complete decompression of
TMBOY	47:9e361da97763	303	the data provided so far to the compressor. It may need to wait for the next
TMBOY	47:9e361da97763	304	block to be emitted. This is for advanced applications that need to control
TMBOY	47:9e361da97763	305	the emission of deflate blocks.
TMBOY	47:9e361da97763	306
TMBOY	47:9e361da97763	307	If flush is set to Z_FULL_FLUSH, all output is flushed as with
TMBOY	47:9e361da97763	308	Z_SYNC_FLUSH, and the compression state is reset so that decompression can
TMBOY	47:9e361da97763	309	restart from this point if previous compressed data has been damaged or if
TMBOY	47:9e361da97763	310	random access is desired. Using Z_FULL_FLUSH too often can seriously degrade
TMBOY	47:9e361da97763	311	compression.
TMBOY	47:9e361da97763	312
TMBOY	47:9e361da97763	313	If deflate returns with avail_out == 0, this function must be called again
TMBOY	47:9e361da97763	314	with the same value of the flush parameter and more output space (updated
TMBOY	47:9e361da97763	315	avail_out), until the flush is complete (deflate returns with non-zero
TMBOY	47:9e361da97763	316	avail_out). In the case of a Z_FULL_FLUSH or Z_SYNC_FLUSH, make sure that
TMBOY	47:9e361da97763	317	avail_out is greater than six to avoid repeated flush markers due to
TMBOY	47:9e361da97763	318	avail_out == 0 on return.
TMBOY	47:9e361da97763	319
TMBOY	47:9e361da97763	320	If the parameter flush is set to Z_FINISH, pending input is processed,
TMBOY	47:9e361da97763	321	pending output is flushed and deflate returns with Z_STREAM_END if there was
TMBOY	47:9e361da97763	322	enough output space; if deflate returns with Z_OK, this function must be
TMBOY	47:9e361da97763	323	called again with Z_FINISH and more output space (updated avail_out) but no
TMBOY	47:9e361da97763	324	more input data, until it returns with Z_STREAM_END or an error. After
TMBOY	47:9e361da97763	325	deflate has returned Z_STREAM_END, the only possible operations on the stream
TMBOY	47:9e361da97763	326	are deflateReset or deflateEnd.
TMBOY	47:9e361da97763	327
TMBOY	47:9e361da97763	328	Z_FINISH can be used immediately after deflateInit if all the compression
TMBOY	47:9e361da97763	329	is to be done in a single step. In this case, avail_out must be at least the
TMBOY	47:9e361da97763	330	value returned by deflateBound (see below). Then deflate is guaranteed to
TMBOY	47:9e361da97763	331	return Z_STREAM_END. If not enough output space is provided, deflate will
TMBOY	47:9e361da97763	332	not return Z_STREAM_END, and it must be called again as described above.
TMBOY	47:9e361da97763	333
TMBOY	47:9e361da97763	334	deflate() sets strm->adler to the adler32 checksum of all input read
TMBOY	47:9e361da97763	335	so far (that is, total_in bytes).
TMBOY	47:9e361da97763	336
TMBOY	47:9e361da97763	337	deflate() may update strm->data_type if it can make a good guess about
TMBOY	47:9e361da97763	338	the input data type (Z_BINARY or Z_TEXT). In doubt, the data is considered
TMBOY	47:9e361da97763	339	binary. This field is only for information purposes and does not affect the
TMBOY	47:9e361da97763	340	compression algorithm in any manner.
TMBOY	47:9e361da97763	341
TMBOY	47:9e361da97763	342	deflate() returns Z_OK if some progress has been made (more input
TMBOY	47:9e361da97763	343	processed or more output produced), Z_STREAM_END if all input has been
TMBOY	47:9e361da97763	344	consumed and all output has been produced (only when flush is set to
TMBOY	47:9e361da97763	345	Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example
TMBOY	47:9e361da97763	346	if next_in or next_out was Z_NULL), Z_BUF_ERROR if no progress is possible
TMBOY	47:9e361da97763	347	(for example avail_in or avail_out was zero). Note that Z_BUF_ERROR is not
TMBOY	47:9e361da97763	348	fatal, and deflate() can be called again with more input and more output
TMBOY	47:9e361da97763	349	space to continue compressing.
TMBOY	47:9e361da97763	350	*/
TMBOY	47:9e361da97763	351
TMBOY	47:9e361da97763	352
TMBOY	47:9e361da97763	353	ZEXTERN int ZEXPORT deflateEnd OF((z_streamp strm));
TMBOY	47:9e361da97763	354	/*
TMBOY	47:9e361da97763	355	All dynamically allocated data structures for this stream are freed.
TMBOY	47:9e361da97763	356	This function discards any unprocessed input and does not flush any pending
TMBOY	47:9e361da97763	357	output.
TMBOY	47:9e361da97763	358
TMBOY	47:9e361da97763	359	deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the
TMBOY	47:9e361da97763	360	stream state was inconsistent, Z_DATA_ERROR if the stream was freed
TMBOY	47:9e361da97763	361	prematurely (some input or output was discarded). In the error case, msg
TMBOY	47:9e361da97763	362	may be set but then points to a static string (which must not be
TMBOY	47:9e361da97763	363	deallocated).
TMBOY	47:9e361da97763	364	*/
TMBOY	47:9e361da97763	365
TMBOY	47:9e361da97763	366
TMBOY	47:9e361da97763	367	/*
TMBOY	47:9e361da97763	368	ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm));
TMBOY	47:9e361da97763	369
TMBOY	47:9e361da97763	370	Initializes the internal stream state for decompression. The fields
TMBOY	47:9e361da97763	371	next_in, avail_in, zalloc, zfree and opaque must be initialized before by
TMBOY	47:9e361da97763	372	the caller. If next_in is not Z_NULL and avail_in is large enough (the
TMBOY	47:9e361da97763	373	exact value depends on the compression method), inflateInit determines the
TMBOY	47:9e361da97763	374	compression method from the zlib header and allocates all data structures
TMBOY	47:9e361da97763	375	accordingly; otherwise the allocation will be deferred to the first call of
TMBOY	47:9e361da97763	376	inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them to
TMBOY	47:9e361da97763	377	use default allocation functions.
TMBOY	47:9e361da97763	378
TMBOY	47:9e361da97763	379	inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough
TMBOY	47:9e361da97763	380	memory, Z_VERSION_ERROR if the zlib library version is incompatible with the
TMBOY	47:9e361da97763	381	version assumed by the caller, or Z_STREAM_ERROR if the parameters are
TMBOY	47:9e361da97763	382	invalid, such as a null pointer to the structure. msg is set to null if
TMBOY	47:9e361da97763	383	there is no error message. inflateInit does not perform any decompression
TMBOY	47:9e361da97763	384	apart from possibly reading the zlib header if present: actual decompression
TMBOY	47:9e361da97763	385	will be done by inflate(). (So next_in and avail_in may be modified, but
TMBOY	47:9e361da97763	386	next_out and avail_out are unused and unchanged.) The current implementation
TMBOY	47:9e361da97763	387	of inflateInit() does not process any header information -- that is deferred
TMBOY	47:9e361da97763	388	until inflate() is called.
TMBOY	47:9e361da97763	389	*/
TMBOY	47:9e361da97763	390
TMBOY	47:9e361da97763	391
TMBOY	47:9e361da97763	392	ZEXTERN int ZEXPORT inflate OF((z_streamp strm, int flush));
TMBOY	47:9e361da97763	393	/*
TMBOY	47:9e361da97763	394	inflate decompresses as much data as possible, and stops when the input
TMBOY	47:9e361da97763	395	buffer becomes empty or the output buffer becomes full. It may introduce
TMBOY	47:9e361da97763	396	some output latency (reading input without producing any output) except when
TMBOY	47:9e361da97763	397	forced to flush.
TMBOY	47:9e361da97763	398
TMBOY	47:9e361da97763	399	The detailed semantics are as follows. inflate performs one or both of the
TMBOY	47:9e361da97763	400	following actions:
TMBOY	47:9e361da97763	401
TMBOY	47:9e361da97763	402	- Decompress more input starting at next_in and update next_in and avail_in
TMBOY	47:9e361da97763	403	accordingly. If not all input can be processed (because there is not
TMBOY	47:9e361da97763	404	enough room in the output buffer), next_in is updated and processing will
TMBOY	47:9e361da97763	405	resume at this point for the next call of inflate().
TMBOY	47:9e361da97763	406
TMBOY	47:9e361da97763	407	- Provide more output starting at next_out and update next_out and avail_out
TMBOY	47:9e361da97763	408	accordingly. inflate() provides as much output as possible, until there is
TMBOY	47:9e361da97763	409	no more input data or no more space in the output buffer (see below about
TMBOY	47:9e361da97763	410	the flush parameter).
TMBOY	47:9e361da97763	411
TMBOY	47:9e361da97763	412	Before the call of inflate(), the application should ensure that at least
TMBOY	47:9e361da97763	413	one of the actions is possible, by providing more input and/or consuming more
TMBOY	47:9e361da97763	414	output, and updating the next_* and avail_* values accordingly. The
TMBOY	47:9e361da97763	415	application can consume the uncompressed output when it wants, for example
TMBOY	47:9e361da97763	416	when the output buffer is full (avail_out == 0), or after each call of
TMBOY	47:9e361da97763	417	inflate(). If inflate returns Z_OK and with zero avail_out, it must be
TMBOY	47:9e361da97763	418	called again after making room in the output buffer because there might be
TMBOY	47:9e361da97763	419	more output pending.
TMBOY	47:9e361da97763	420
TMBOY	47:9e361da97763	421	The flush parameter of inflate() can be Z_NO_FLUSH, Z_SYNC_FLUSH, Z_FINISH,
TMBOY	47:9e361da97763	422	Z_BLOCK, or Z_TREES. Z_SYNC_FLUSH requests that inflate() flush as much
TMBOY	47:9e361da97763	423	output as possible to the output buffer. Z_BLOCK requests that inflate()
TMBOY	47:9e361da97763	424	stop if and when it gets to the next deflate block boundary. When decoding
TMBOY	47:9e361da97763	425	the zlib or gzip format, this will cause inflate() to return immediately
TMBOY	47:9e361da97763	426	after the header and before the first block. When doing a raw inflate,
TMBOY	47:9e361da97763	427	inflate() will go ahead and process the first block, and will return when it
TMBOY	47:9e361da97763	428	gets to the end of that block, or when it runs out of data.
TMBOY	47:9e361da97763	429
TMBOY	47:9e361da97763	430	The Z_BLOCK option assists in appending to or combining deflate streams.
TMBOY	47:9e361da97763	431	Also to assist in this, on return inflate() will set strm->data_type to the
TMBOY	47:9e361da97763	432	number of unused bits in the last byte taken from strm->next_in, plus 64 if
TMBOY	47:9e361da97763	433	inflate() is currently decoding the last block in the deflate stream, plus
TMBOY	47:9e361da97763	434	128 if inflate() returned immediately after decoding an end-of-block code or
TMBOY	47:9e361da97763	435	decoding the complete header up to just before the first byte of the deflate
TMBOY	47:9e361da97763	436	stream. The end-of-block will not be indicated until all of the uncompressed
TMBOY	47:9e361da97763	437	data from that block has been written to strm->next_out. The number of
TMBOY	47:9e361da97763	438	unused bits may in general be greater than seven, except when bit 7 of
TMBOY	47:9e361da97763	439	data_type is set, in which case the number of unused bits will be less than
TMBOY	47:9e361da97763	440	eight. data_type is set as noted here every time inflate() returns for all
TMBOY	47:9e361da97763	441	flush options, and so can be used to determine the amount of currently
TMBOY	47:9e361da97763	442	consumed input in bits.
TMBOY	47:9e361da97763	443
TMBOY	47:9e361da97763	444	The Z_TREES option behaves as Z_BLOCK does, but it also returns when the
TMBOY	47:9e361da97763	445	end of each deflate block header is reached, before any actual data in that
TMBOY	47:9e361da97763	446	block is decoded. This allows the caller to determine the length of the
TMBOY	47:9e361da97763	447	deflate block header for later use in random access within a deflate block.
TMBOY	47:9e361da97763	448	256 is added to the value of strm->data_type when inflate() returns
TMBOY	47:9e361da97763	449	immediately after reaching the end of the deflate block header.
TMBOY	47:9e361da97763	450
TMBOY	47:9e361da97763	451	inflate() should normally be called until it returns Z_STREAM_END or an
TMBOY	47:9e361da97763	452	error. However if all decompression is to be performed in a single step (a
TMBOY	47:9e361da97763	453	single call of inflate), the parameter flush should be set to Z_FINISH. In
TMBOY	47:9e361da97763	454	this case all pending input is processed and all pending output is flushed;
TMBOY	47:9e361da97763	455	avail_out must be large enough to hold all of the uncompressed data for the
TMBOY	47:9e361da97763	456	operation to complete. (The size of the uncompressed data may have been
TMBOY	47:9e361da97763	457	saved by the compressor for this purpose.) The use of Z_FINISH is not
TMBOY	47:9e361da97763	458	required to perform an inflation in one step. However it may be used to
TMBOY	47:9e361da97763	459	inform inflate that a faster approach can be used for the single inflate()
TMBOY	47:9e361da97763	460	call. Z_FINISH also informs inflate to not maintain a sliding window if the
TMBOY	47:9e361da97763	461	stream completes, which reduces inflate's memory footprint. If the stream
TMBOY	47:9e361da97763	462	does not complete, either because not all of the stream is provided or not
TMBOY	47:9e361da97763	463	enough output space is provided, then a sliding window will be allocated and
TMBOY	47:9e361da97763	464	inflate() can be called again to continue the operation as if Z_NO_FLUSH had
TMBOY	47:9e361da97763	465	been used.
TMBOY	47:9e361da97763	466
TMBOY	47:9e361da97763	467	In this implementation, inflate() always flushes as much output as
TMBOY	47:9e361da97763	468	possible to the output buffer, and always uses the faster approach on the
TMBOY	47:9e361da97763	469	first call. So the effects of the flush parameter in this implementation are
TMBOY	47:9e361da97763	470	on the return value of inflate() as noted below, when inflate() returns early
TMBOY	47:9e361da97763	471	when Z_BLOCK or Z_TREES is used, and when inflate() avoids the allocation of
TMBOY	47:9e361da97763	472	memory for a sliding window when Z_FINISH is used.
TMBOY	47:9e361da97763	473
TMBOY	47:9e361da97763	474	If a preset dictionary is needed after this call (see inflateSetDictionary
TMBOY	47:9e361da97763	475	below), inflate sets strm->adler to the Adler-32 checksum of the dictionary
TMBOY	47:9e361da97763	476	chosen by the compressor and returns Z_NEED_DICT; otherwise it sets
TMBOY	47:9e361da97763	477	strm->adler to the Adler-32 checksum of all output produced so far (that is,
TMBOY	47:9e361da97763	478	total_out bytes) and returns Z_OK, Z_STREAM_END or an error code as described
TMBOY	47:9e361da97763	479	below. At the end of the stream, inflate() checks that its computed adler32
TMBOY	47:9e361da97763	480	checksum is equal to that saved by the compressor and returns Z_STREAM_END
TMBOY	47:9e361da97763	481	only if the checksum is correct.
TMBOY	47:9e361da97763	482
TMBOY	47:9e361da97763	483	inflate() can decompress and check either zlib-wrapped or gzip-wrapped
TMBOY	47:9e361da97763	484	deflate data. The header type is detected automatically, if requested when
TMBOY	47:9e361da97763	485	initializing with inflateInit2(). Any information contained in the gzip
TMBOY	47:9e361da97763	486	header is not retained, so applications that need that information should
TMBOY	47:9e361da97763	487	instead use raw inflate, see inflateInit2() below, or inflateBack() and
TMBOY	47:9e361da97763	488	perform their own processing of the gzip header and trailer. When processing
TMBOY	47:9e361da97763	489	gzip-wrapped deflate data, strm->adler32 is set to the CRC-32 of the output
TMBOY	47:9e361da97763	490	producted so far. The CRC-32 is checked against the gzip trailer.
TMBOY	47:9e361da97763	491
TMBOY	47:9e361da97763	492	inflate() returns Z_OK if some progress has been made (more input processed
TMBOY	47:9e361da97763	493	or more output produced), Z_STREAM_END if the end of the compressed data has
TMBOY	47:9e361da97763	494	been reached and all uncompressed output has been produced, Z_NEED_DICT if a
TMBOY	47:9e361da97763	495	preset dictionary is needed at this point, Z_DATA_ERROR if the input data was
TMBOY	47:9e361da97763	496	corrupted (input stream not conforming to the zlib format or incorrect check
TMBOY	47:9e361da97763	497	value), Z_STREAM_ERROR if the stream structure was inconsistent (for example
TMBOY	47:9e361da97763	498	next_in or next_out was Z_NULL), Z_MEM_ERROR if there was not enough memory,
TMBOY	47:9e361da97763	499	Z_BUF_ERROR if no progress is possible or if there was not enough room in the
TMBOY	47:9e361da97763	500	output buffer when Z_FINISH is used. Note that Z_BUF_ERROR is not fatal, and
TMBOY	47:9e361da97763	501	inflate() can be called again with more input and more output space to
TMBOY	47:9e361da97763	502	continue decompressing. If Z_DATA_ERROR is returned, the application may
TMBOY	47:9e361da97763	503	then call inflateSync() to look for a good compression block if a partial
TMBOY	47:9e361da97763	504	recovery of the data is desired.
TMBOY	47:9e361da97763	505	*/
TMBOY	47:9e361da97763	506
TMBOY	47:9e361da97763	507
TMBOY	47:9e361da97763	508	ZEXTERN int ZEXPORT inflateEnd OF((z_streamp strm));
TMBOY	47:9e361da97763	509	/*
TMBOY	47:9e361da97763	510	All dynamically allocated data structures for this stream are freed.
TMBOY	47:9e361da97763	511	This function discards any unprocessed input and does not flush any pending
TMBOY	47:9e361da97763	512	output.
TMBOY	47:9e361da97763	513
TMBOY	47:9e361da97763	514	inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state
TMBOY	47:9e361da97763	515	was inconsistent. In the error case, msg may be set but then points to a
TMBOY	47:9e361da97763	516	static string (which must not be deallocated).
TMBOY	47:9e361da97763	517	*/
TMBOY	47:9e361da97763	518
TMBOY	47:9e361da97763	519
TMBOY	47:9e361da97763	520	/* Advanced functions */
TMBOY	47:9e361da97763	521
TMBOY	47:9e361da97763	522	/*
TMBOY	47:9e361da97763	523	The following functions are needed only in some special applications.
TMBOY	47:9e361da97763	524	*/
TMBOY	47:9e361da97763	525
TMBOY	47:9e361da97763	526	/*
TMBOY	47:9e361da97763	527	ZEXTERN int ZEXPORT deflateInit2 OF((z_streamp strm,
TMBOY	47:9e361da97763	528	int level,
TMBOY	47:9e361da97763	529	int method,
TMBOY	47:9e361da97763	530	int windowBits,
TMBOY	47:9e361da97763	531	int memLevel,
TMBOY	47:9e361da97763	532	int strategy));
TMBOY	47:9e361da97763	533
TMBOY	47:9e361da97763	534	This is another version of deflateInit with more compression options. The
TMBOY	47:9e361da97763	535	fields next_in, zalloc, zfree and opaque must be initialized before by the
TMBOY	47:9e361da97763	536	caller.
TMBOY	47:9e361da97763	537
TMBOY	47:9e361da97763	538	The method parameter is the compression method. It must be Z_DEFLATED in
TMBOY	47:9e361da97763	539	this version of the library.
TMBOY	47:9e361da97763	540
TMBOY	47:9e361da97763	541	The windowBits parameter is the base two logarithm of the window size
TMBOY	47:9e361da97763	542	(the size of the history buffer). It should be in the range 8..15 for this
TMBOY	47:9e361da97763	543	version of the library. Larger values of this parameter result in better
TMBOY	47:9e361da97763	544	compression at the expense of memory usage. The default value is 15 if
TMBOY	47:9e361da97763	545	deflateInit is used instead.
TMBOY	47:9e361da97763	546
TMBOY	47:9e361da97763	547	windowBits can also be -8..-15 for raw deflate. In this case, -windowBits
TMBOY	47:9e361da97763	548	determines the window size. deflate() will then generate raw deflate data
TMBOY	47:9e361da97763	549	with no zlib header or trailer, and will not compute an adler32 check value.
TMBOY	47:9e361da97763	550
TMBOY	47:9e361da97763	551	windowBits can also be greater than 15 for optional gzip encoding. Add
TMBOY	47:9e361da97763	552	16 to windowBits to write a simple gzip header and trailer around the
TMBOY	47:9e361da97763	553	compressed data instead of a zlib wrapper. The gzip header will have no
TMBOY	47:9e361da97763	554	file name, no extra data, no comment, no modification time (set to zero), no
TMBOY	47:9e361da97763	555	header crc, and the operating system will be set to 255 (unknown). If a
TMBOY	47:9e361da97763	556	gzip stream is being written, strm->adler is a crc32 instead of an adler32.
TMBOY	47:9e361da97763	557
TMBOY	47:9e361da97763	558	The memLevel parameter specifies how much memory should be allocated
TMBOY	47:9e361da97763	559	for the internal compression state. memLevel=1 uses minimum memory but is
TMBOY	47:9e361da97763	560	slow and reduces compression ratio; memLevel=9 uses maximum memory for
TMBOY	47:9e361da97763	561	optimal speed. The default value is 8. See zconf.h for total memory usage
TMBOY	47:9e361da97763	562	as a function of windowBits and memLevel.
TMBOY	47:9e361da97763	563
TMBOY	47:9e361da97763	564	The strategy parameter is used to tune the compression algorithm. Use the
TMBOY	47:9e361da97763	565	value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a
TMBOY	47:9e361da97763	566	filter (or predictor), Z_HUFFMAN_ONLY to force Huffman encoding only (no
TMBOY	47:9e361da97763	567	string match), or Z_RLE to limit match distances to one (run-length
TMBOY	47:9e361da97763	568	encoding). Filtered data consists mostly of small values with a somewhat
TMBOY	47:9e361da97763	569	random distribution. In this case, the compression algorithm is tuned to
TMBOY	47:9e361da97763	570	compress them better. The effect of Z_FILTERED is to force more Huffman
TMBOY	47:9e361da97763	571	coding and less string matching; it is somewhat intermediate between
TMBOY	47:9e361da97763	572	Z_DEFAULT_STRATEGY and Z_HUFFMAN_ONLY. Z_RLE is designed to be almost as
TMBOY	47:9e361da97763	573	fast as Z_HUFFMAN_ONLY, but give better compression for PNG image data. The
TMBOY	47:9e361da97763	574	strategy parameter only affects the compression ratio but not the
TMBOY	47:9e361da97763	575	correctness of the compressed output even if it is not set appropriately.
TMBOY	47:9e361da97763	576	Z_FIXED prevents the use of dynamic Huffman codes, allowing for a simpler
TMBOY	47:9e361da97763	577	decoder for special applications.
TMBOY	47:9e361da97763	578
TMBOY	47:9e361da97763	579	deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
TMBOY	47:9e361da97763	580	memory, Z_STREAM_ERROR if any parameter is invalid (such as an invalid
TMBOY	47:9e361da97763	581	method), or Z_VERSION_ERROR if the zlib library version (zlib_version) is
TMBOY	47:9e361da97763	582	incompatible with the version assumed by the caller (ZLIB_VERSION). msg is
TMBOY	47:9e361da97763	583	set to null if there is no error message. deflateInit2 does not perform any
TMBOY	47:9e361da97763	584	compression: this will be done by deflate().
TMBOY	47:9e361da97763	585	*/
TMBOY	47:9e361da97763	586
TMBOY	47:9e361da97763	587	ZEXTERN int ZEXPORT deflateSetDictionary OF((z_streamp strm,
TMBOY	47:9e361da97763	588	const Bytef *dictionary,
TMBOY	47:9e361da97763	589	uInt dictLength));
TMBOY	47:9e361da97763	590	/*
TMBOY	47:9e361da97763	591	Initializes the compression dictionary from the given byte sequence
TMBOY	47:9e361da97763	592	without producing any compressed output. When using the zlib format, this
TMBOY	47:9e361da97763	593	function must be called immediately after deflateInit, deflateInit2 or
TMBOY	47:9e361da97763	594	deflateReset, and before any call of deflate. When doing raw deflate, this
TMBOY	47:9e361da97763	595	function must be called either before any call of deflate, or immediately
TMBOY	47:9e361da97763	596	after the completion of a deflate block, i.e. after all input has been
TMBOY	47:9e361da97763	597	consumed and all output has been delivered when using any of the flush
TMBOY	47:9e361da97763	598	options Z_BLOCK, Z_PARTIAL_FLUSH, Z_SYNC_FLUSH, or Z_FULL_FLUSH. The
TMBOY	47:9e361da97763	599	compressor and decompressor must use exactly the same dictionary (see
TMBOY	47:9e361da97763	600	inflateSetDictionary).
TMBOY	47:9e361da97763	601
TMBOY	47:9e361da97763	602	The dictionary should consist of strings (byte sequences) that are likely
TMBOY	47:9e361da97763	603	to be encountered later in the data to be compressed, with the most commonly
TMBOY	47:9e361da97763	604	used strings preferably put towards the end of the dictionary. Using a
TMBOY	47:9e361da97763	605	dictionary is most useful when the data to be compressed is short and can be
TMBOY	47:9e361da97763	606	predicted with good accuracy; the data can then be compressed better than
TMBOY	47:9e361da97763	607	with the default empty dictionary.
TMBOY	47:9e361da97763	608
TMBOY	47:9e361da97763	609	Depending on the size of the compression data structures selected by
TMBOY	47:9e361da97763	610	deflateInit or deflateInit2, a part of the dictionary may in effect be
TMBOY	47:9e361da97763	611	discarded, for example if the dictionary is larger than the window size
TMBOY	47:9e361da97763	612	provided in deflateInit or deflateInit2. Thus the strings most likely to be
TMBOY	47:9e361da97763	613	useful should be put at the end of the dictionary, not at the front. In
TMBOY	47:9e361da97763	614	addition, the current implementation of deflate will use at most the window
TMBOY	47:9e361da97763	615	size minus 262 bytes of the provided dictionary.
TMBOY	47:9e361da97763	616
TMBOY	47:9e361da97763	617	Upon return of this function, strm->adler is set to the adler32 value
TMBOY	47:9e361da97763	618	of the dictionary; the decompressor may later use this value to determine
TMBOY	47:9e361da97763	619	which dictionary has been used by the compressor. (The adler32 value
TMBOY	47:9e361da97763	620	applies to the whole dictionary even if only a subset of the dictionary is
TMBOY	47:9e361da97763	621	actually used by the compressor.) If a raw deflate was requested, then the
TMBOY	47:9e361da97763	622	adler32 value is not computed and strm->adler is not set.
TMBOY	47:9e361da97763	623
TMBOY	47:9e361da97763	624	deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a
TMBOY	47:9e361da97763	625	parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is
TMBOY	47:9e361da97763	626	inconsistent (for example if deflate has already been called for this stream
TMBOY	47:9e361da97763	627	or if not at a block boundary for raw deflate). deflateSetDictionary does
TMBOY	47:9e361da97763	628	not perform any compression: this will be done by deflate().
TMBOY	47:9e361da97763	629	*/
TMBOY	47:9e361da97763	630
TMBOY	47:9e361da97763	631	ZEXTERN int ZEXPORT deflateCopy OF((z_streamp dest,
TMBOY	47:9e361da97763	632	z_streamp source));
TMBOY	47:9e361da97763	633	/*
TMBOY	47:9e361da97763	634	Sets the destination stream as a complete copy of the source stream.
TMBOY	47:9e361da97763	635
TMBOY	47:9e361da97763	636	This function can be useful when several compression strategies will be
TMBOY	47:9e361da97763	637	tried, for example when there are several ways of pre-processing the input
TMBOY	47:9e361da97763	638	data with a filter. The streams that will be discarded should then be freed
TMBOY	47:9e361da97763	639	by calling deflateEnd. Note that deflateCopy duplicates the internal
TMBOY	47:9e361da97763	640	compression state which can be quite large, so this strategy is slow and can
TMBOY	47:9e361da97763	641	consume lots of memory.
TMBOY	47:9e361da97763	642
TMBOY	47:9e361da97763	643	deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not
TMBOY	47:9e361da97763	644	enough memory, Z_STREAM_ERROR if the source stream state was inconsistent
TMBOY	47:9e361da97763	645	(such as zalloc being Z_NULL). msg is left unchanged in both source and
TMBOY	47:9e361da97763	646	destination.
TMBOY	47:9e361da97763	647	*/
TMBOY	47:9e361da97763	648
TMBOY	47:9e361da97763	649	ZEXTERN int ZEXPORT deflateReset OF((z_streamp strm));
TMBOY	47:9e361da97763	650	/*
TMBOY	47:9e361da97763	651	This function is equivalent to deflateEnd followed by deflateInit,
TMBOY	47:9e361da97763	652	but does not free and reallocate all the internal compression state. The
TMBOY	47:9e361da97763	653	stream will keep the same compression level and any other attributes that
TMBOY	47:9e361da97763	654	may have been set by deflateInit2.
TMBOY	47:9e361da97763	655
TMBOY	47:9e361da97763	656	deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
TMBOY	47:9e361da97763	657	stream state was inconsistent (such as zalloc or state being Z_NULL).
TMBOY	47:9e361da97763	658	*/
TMBOY	47:9e361da97763	659
TMBOY	47:9e361da97763	660	ZEXTERN int ZEXPORT deflateParams OF((z_streamp strm,
TMBOY	47:9e361da97763	661	int level,
TMBOY	47:9e361da97763	662	int strategy));
TMBOY	47:9e361da97763	663	/*
TMBOY	47:9e361da97763	664	Dynamically update the compression level and compression strategy. The
TMBOY	47:9e361da97763	665	interpretation of level and strategy is as in deflateInit2. This can be
TMBOY	47:9e361da97763	666	used to switch between compression and straight copy of the input data, or
TMBOY	47:9e361da97763	667	to switch to a different kind of input data requiring a different strategy.
TMBOY	47:9e361da97763	668	If the compression level is changed, the input available so far is
TMBOY	47:9e361da97763	669	compressed with the old level (and may be flushed); the new level will take
TMBOY	47:9e361da97763	670	effect only at the next call of deflate().
TMBOY	47:9e361da97763	671
TMBOY	47:9e361da97763	672	Before the call of deflateParams, the stream state must be set as for
TMBOY	47:9e361da97763	673	a call of deflate(), since the currently available input may have to be
TMBOY	47:9e361da97763	674	compressed and flushed. In particular, strm->avail_out must be non-zero.
TMBOY	47:9e361da97763	675
TMBOY	47:9e361da97763	676	deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source
TMBOY	47:9e361da97763	677	stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR if
TMBOY	47:9e361da97763	678	strm->avail_out was zero.
TMBOY	47:9e361da97763	679	*/
TMBOY	47:9e361da97763	680
TMBOY	47:9e361da97763	681	ZEXTERN int ZEXPORT deflateTune OF((z_streamp strm,
TMBOY	47:9e361da97763	682	int good_length,
TMBOY	47:9e361da97763	683	int max_lazy,
TMBOY	47:9e361da97763	684	int nice_length,
TMBOY	47:9e361da97763	685	int max_chain));
TMBOY	47:9e361da97763	686	/*
TMBOY	47:9e361da97763	687	Fine tune deflate's internal compression parameters. This should only be
TMBOY	47:9e361da97763	688	used by someone who understands the algorithm used by zlib's deflate for
TMBOY	47:9e361da97763	689	searching for the best matching string, and even then only by the most
TMBOY	47:9e361da97763	690	fanatic optimizer trying to squeeze out the last compressed bit for their
TMBOY	47:9e361da97763	691	specific input data. Read the deflate.c source code for the meaning of the
TMBOY	47:9e361da97763	692	max_lazy, good_length, nice_length, and max_chain parameters.
TMBOY	47:9e361da97763	693
TMBOY	47:9e361da97763	694	deflateTune() can be called after deflateInit() or deflateInit2(), and
TMBOY	47:9e361da97763	695	returns Z_OK on success, or Z_STREAM_ERROR for an invalid deflate stream.
TMBOY	47:9e361da97763	696	*/
TMBOY	47:9e361da97763	697
TMBOY	47:9e361da97763	698	ZEXTERN uLong ZEXPORT deflateBound OF((z_streamp strm,
TMBOY	47:9e361da97763	699	uLong sourceLen));
TMBOY	47:9e361da97763	700	/*
TMBOY	47:9e361da97763	701	deflateBound() returns an upper bound on the compressed size after
TMBOY	47:9e361da97763	702	deflation of sourceLen bytes. It must be called after deflateInit() or
TMBOY	47:9e361da97763	703	deflateInit2(), and after deflateSetHeader(), if used. This would be used
TMBOY	47:9e361da97763	704	to allocate an output buffer for deflation in a single pass, and so would be
TMBOY	47:9e361da97763	705	called before deflate(). If that first deflate() call is provided the
TMBOY	47:9e361da97763	706	sourceLen input bytes, an output buffer allocated to the size returned by
TMBOY	47:9e361da97763	707	deflateBound(), and the flush value Z_FINISH, then deflate() is guaranteed
TMBOY	47:9e361da97763	708	to return Z_STREAM_END. Note that it is possible for the compressed size to
TMBOY	47:9e361da97763	709	be larger than the value returned by deflateBound() if flush options other
TMBOY	47:9e361da97763	710	than Z_FINISH or Z_NO_FLUSH are used.
TMBOY	47:9e361da97763	711	*/
TMBOY	47:9e361da97763	712
TMBOY	47:9e361da97763	713	ZEXTERN int ZEXPORT deflatePending OF((z_streamp strm,
TMBOY	47:9e361da97763	714	unsigned *pending,
TMBOY	47:9e361da97763	715	int *bits));
TMBOY	47:9e361da97763	716	/*
TMBOY	47:9e361da97763	717	deflatePending() returns the number of bytes and bits of output that have
TMBOY	47:9e361da97763	718	been generated, but not yet provided in the available output. The bytes not
TMBOY	47:9e361da97763	719	provided would be due to the available output space having being consumed.
TMBOY	47:9e361da97763	720	The number of bits of output not provided are between 0 and 7, where they
TMBOY	47:9e361da97763	721	await more bits to join them in order to fill out a full byte. If pending
TMBOY	47:9e361da97763	722	or bits are Z_NULL, then those values are not set.
TMBOY	47:9e361da97763	723
TMBOY	47:9e361da97763	724	deflatePending returns Z_OK if success, or Z_STREAM_ERROR if the source
TMBOY	47:9e361da97763	725	stream state was inconsistent.
TMBOY	47:9e361da97763	726	*/
TMBOY	47:9e361da97763	727
TMBOY	47:9e361da97763	728	ZEXTERN int ZEXPORT deflatePrime OF((z_streamp strm,
TMBOY	47:9e361da97763	729	int bits,
TMBOY	47:9e361da97763	730	int value));
TMBOY	47:9e361da97763	731	/*
TMBOY	47:9e361da97763	732	deflatePrime() inserts bits in the deflate output stream. The intent
TMBOY	47:9e361da97763	733	is that this function is used to start off the deflate output with the bits
TMBOY	47:9e361da97763	734	leftover from a previous deflate stream when appending to it. As such, this
TMBOY	47:9e361da97763	735	function can only be used for raw deflate, and must be used before the first
TMBOY	47:9e361da97763	736	deflate() call after a deflateInit2() or deflateReset(). bits must be less
TMBOY	47:9e361da97763	737	than or equal to 16, and that many of the least significant bits of value
TMBOY	47:9e361da97763	738	will be inserted in the output.
TMBOY	47:9e361da97763	739
TMBOY	47:9e361da97763	740	deflatePrime returns Z_OK if success, Z_BUF_ERROR if there was not enough
TMBOY	47:9e361da97763	741	room in the internal buffer to insert the bits, or Z_STREAM_ERROR if the
TMBOY	47:9e361da97763	742	source stream state was inconsistent.
TMBOY	47:9e361da97763	743	*/
TMBOY	47:9e361da97763	744
TMBOY	47:9e361da97763	745	ZEXTERN int ZEXPORT deflateSetHeader OF((z_streamp strm,
TMBOY	47:9e361da97763	746	gz_headerp head));
TMBOY	47:9e361da97763	747	/*
TMBOY	47:9e361da97763	748	deflateSetHeader() provides gzip header information for when a gzip
TMBOY	47:9e361da97763	749	stream is requested by deflateInit2(). deflateSetHeader() may be called
TMBOY	47:9e361da97763	750	after deflateInit2() or deflateReset() and before the first call of
TMBOY	47:9e361da97763	751	deflate(). The text, time, os, extra field, name, and comment information
TMBOY	47:9e361da97763	752	in the provided gz_header structure are written to the gzip header (xflag is
TMBOY	47:9e361da97763	753	ignored -- the extra flags are set according to the compression level). The
TMBOY	47:9e361da97763	754	caller must assure that, if not Z_NULL, name and comment are terminated with
TMBOY	47:9e361da97763	755	a zero byte, and that if extra is not Z_NULL, that extra_len bytes are
TMBOY	47:9e361da97763	756	available there. If hcrc is true, a gzip header crc is included. Note that
TMBOY	47:9e361da97763	757	the current versions of the command-line version of gzip (up through version
TMBOY	47:9e361da97763	758	1.3.x) do not support header crc's, and will report that it is a "multi-part
TMBOY	47:9e361da97763	759	gzip file" and give up.
TMBOY	47:9e361da97763	760
TMBOY	47:9e361da97763	761	If deflateSetHeader is not used, the default gzip header has text false,
TMBOY	47:9e361da97763	762	the time set to zero, and os set to 255, with no extra, name, or comment
TMBOY	47:9e361da97763	763	fields. The gzip header is returned to the default state by deflateReset().
TMBOY	47:9e361da97763	764
TMBOY	47:9e361da97763	765	deflateSetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source
TMBOY	47:9e361da97763	766	stream state was inconsistent.
TMBOY	47:9e361da97763	767	*/
TMBOY	47:9e361da97763	768
TMBOY	47:9e361da97763	769	/*
TMBOY	47:9e361da97763	770	ZEXTERN int ZEXPORT inflateInit2 OF((z_streamp strm,
TMBOY	47:9e361da97763	771	int windowBits));
TMBOY	47:9e361da97763	772
TMBOY	47:9e361da97763	773	This is another version of inflateInit with an extra parameter. The
TMBOY	47:9e361da97763	774	fields next_in, avail_in, zalloc, zfree and opaque must be initialized
TMBOY	47:9e361da97763	775	before by the caller.
TMBOY	47:9e361da97763	776
TMBOY	47:9e361da97763	777	The windowBits parameter is the base two logarithm of the maximum window
TMBOY	47:9e361da97763	778	size (the size of the history buffer). It should be in the range 8..15 for
TMBOY	47:9e361da97763	779	this version of the library. The default value is 15 if inflateInit is used
TMBOY	47:9e361da97763	780	instead. windowBits must be greater than or equal to the windowBits value
TMBOY	47:9e361da97763	781	provided to deflateInit2() while compressing, or it must be equal to 15 if
TMBOY	47:9e361da97763	782	deflateInit2() was not used. If a compressed stream with a larger window
TMBOY	47:9e361da97763	783	size is given as input, inflate() will return with the error code
TMBOY	47:9e361da97763	784	Z_DATA_ERROR instead of trying to allocate a larger window.
TMBOY	47:9e361da97763	785
TMBOY	47:9e361da97763	786	windowBits can also be zero to request that inflate use the window size in
TMBOY	47:9e361da97763	787	the zlib header of the compressed stream.
TMBOY	47:9e361da97763	788
TMBOY	47:9e361da97763	789	windowBits can also be -8..-15 for raw inflate. In this case, -windowBits
TMBOY	47:9e361da97763	790	determines the window size. inflate() will then process raw deflate data,
TMBOY	47:9e361da97763	791	not looking for a zlib or gzip header, not generating a check value, and not
TMBOY	47:9e361da97763	792	looking for any check values for comparison at the end of the stream. This
TMBOY	47:9e361da97763	793	is for use with other formats that use the deflate compressed data format
TMBOY	47:9e361da97763	794	such as zip. Those formats provide their own check values. If a custom
TMBOY	47:9e361da97763	795	format is developed using the raw deflate format for compressed data, it is
TMBOY	47:9e361da97763	796	recommended that a check value such as an adler32 or a crc32 be applied to
TMBOY	47:9e361da97763	797	the uncompressed data as is done in the zlib, gzip, and zip formats. For
TMBOY	47:9e361da97763	798	most applications, the zlib format should be used as is. Note that comments
TMBOY	47:9e361da97763	799	above on the use in deflateInit2() applies to the magnitude of windowBits.
TMBOY	47:9e361da97763	800
TMBOY	47:9e361da97763	801	windowBits can also be greater than 15 for optional gzip decoding. Add
TMBOY	47:9e361da97763	802	32 to windowBits to enable zlib and gzip decoding with automatic header
TMBOY	47:9e361da97763	803	detection, or add 16 to decode only the gzip format (the zlib format will
TMBOY	47:9e361da97763	804	return a Z_DATA_ERROR). If a gzip stream is being decoded, strm->adler is a
TMBOY	47:9e361da97763	805	crc32 instead of an adler32.
TMBOY	47:9e361da97763	806
TMBOY	47:9e361da97763	807	inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
TMBOY	47:9e361da97763	808	memory, Z_VERSION_ERROR if the zlib library version is incompatible with the
TMBOY	47:9e361da97763	809	version assumed by the caller, or Z_STREAM_ERROR if the parameters are
TMBOY	47:9e361da97763	810	invalid, such as a null pointer to the structure. msg is set to null if
TMBOY	47:9e361da97763	811	there is no error message. inflateInit2 does not perform any decompression
TMBOY	47:9e361da97763	812	apart from possibly reading the zlib header if present: actual decompression
TMBOY	47:9e361da97763	813	will be done by inflate(). (So next_in and avail_in may be modified, but
TMBOY	47:9e361da97763	814	next_out and avail_out are unused and unchanged.) The current implementation
TMBOY	47:9e361da97763	815	of inflateInit2() does not process any header information -- that is
TMBOY	47:9e361da97763	816	deferred until inflate() is called.
TMBOY	47:9e361da97763	817	*/
TMBOY	47:9e361da97763	818
TMBOY	47:9e361da97763	819	ZEXTERN int ZEXPORT inflateSetDictionary OF((z_streamp strm,
TMBOY	47:9e361da97763	820	const Bytef *dictionary,
TMBOY	47:9e361da97763	821	uInt dictLength));
TMBOY	47:9e361da97763	822	/*
TMBOY	47:9e361da97763	823	Initializes the decompression dictionary from the given uncompressed byte
TMBOY	47:9e361da97763	824	sequence. This function must be called immediately after a call of inflate,
TMBOY	47:9e361da97763	825	if that call returned Z_NEED_DICT. The dictionary chosen by the compressor
TMBOY	47:9e361da97763	826	can be determined from the adler32 value returned by that call of inflate.
TMBOY	47:9e361da97763	827	The compressor and decompressor must use exactly the same dictionary (see
TMBOY	47:9e361da97763	828	deflateSetDictionary). For raw inflate, this function can be called at any
TMBOY	47:9e361da97763	829	time to set the dictionary. If the provided dictionary is smaller than the
TMBOY	47:9e361da97763	830	window and there is already data in the window, then the provided dictionary
TMBOY	47:9e361da97763	831	will amend what's there. The application must insure that the dictionary
TMBOY	47:9e361da97763	832	that was used for compression is provided.
TMBOY	47:9e361da97763	833
TMBOY	47:9e361da97763	834	inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a
TMBOY	47:9e361da97763	835	parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is
TMBOY	47:9e361da97763	836	inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the
TMBOY	47:9e361da97763	837	expected one (incorrect adler32 value). inflateSetDictionary does not
TMBOY	47:9e361da97763	838	perform any decompression: this will be done by subsequent calls of
TMBOY	47:9e361da97763	839	inflate().
TMBOY	47:9e361da97763	840	*/
TMBOY	47:9e361da97763	841
TMBOY	47:9e361da97763	842	ZEXTERN int ZEXPORT inflateGetDictionary OF((z_streamp strm,
TMBOY	47:9e361da97763	843	Bytef *dictionary,
TMBOY	47:9e361da97763	844	uInt *dictLength));
TMBOY	47:9e361da97763	845	/*
TMBOY	47:9e361da97763	846	Returns the sliding dictionary being maintained by inflate. dictLength is
TMBOY	47:9e361da97763	847	set to the number of bytes in the dictionary, and that many bytes are copied
TMBOY	47:9e361da97763	848	to dictionary. dictionary must have enough space, where 32768 bytes is
TMBOY	47:9e361da97763	849	always enough. If inflateGetDictionary() is called with dictionary equal to
TMBOY	47:9e361da97763	850	Z_NULL, then only the dictionary length is returned, and nothing is copied.
TMBOY	47:9e361da97763	851	Similary, if dictLength is Z_NULL, then it is not set.
TMBOY	47:9e361da97763	852
TMBOY	47:9e361da97763	853	inflateGetDictionary returns Z_OK on success, or Z_STREAM_ERROR if the
TMBOY	47:9e361da97763	854	stream state is inconsistent.
TMBOY	47:9e361da97763	855	*/
TMBOY	47:9e361da97763	856
TMBOY	47:9e361da97763	857	ZEXTERN int ZEXPORT inflateSync OF((z_streamp strm));
TMBOY	47:9e361da97763	858	/*
TMBOY	47:9e361da97763	859	Skips invalid compressed data until a possible full flush point (see above
TMBOY	47:9e361da97763	860	for the description of deflate with Z_FULL_FLUSH) can be found, or until all
TMBOY	47:9e361da97763	861	available input is skipped. No output is provided.
TMBOY	47:9e361da97763	862
TMBOY	47:9e361da97763	863	inflateSync searches for a 00 00 FF FF pattern in the compressed data.
TMBOY	47:9e361da97763	864	All full flush points have this pattern, but not all occurrences of this
TMBOY	47:9e361da97763	865	pattern are full flush points.
TMBOY	47:9e361da97763	866
TMBOY	47:9e361da97763	867	inflateSync returns Z_OK if a possible full flush point has been found,
TMBOY	47:9e361da97763	868	Z_BUF_ERROR if no more input was provided, Z_DATA_ERROR if no flush point
TMBOY	47:9e361da97763	869	has been found, or Z_STREAM_ERROR if the stream structure was inconsistent.
TMBOY	47:9e361da97763	870	In the success case, the application may save the current current value of
TMBOY	47:9e361da97763	871	total_in which indicates where valid compressed data was found. In the
TMBOY	47:9e361da97763	872	error case, the application may repeatedly call inflateSync, providing more
TMBOY	47:9e361da97763	873	input each time, until success or end of the input data.
TMBOY	47:9e361da97763	874	*/
TMBOY	47:9e361da97763	875
TMBOY	47:9e361da97763	876	ZEXTERN int ZEXPORT inflateCopy OF((z_streamp dest,
TMBOY	47:9e361da97763	877	z_streamp source));
TMBOY	47:9e361da97763	878	/*
TMBOY	47:9e361da97763	879	Sets the destination stream as a complete copy of the source stream.
TMBOY	47:9e361da97763	880
TMBOY	47:9e361da97763	881	This function can be useful when randomly accessing a large stream. The
TMBOY	47:9e361da97763	882	first pass through the stream can periodically record the inflate state,
TMBOY	47:9e361da97763	883	allowing restarting inflate at those points when randomly accessing the
TMBOY	47:9e361da97763	884	stream.
TMBOY	47:9e361da97763	885
TMBOY	47:9e361da97763	886	inflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not
TMBOY	47:9e361da97763	887	enough memory, Z_STREAM_ERROR if the source stream state was inconsistent
TMBOY	47:9e361da97763	888	(such as zalloc being Z_NULL). msg is left unchanged in both source and
TMBOY	47:9e361da97763	889	destination.
TMBOY	47:9e361da97763	890	*/
TMBOY	47:9e361da97763	891
TMBOY	47:9e361da97763	892	ZEXTERN int ZEXPORT inflateReset OF((z_streamp strm));
TMBOY	47:9e361da97763	893	/*
TMBOY	47:9e361da97763	894	This function is equivalent to inflateEnd followed by inflateInit,
TMBOY	47:9e361da97763	895	but does not free and reallocate all the internal decompression state. The
TMBOY	47:9e361da97763	896	stream will keep attributes that may have been set by inflateInit2.
TMBOY	47:9e361da97763	897
TMBOY	47:9e361da97763	898	inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
TMBOY	47:9e361da97763	899	stream state was inconsistent (such as zalloc or state being Z_NULL).
TMBOY	47:9e361da97763	900	*/
TMBOY	47:9e361da97763	901
TMBOY	47:9e361da97763	902	ZEXTERN int ZEXPORT inflateReset2 OF((z_streamp strm,
TMBOY	47:9e361da97763	903	int windowBits));
TMBOY	47:9e361da97763	904	/*
TMBOY	47:9e361da97763	905	This function is the same as inflateReset, but it also permits changing
TMBOY	47:9e361da97763	906	the wrap and window size requests. The windowBits parameter is interpreted
TMBOY	47:9e361da97763	907	the same as it is for inflateInit2.
TMBOY	47:9e361da97763	908
TMBOY	47:9e361da97763	909	inflateReset2 returns Z_OK if success, or Z_STREAM_ERROR if the source
TMBOY	47:9e361da97763	910	stream state was inconsistent (such as zalloc or state being Z_NULL), or if
TMBOY	47:9e361da97763	911	the windowBits parameter is invalid.
TMBOY	47:9e361da97763	912	*/
TMBOY	47:9e361da97763	913
TMBOY	47:9e361da97763	914	ZEXTERN int ZEXPORT inflatePrime OF((z_streamp strm,
TMBOY	47:9e361da97763	915	int bits,
TMBOY	47:9e361da97763	916	int value));
TMBOY	47:9e361da97763	917	/*
TMBOY	47:9e361da97763	918	This function inserts bits in the inflate input stream. The intent is
TMBOY	47:9e361da97763	919	that this function is used to start inflating at a bit position in the
TMBOY	47:9e361da97763	920	middle of a byte. The provided bits will be used before any bytes are used
TMBOY	47:9e361da97763	921	from next_in. This function should only be used with raw inflate, and
TMBOY	47:9e361da97763	922	should be used before the first inflate() call after inflateInit2() or
TMBOY	47:9e361da97763	923	inflateReset(). bits must be less than or equal to 16, and that many of the
TMBOY	47:9e361da97763	924	least significant bits of value will be inserted in the input.
TMBOY	47:9e361da97763	925
TMBOY	47:9e361da97763	926	If bits is negative, then the input stream bit buffer is emptied. Then
TMBOY	47:9e361da97763	927	inflatePrime() can be called again to put bits in the buffer. This is used
TMBOY	47:9e361da97763	928	to clear out bits leftover after feeding inflate a block description prior
TMBOY	47:9e361da97763	929	to feeding inflate codes.
TMBOY	47:9e361da97763	930
TMBOY	47:9e361da97763	931	inflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source
TMBOY	47:9e361da97763	932	stream state was inconsistent.
TMBOY	47:9e361da97763	933	*/
TMBOY	47:9e361da97763	934
TMBOY	47:9e361da97763	935	ZEXTERN long ZEXPORT inflateMark OF((z_streamp strm));
TMBOY	47:9e361da97763	936	/*
TMBOY	47:9e361da97763	937	This function returns two values, one in the lower 16 bits of the return
TMBOY	47:9e361da97763	938	value, and the other in the remaining upper bits, obtained by shifting the
TMBOY	47:9e361da97763	939	return value down 16 bits. If the upper value is -1 and the lower value is
TMBOY	47:9e361da97763	940	zero, then inflate() is currently decoding information outside of a block.
TMBOY	47:9e361da97763	941	If the upper value is -1 and the lower value is non-zero, then inflate is in
TMBOY	47:9e361da97763	942	the middle of a stored block, with the lower value equaling the number of
TMBOY	47:9e361da97763	943	bytes from the input remaining to copy. If the upper value is not -1, then
TMBOY	47:9e361da97763	944	it is the number of bits back from the current bit position in the input of
TMBOY	47:9e361da97763	945	the code (literal or length/distance pair) currently being processed. In
TMBOY	47:9e361da97763	946	that case the lower value is the number of bytes already emitted for that
TMBOY	47:9e361da97763	947	code.
TMBOY	47:9e361da97763	948
TMBOY	47:9e361da97763	949	A code is being processed if inflate is waiting for more input to complete
TMBOY	47:9e361da97763	950	decoding of the code, or if it has completed decoding but is waiting for
TMBOY	47:9e361da97763	951	more output space to write the literal or match data.
TMBOY	47:9e361da97763	952
TMBOY	47:9e361da97763	953	inflateMark() is used to mark locations in the input data for random
TMBOY	47:9e361da97763	954	access, which may be at bit positions, and to note those cases where the
TMBOY	47:9e361da97763	955	output of a code may span boundaries of random access blocks. The current
TMBOY	47:9e361da97763	956	location in the input stream can be determined from avail_in and data_type
TMBOY	47:9e361da97763	957	as noted in the description for the Z_BLOCK flush parameter for inflate.
TMBOY	47:9e361da97763	958
TMBOY	47:9e361da97763	959	inflateMark returns the value noted above or -1 << 16 if the provided
TMBOY	47:9e361da97763	960	source stream state was inconsistent.
TMBOY	47:9e361da97763	961	*/
TMBOY	47:9e361da97763	962
TMBOY	47:9e361da97763	963	ZEXTERN int ZEXPORT inflateGetHeader OF((z_streamp strm,
TMBOY	47:9e361da97763	964	gz_headerp head));
TMBOY	47:9e361da97763	965	/*
TMBOY	47:9e361da97763	966	inflateGetHeader() requests that gzip header information be stored in the
TMBOY	47:9e361da97763	967	provided gz_header structure. inflateGetHeader() may be called after
TMBOY	47:9e361da97763	968	inflateInit2() or inflateReset(), and before the first call of inflate().
TMBOY	47:9e361da97763	969	As inflate() processes the gzip stream, head->done is zero until the header
TMBOY	47:9e361da97763	970	is completed, at which time head->done is set to one. If a zlib stream is
TMBOY	47:9e361da97763	971	being decoded, then head->done is set to -1 to indicate that there will be
TMBOY	47:9e361da97763	972	no gzip header information forthcoming. Note that Z_BLOCK or Z_TREES can be
TMBOY	47:9e361da97763	973	used to force inflate() to return immediately after header processing is
TMBOY	47:9e361da97763	974	complete and before any actual data is decompressed.
TMBOY	47:9e361da97763	975
TMBOY	47:9e361da97763	976	The text, time, xflags, and os fields are filled in with the gzip header
TMBOY	47:9e361da97763	977	contents. hcrc is set to true if there is a header CRC. (The header CRC
TMBOY	47:9e361da97763	978	was valid if done is set to one.) If extra is not Z_NULL, then extra_max
TMBOY	47:9e361da97763	979	contains the maximum number of bytes to write to extra. Once done is true,
TMBOY	47:9e361da97763	980	extra_len contains the actual extra field length, and extra contains the
TMBOY	47:9e361da97763	981	extra field, or that field truncated if extra_max is less than extra_len.
TMBOY	47:9e361da97763	982	If name is not Z_NULL, then up to name_max characters are written there,
TMBOY	47:9e361da97763	983	terminated with a zero unless the length is greater than name_max. If
TMBOY	47:9e361da97763	984	comment is not Z_NULL, then up to comm_max characters are written there,
TMBOY	47:9e361da97763	985	terminated with a zero unless the length is greater than comm_max. When any
TMBOY	47:9e361da97763	986	of extra, name, or comment are not Z_NULL and the respective field is not
TMBOY	47:9e361da97763	987	present in the header, then that field is set to Z_NULL to signal its
TMBOY	47:9e361da97763	988	absence. This allows the use of deflateSetHeader() with the returned
TMBOY	47:9e361da97763	989	structure to duplicate the header. However if those fields are set to
TMBOY	47:9e361da97763	990	allocated memory, then the application will need to save those pointers
TMBOY	47:9e361da97763	991	elsewhere so that they can be eventually freed.
TMBOY	47:9e361da97763	992
TMBOY	47:9e361da97763	993	If inflateGetHeader is not used, then the header information is simply
TMBOY	47:9e361da97763	994	discarded. The header is always checked for validity, including the header
TMBOY	47:9e361da97763	995	CRC if present. inflateReset() will reset the process to discard the header
TMBOY	47:9e361da97763	996	information. The application would need to call inflateGetHeader() again to
TMBOY	47:9e361da97763	997	retrieve the header from the next gzip stream.
TMBOY	47:9e361da97763	998
TMBOY	47:9e361da97763	999	inflateGetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source
TMBOY	47:9e361da97763	1000	stream state was inconsistent.
TMBOY	47:9e361da97763	1001	*/
TMBOY	47:9e361da97763	1002
TMBOY	47:9e361da97763	1003	/*
TMBOY	47:9e361da97763	1004	ZEXTERN int ZEXPORT inflateBackInit OF((z_streamp strm, int windowBits,
TMBOY	47:9e361da97763	1005	unsigned char FAR *window));
TMBOY	47:9e361da97763	1006
TMBOY	47:9e361da97763	1007	Initialize the internal stream state for decompression using inflateBack()
TMBOY	47:9e361da97763	1008	calls. The fields zalloc, zfree and opaque in strm must be initialized
TMBOY	47:9e361da97763	1009	before the call. If zalloc and zfree are Z_NULL, then the default library-
TMBOY	47:9e361da97763	1010	derived memory allocation routines are used. windowBits is the base two
TMBOY	47:9e361da97763	1011	logarithm of the window size, in the range 8..15. window is a caller
TMBOY	47:9e361da97763	1012	supplied buffer of that size. Except for special applications where it is
TMBOY	47:9e361da97763	1013	assured that deflate was used with small window sizes, windowBits must be 15
TMBOY	47:9e361da97763	1014	and a 32K byte window must be supplied to be able to decompress general
TMBOY	47:9e361da97763	1015	deflate streams.
TMBOY	47:9e361da97763	1016
TMBOY	47:9e361da97763	1017	See inflateBack() for the usage of these routines.
TMBOY	47:9e361da97763	1018
TMBOY	47:9e361da97763	1019	inflateBackInit will return Z_OK on success, Z_STREAM_ERROR if any of
TMBOY	47:9e361da97763	1020	the parameters are invalid, Z_MEM_ERROR if the internal state could not be
TMBOY	47:9e361da97763	1021	allocated, or Z_VERSION_ERROR if the version of the library does not match
TMBOY	47:9e361da97763	1022	the version of the header file.
TMBOY	47:9e361da97763	1023	*/
TMBOY	47:9e361da97763	1024
TMBOY	47:9e361da97763	1025	typedef unsigned (in_func) OF((void FAR ,
TMBOY	47:9e361da97763	1026	z_const unsigned char FAR * FAR *));
TMBOY	47:9e361da97763	1027	typedef int (out_func) OF((void FAR , unsigned char FAR *, unsigned));
TMBOY	47:9e361da97763	1028
TMBOY	47:9e361da97763	1029	ZEXTERN int ZEXPORT inflateBack OF((z_streamp strm,
TMBOY	47:9e361da97763	1030	in_func in, void FAR *in_desc,
TMBOY	47:9e361da97763	1031	out_func out, void FAR *out_desc));
TMBOY	47:9e361da97763	1032	/*
TMBOY	47:9e361da97763	1033	inflateBack() does a raw inflate with a single call using a call-back
TMBOY	47:9e361da97763	1034	interface for input and output. This is potentially more efficient than
TMBOY	47:9e361da97763	1035	inflate() for file i/o applications, in that it avoids copying between the
TMBOY	47:9e361da97763	1036	output and the sliding window by simply making the window itself the output
TMBOY	47:9e361da97763	1037	buffer. inflate() can be faster on modern CPUs when used with large
TMBOY	47:9e361da97763	1038	buffers. inflateBack() trusts the application to not change the output
TMBOY	47:9e361da97763	1039	buffer passed by the output function, at least until inflateBack() returns.
TMBOY	47:9e361da97763	1040
TMBOY	47:9e361da97763	1041	inflateBackInit() must be called first to allocate the internal state
TMBOY	47:9e361da97763	1042	and to initialize the state with the user-provided window buffer.
TMBOY	47:9e361da97763	1043	inflateBack() may then be used multiple times to inflate a complete, raw
TMBOY	47:9e361da97763	1044	deflate stream with each call. inflateBackEnd() is then called to free the
TMBOY	47:9e361da97763	1045	allocated state.
TMBOY	47:9e361da97763	1046
TMBOY	47:9e361da97763	1047	A raw deflate stream is one with no zlib or gzip header or trailer.
TMBOY	47:9e361da97763	1048	This routine would normally be used in a utility that reads zip or gzip
TMBOY	47:9e361da97763	1049	files and writes out uncompressed files. The utility would decode the
TMBOY	47:9e361da97763	1050	header and process the trailer on its own, hence this routine expects only
TMBOY	47:9e361da97763	1051	the raw deflate stream to decompress. This is different from the normal
TMBOY	47:9e361da97763	1052	behavior of inflate(), which expects either a zlib or gzip header and
TMBOY	47:9e361da97763	1053	trailer around the deflate stream.
TMBOY	47:9e361da97763	1054
TMBOY	47:9e361da97763	1055	inflateBack() uses two subroutines supplied by the caller that are then
TMBOY	47:9e361da97763	1056	called by inflateBack() for input and output. inflateBack() calls those
TMBOY	47:9e361da97763	1057	routines until it reads a complete deflate stream and writes out all of the
TMBOY	47:9e361da97763	1058	uncompressed data, or until it encounters an error. The function's
TMBOY	47:9e361da97763	1059	parameters and return types are defined above in the in_func and out_func
TMBOY	47:9e361da97763	1060	typedefs. inflateBack() will call in(in_desc, &buf) which should return the
TMBOY	47:9e361da97763	1061	number of bytes of provided input, and a pointer to that input in buf. If
TMBOY	47:9e361da97763	1062	there is no input available, in() must return zero--buf is ignored in that
TMBOY	47:9e361da97763	1063	case--and inflateBack() will return a buffer error. inflateBack() will call
TMBOY	47:9e361da97763	1064	out(out_desc, buf, len) to write the uncompressed data buf[0..len-1]. out()
TMBOY	47:9e361da97763	1065	should return zero on success, or non-zero on failure. If out() returns
TMBOY	47:9e361da97763	1066	non-zero, inflateBack() will return with an error. Neither in() nor out()
TMBOY	47:9e361da97763	1067	are permitted to change the contents of the window provided to
TMBOY	47:9e361da97763	1068	inflateBackInit(), which is also the buffer that out() uses to write from.
TMBOY	47:9e361da97763	1069	The length written by out() will be at most the window size. Any non-zero
TMBOY	47:9e361da97763	1070	amount of input may be provided by in().
TMBOY	47:9e361da97763	1071
TMBOY	47:9e361da97763	1072	For convenience, inflateBack() can be provided input on the first call by
TMBOY	47:9e361da97763	1073	setting strm->next_in and strm->avail_in. If that input is exhausted, then
TMBOY	47:9e361da97763	1074	in() will be called. Therefore strm->next_in must be initialized before
TMBOY	47:9e361da97763	1075	calling inflateBack(). If strm->next_in is Z_NULL, then in() will be called
TMBOY	47:9e361da97763	1076	immediately for input. If strm->next_in is not Z_NULL, then strm->avail_in
TMBOY	47:9e361da97763	1077	must also be initialized, and then if strm->avail_in is not zero, input will
TMBOY	47:9e361da97763	1078	initially be taken from strm->next_in[0 .. strm->avail_in - 1].
TMBOY	47:9e361da97763	1079
TMBOY	47:9e361da97763	1080	The in_desc and out_desc parameters of inflateBack() is passed as the
TMBOY	47:9e361da97763	1081	first parameter of in() and out() respectively when they are called. These
TMBOY	47:9e361da97763	1082	descriptors can be optionally used to pass any information that the caller-
TMBOY	47:9e361da97763	1083	supplied in() and out() functions need to do their job.
TMBOY	47:9e361da97763	1084
TMBOY	47:9e361da97763	1085	On return, inflateBack() will set strm->next_in and strm->avail_in to
TMBOY	47:9e361da97763	1086	pass back any unused input that was provided by the last in() call. The
TMBOY	47:9e361da97763	1087	return values of inflateBack() can be Z_STREAM_END on success, Z_BUF_ERROR
TMBOY	47:9e361da97763	1088	if in() or out() returned an error, Z_DATA_ERROR if there was a format error
TMBOY	47:9e361da97763	1089	in the deflate stream (in which case strm->msg is set to indicate the nature
TMBOY	47:9e361da97763	1090	of the error), or Z_STREAM_ERROR if the stream was not properly initialized.
TMBOY	47:9e361da97763	1091	In the case of Z_BUF_ERROR, an input or output error can be distinguished
TMBOY	47:9e361da97763	1092	using strm->next_in which will be Z_NULL only if in() returned an error. If
TMBOY	47:9e361da97763	1093	strm->next_in is not Z_NULL, then the Z_BUF_ERROR was due to out() returning
TMBOY	47:9e361da97763	1094	non-zero. (in() will always be called before out(), so strm->next_in is
TMBOY	47:9e361da97763	1095	assured to be defined if out() returns non-zero.) Note that inflateBack()
TMBOY	47:9e361da97763	1096	cannot return Z_OK.
TMBOY	47:9e361da97763	1097	*/
TMBOY	47:9e361da97763	1098
TMBOY	47:9e361da97763	1099	ZEXTERN int ZEXPORT inflateBackEnd OF((z_streamp strm));
TMBOY	47:9e361da97763	1100	/*
TMBOY	47:9e361da97763	1101	All memory allocated by inflateBackInit() is freed.
TMBOY	47:9e361da97763	1102
TMBOY	47:9e361da97763	1103	inflateBackEnd() returns Z_OK on success, or Z_STREAM_ERROR if the stream
TMBOY	47:9e361da97763	1104	state was inconsistent.
TMBOY	47:9e361da97763	1105	*/
TMBOY	47:9e361da97763	1106
TMBOY	47:9e361da97763	1107	ZEXTERN uLong ZEXPORT zlibCompileFlags OF((void));
TMBOY	47:9e361da97763	1108	/* Return flags indicating compile-time options.
TMBOY	47:9e361da97763	1109
TMBOY	47:9e361da97763	1110	Type sizes, two bits each, 00 = 16 bits, 01 = 32, 10 = 64, 11 = other:
TMBOY	47:9e361da97763	1111	1.0: size of uInt
TMBOY	47:9e361da97763	1112	3.2: size of uLong
TMBOY	47:9e361da97763	1113	5.4: size of voidpf (pointer)
TMBOY	47:9e361da97763	1114	7.6: size of z_off_t
TMBOY	47:9e361da97763	1115
TMBOY	47:9e361da97763	1116	Compiler, assembler, and debug options:
TMBOY	47:9e361da97763	1117	8: DEBUG
TMBOY	47:9e361da97763	1118	9: ASMV or ASMINF -- use ASM code
TMBOY	47:9e361da97763	1119	10: ZLIB_WINAPI -- exported functions use the WINAPI calling convention
TMBOY	47:9e361da97763	1120	11: 0 (reserved)
TMBOY	47:9e361da97763	1121
TMBOY	47:9e361da97763	1122	One-time table building (smaller code, but not thread-safe if true):
TMBOY	47:9e361da97763	1123	12: BUILDFIXED -- build static block decoding tables when needed
TMBOY	47:9e361da97763	1124	13: DYNAMIC_CRC_TABLE -- build CRC calculation tables when needed
TMBOY	47:9e361da97763	1125	14,15: 0 (reserved)
TMBOY	47:9e361da97763	1126
TMBOY	47:9e361da97763	1127	Library content (indicates missing functionality):
TMBOY	47:9e361da97763	1128	16: NO_GZCOMPRESS -- gz* functions cannot compress (to avoid linking
TMBOY	47:9e361da97763	1129	deflate code when not needed)
TMBOY	47:9e361da97763	1130	17: NO_GZIP -- deflate can't write gzip streams, and inflate can't detect
TMBOY	47:9e361da97763	1131	and decode gzip streams (to avoid linking crc code)
TMBOY	47:9e361da97763	1132	18-19: 0 (reserved)
TMBOY	47:9e361da97763	1133
TMBOY	47:9e361da97763	1134	Operation variations (changes in library functionality):
TMBOY	47:9e361da97763	1135	20: PKZIP_BUG_WORKAROUND -- slightly more permissive inflate
TMBOY	47:9e361da97763	1136	21: FASTEST -- deflate algorithm with only one, lowest compression level
TMBOY	47:9e361da97763	1137	22,23: 0 (reserved)
TMBOY	47:9e361da97763	1138
TMBOY	47:9e361da97763	1139	The sprintf variant used by gzprintf (zero is best):
TMBOY	47:9e361da97763	1140	24: 0 = vs, 1 = s -- 1 means limited to 20 arguments after the format
TMBOY	47:9e361da97763	1141	25: 0 = nprintf, 1 = printf -- 1 means gzprintf() not secure!
TMBOY	47:9e361da97763	1142	26: 0 = returns value, 1 = void -- 1 means inferred string length returned
TMBOY	47:9e361da97763	1143
TMBOY	47:9e361da97763	1144	Remainder:
TMBOY	47:9e361da97763	1145	27-31: 0 (reserved)
TMBOY	47:9e361da97763	1146	*/
TMBOY	47:9e361da97763	1147
TMBOY	47:9e361da97763	1148	#ifndef Z_SOLO
TMBOY	47:9e361da97763	1149
TMBOY	47:9e361da97763	1150	/* utility functions */
TMBOY	47:9e361da97763	1151
TMBOY	47:9e361da97763	1152	/*
TMBOY	47:9e361da97763	1153	The following utility functions are implemented on top of the basic
TMBOY	47:9e361da97763	1154	stream-oriented functions. To simplify the interface, some default options
TMBOY	47:9e361da97763	1155	are assumed (compression level and memory usage, standard memory allocation
TMBOY	47:9e361da97763	1156	functions). The source code of these utility functions can be modified if
TMBOY	47:9e361da97763	1157	you need special options.
TMBOY	47:9e361da97763	1158	*/
TMBOY	47:9e361da97763	1159
TMBOY	47:9e361da97763	1160	ZEXTERN int ZEXPORT compress OF((Bytef dest, uLongf destLen,
TMBOY	47:9e361da97763	1161	const Bytef *source, uLong sourceLen));
TMBOY	47:9e361da97763	1162	/*
TMBOY	47:9e361da97763	1163	Compresses the source buffer into the destination buffer. sourceLen is
TMBOY	47:9e361da97763	1164	the byte length of the source buffer. Upon entry, destLen is the total size
TMBOY	47:9e361da97763	1165	of the destination buffer, which must be at least the value returned by
TMBOY	47:9e361da97763	1166	compressBound(sourceLen). Upon exit, destLen is the actual size of the
TMBOY	47:9e361da97763	1167	compressed buffer.
TMBOY	47:9e361da97763	1168
TMBOY	47:9e361da97763	1169	compress returns Z_OK if success, Z_MEM_ERROR if there was not
TMBOY	47:9e361da97763	1170	enough memory, Z_BUF_ERROR if there was not enough room in the output
TMBOY	47:9e361da97763	1171	buffer.
TMBOY	47:9e361da97763	1172	*/
TMBOY	47:9e361da97763	1173
TMBOY	47:9e361da97763	1174	ZEXTERN int ZEXPORT compress2 OF((Bytef dest, uLongf destLen,
TMBOY	47:9e361da97763	1175	const Bytef *source, uLong sourceLen,
TMBOY	47:9e361da97763	1176	int level));
TMBOY	47:9e361da97763	1177	/*
TMBOY	47:9e361da97763	1178	Compresses the source buffer into the destination buffer. The level
TMBOY	47:9e361da97763	1179	parameter has the same meaning as in deflateInit. sourceLen is the byte
TMBOY	47:9e361da97763	1180	length of the source buffer. Upon entry, destLen is the total size of the
TMBOY	47:9e361da97763	1181	destination buffer, which must be at least the value returned by
TMBOY	47:9e361da97763	1182	compressBound(sourceLen). Upon exit, destLen is the actual size of the
TMBOY	47:9e361da97763	1183	compressed buffer.
TMBOY	47:9e361da97763	1184
TMBOY	47:9e361da97763	1185	compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
TMBOY	47:9e361da97763	1186	memory, Z_BUF_ERROR if there was not enough room in the output buffer,
TMBOY	47:9e361da97763	1187	Z_STREAM_ERROR if the level parameter is invalid.
TMBOY	47:9e361da97763	1188	*/
TMBOY	47:9e361da97763	1189
TMBOY	47:9e361da97763	1190	ZEXTERN uLong ZEXPORT compressBound OF((uLong sourceLen));
TMBOY	47:9e361da97763	1191	/*
TMBOY	47:9e361da97763	1192	compressBound() returns an upper bound on the compressed size after
TMBOY	47:9e361da97763	1193	compress() or compress2() on sourceLen bytes. It would be used before a
TMBOY	47:9e361da97763	1194	compress() or compress2() call to allocate the destination buffer.
TMBOY	47:9e361da97763	1195	*/
TMBOY	47:9e361da97763	1196
TMBOY	47:9e361da97763	1197	ZEXTERN int ZEXPORT uncompress OF((Bytef dest, uLongf destLen,
TMBOY	47:9e361da97763	1198	const Bytef *source, uLong sourceLen));
TMBOY	47:9e361da97763	1199	/*
TMBOY	47:9e361da97763	1200	Decompresses the source buffer into the destination buffer. sourceLen is
TMBOY	47:9e361da97763	1201	the byte length of the source buffer. Upon entry, destLen is the total size
TMBOY	47:9e361da97763	1202	of the destination buffer, which must be large enough to hold the entire
TMBOY	47:9e361da97763	1203	uncompressed data. (The size of the uncompressed data must have been saved
TMBOY	47:9e361da97763	1204	previously by the compressor and transmitted to the decompressor by some
TMBOY	47:9e361da97763	1205	mechanism outside the scope of this compression library.) Upon exit, destLen
TMBOY	47:9e361da97763	1206	is the actual size of the uncompressed buffer.
TMBOY	47:9e361da97763	1207
TMBOY	47:9e361da97763	1208	uncompress returns Z_OK if success, Z_MEM_ERROR if there was not
TMBOY	47:9e361da97763	1209	enough memory, Z_BUF_ERROR if there was not enough room in the output
TMBOY	47:9e361da97763	1210	buffer, or Z_DATA_ERROR if the input data was corrupted or incomplete. In
TMBOY	47:9e361da97763	1211	the case where there is not enough room, uncompress() will fill the output
TMBOY	47:9e361da97763	1212	buffer with the uncompressed data up to that point.
TMBOY	47:9e361da97763	1213	*/
TMBOY	47:9e361da97763	1214
TMBOY	47:9e361da97763	1215	/* gzip file access functions */
TMBOY	47:9e361da97763	1216
TMBOY	47:9e361da97763	1217	/*
TMBOY	47:9e361da97763	1218	This library supports reading and writing files in gzip (.gz) format with
TMBOY	47:9e361da97763	1219	an interface similar to that of stdio, using the functions that start with
TMBOY	47:9e361da97763	1220	"gz". The gzip format is different from the zlib format. gzip is a gzip
TMBOY	47:9e361da97763	1221	wrapper, documented in RFC 1952, wrapped around a deflate stream.
TMBOY	47:9e361da97763	1222	*/
TMBOY	47:9e361da97763	1223
TMBOY	47:9e361da97763	1224	typedef struct gzFile_s gzFile; / semi-opaque gzip file descriptor */
TMBOY	47:9e361da97763	1225
TMBOY	47:9e361da97763	1226	/*
TMBOY	47:9e361da97763	1227	ZEXTERN gzFile ZEXPORT gzopen OF((const char path, const char mode));
TMBOY	47:9e361da97763	1228
TMBOY	47:9e361da97763	1229	Opens a gzip (.gz) file for reading or writing. The mode parameter is as
TMBOY	47:9e361da97763	1230	in fopen ("rb" or "wb") but can also include a compression level ("wb9") or
TMBOY	47:9e361da97763	1231	a strategy: 'f' for filtered data as in "wb6f", 'h' for Huffman-only
TMBOY	47:9e361da97763	1232	compression as in "wb1h", 'R' for run-length encoding as in "wb1R", or 'F'
TMBOY	47:9e361da97763	1233	for fixed code compression as in "wb9F". (See the description of
TMBOY	47:9e361da97763	1234	deflateInit2 for more information about the strategy parameter.) 'T' will
TMBOY	47:9e361da97763	1235	request transparent writing or appending with no compression and not using
TMBOY	47:9e361da97763	1236	the gzip format.
TMBOY	47:9e361da97763	1237
TMBOY	47:9e361da97763	1238	"a" can be used instead of "w" to request that the gzip stream that will
TMBOY	47:9e361da97763	1239	be written be appended to the file. "+" will result in an error, since
TMBOY	47:9e361da97763	1240	reading and writing to the same gzip file is not supported. The addition of
TMBOY	47:9e361da97763	1241	"x" when writing will create the file exclusively, which fails if the file
TMBOY	47:9e361da97763	1242	already exists. On systems that support it, the addition of "e" when
TMBOY	47:9e361da97763	1243	reading or writing will set the flag to close the file on an execve() call.
TMBOY	47:9e361da97763	1244
TMBOY	47:9e361da97763	1245	These functions, as well as gzip, will read and decode a sequence of gzip
TMBOY	47:9e361da97763	1246	streams in a file. The append function of gzopen() can be used to create
TMBOY	47:9e361da97763	1247	such a file. (Also see gzflush() for another way to do this.) When
TMBOY	47:9e361da97763	1248	appending, gzopen does not test whether the file begins with a gzip stream,
TMBOY	47:9e361da97763	1249	nor does it look for the end of the gzip streams to begin appending. gzopen
TMBOY	47:9e361da97763	1250	will simply append a gzip stream to the existing file.
TMBOY	47:9e361da97763	1251
TMBOY	47:9e361da97763	1252	gzopen can be used to read a file which is not in gzip format; in this
TMBOY	47:9e361da97763	1253	case gzread will directly read from the file without decompression. When
TMBOY	47:9e361da97763	1254	reading, this will be detected automatically by looking for the magic two-
TMBOY	47:9e361da97763	1255	byte gzip header.
TMBOY	47:9e361da97763	1256
TMBOY	47:9e361da97763	1257	gzopen returns NULL if the file could not be opened, if there was
TMBOY	47:9e361da97763	1258	insufficient memory to allocate the gzFile state, or if an invalid mode was
TMBOY	47:9e361da97763	1259	specified (an 'r', 'w', or 'a' was not provided, or '+' was provided).
TMBOY	47:9e361da97763	1260	errno can be checked to determine if the reason gzopen failed was that the
TMBOY	47:9e361da97763	1261	file could not be opened.
TMBOY	47:9e361da97763	1262	*/
TMBOY	47:9e361da97763	1263
TMBOY	47:9e361da97763	1264	ZEXTERN gzFile ZEXPORT gzdopen OF((int fd, const char *mode));
TMBOY	47:9e361da97763	1265	/*
TMBOY	47:9e361da97763	1266	gzdopen associates a gzFile with the file descriptor fd. File descriptors
TMBOY	47:9e361da97763	1267	are obtained from calls like open, dup, creat, pipe or fileno (if the file
TMBOY	47:9e361da97763	1268	has been previously opened with fopen). The mode parameter is as in gzopen.
TMBOY	47:9e361da97763	1269
TMBOY	47:9e361da97763	1270	The next call of gzclose on the returned gzFile will also close the file
TMBOY	47:9e361da97763	1271	descriptor fd, just like fclose(fdopen(fd, mode)) closes the file descriptor
TMBOY	47:9e361da97763	1272	fd. If you want to keep fd open, use fd = dup(fd_keep); gz = gzdopen(fd,
TMBOY	47:9e361da97763	1273	mode);. The duplicated descriptor should be saved to avoid a leak, since
TMBOY	47:9e361da97763	1274	gzdopen does not close fd if it fails. If you are using fileno() to get the
TMBOY	47:9e361da97763	1275	file descriptor from a FILE *, then you will have to use dup() to avoid
TMBOY	47:9e361da97763	1276	double-close()ing the file descriptor. Both gzclose() and fclose() will
TMBOY	47:9e361da97763	1277	close the associated file descriptor, so they need to have different file
TMBOY	47:9e361da97763	1278	descriptors.
TMBOY	47:9e361da97763	1279
TMBOY	47:9e361da97763	1280	gzdopen returns NULL if there was insufficient memory to allocate the
TMBOY	47:9e361da97763	1281	gzFile state, if an invalid mode was specified (an 'r', 'w', or 'a' was not
TMBOY	47:9e361da97763	1282	provided, or '+' was provided), or if fd is -1. The file descriptor is not
TMBOY	47:9e361da97763	1283	used until the next gz* read, write, seek, or close operation, so gzdopen
TMBOY	47:9e361da97763	1284	will not detect if fd is invalid (unless fd is -1).
TMBOY	47:9e361da97763	1285	*/
TMBOY	47:9e361da97763	1286
TMBOY	47:9e361da97763	1287	ZEXTERN int ZEXPORT gzbuffer OF((gzFile file, unsigned size));
TMBOY	47:9e361da97763	1288	/*
TMBOY	47:9e361da97763	1289	Set the internal buffer size used by this library's functions. The
TMBOY	47:9e361da97763	1290	default buffer size is 8192 bytes. This function must be called after
TMBOY	47:9e361da97763	1291	gzopen() or gzdopen(), and before any other calls that read or write the
TMBOY	47:9e361da97763	1292	file. The buffer memory allocation is always deferred to the first read or
TMBOY	47:9e361da97763	1293	write. Two buffers are allocated, either both of the specified size when
TMBOY	47:9e361da97763	1294	writing, or one of the specified size and the other twice that size when
TMBOY	47:9e361da97763	1295	reading. A larger buffer size of, for example, 64K or 128K bytes will
TMBOY	47:9e361da97763	1296	noticeably increase the speed of decompression (reading).
TMBOY	47:9e361da97763	1297
TMBOY	47:9e361da97763	1298	The new buffer size also affects the maximum length for gzprintf().
TMBOY	47:9e361da97763	1299
TMBOY	47:9e361da97763	1300	gzbuffer() returns 0 on success, or -1 on failure, such as being called
TMBOY	47:9e361da97763	1301	too late.
TMBOY	47:9e361da97763	1302	*/
TMBOY	47:9e361da97763	1303
TMBOY	47:9e361da97763	1304	ZEXTERN int ZEXPORT gzsetparams OF((gzFile file, int level, int strategy));
TMBOY	47:9e361da97763	1305	/*
TMBOY	47:9e361da97763	1306	Dynamically update the compression level or strategy. See the description
TMBOY	47:9e361da97763	1307	of deflateInit2 for the meaning of these parameters.
TMBOY	47:9e361da97763	1308
TMBOY	47:9e361da97763	1309	gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not
TMBOY	47:9e361da97763	1310	opened for writing.
TMBOY	47:9e361da97763	1311	*/
TMBOY	47:9e361da97763	1312
TMBOY	47:9e361da97763	1313	ZEXTERN int ZEXPORT gzread OF((gzFile file, voidp buf, unsigned len));
TMBOY	47:9e361da97763	1314	/*
TMBOY	47:9e361da97763	1315	Reads the given number of uncompressed bytes from the compressed file. If
TMBOY	47:9e361da97763	1316	the input file is not in gzip format, gzread copies the given number of
TMBOY	47:9e361da97763	1317	bytes into the buffer directly from the file.
TMBOY	47:9e361da97763	1318
TMBOY	47:9e361da97763	1319	After reaching the end of a gzip stream in the input, gzread will continue
TMBOY	47:9e361da97763	1320	to read, looking for another gzip stream. Any number of gzip streams may be
TMBOY	47:9e361da97763	1321	concatenated in the input file, and will all be decompressed by gzread().
TMBOY	47:9e361da97763	1322	If something other than a gzip stream is encountered after a gzip stream,
TMBOY	47:9e361da97763	1323	that remaining trailing garbage is ignored (and no error is returned).
TMBOY	47:9e361da97763	1324
TMBOY	47:9e361da97763	1325	gzread can be used to read a gzip file that is being concurrently written.
TMBOY	47:9e361da97763	1326	Upon reaching the end of the input, gzread will return with the available
TMBOY	47:9e361da97763	1327	data. If the error code returned by gzerror is Z_OK or Z_BUF_ERROR, then
TMBOY	47:9e361da97763	1328	gzclearerr can be used to clear the end of file indicator in order to permit
TMBOY	47:9e361da97763	1329	gzread to be tried again. Z_OK indicates that a gzip stream was completed
TMBOY	47:9e361da97763	1330	on the last gzread. Z_BUF_ERROR indicates that the input file ended in the
TMBOY	47:9e361da97763	1331	middle of a gzip stream. Note that gzread does not return -1 in the event
TMBOY	47:9e361da97763	1332	of an incomplete gzip stream. This error is deferred until gzclose(), which
TMBOY	47:9e361da97763	1333	will return Z_BUF_ERROR if the last gzread ended in the middle of a gzip
TMBOY	47:9e361da97763	1334	stream. Alternatively, gzerror can be used before gzclose to detect this
TMBOY	47:9e361da97763	1335	case.
TMBOY	47:9e361da97763	1336
TMBOY	47:9e361da97763	1337	gzread returns the number of uncompressed bytes actually read, less than
TMBOY	47:9e361da97763	1338	len for end of file, or -1 for error.
TMBOY	47:9e361da97763	1339	*/
TMBOY	47:9e361da97763	1340
TMBOY	47:9e361da97763	1341	ZEXTERN int ZEXPORT gzwrite OF((gzFile file,
TMBOY	47:9e361da97763	1342	voidpc buf, unsigned len));
TMBOY	47:9e361da97763	1343	/*
TMBOY	47:9e361da97763	1344	Writes the given number of uncompressed bytes into the compressed file.
TMBOY	47:9e361da97763	1345	gzwrite returns the number of uncompressed bytes written or 0 in case of
TMBOY	47:9e361da97763	1346	error.
TMBOY	47:9e361da97763	1347	*/
TMBOY	47:9e361da97763	1348
TMBOY	47:9e361da97763	1349	ZEXTERN int ZEXPORTVA gzprintf Z_ARG((gzFile file, const char *format, ...));
TMBOY	47:9e361da97763	1350	/*
TMBOY	47:9e361da97763	1351	Converts, formats, and writes the arguments to the compressed file under
TMBOY	47:9e361da97763	1352	control of the format string, as in fprintf. gzprintf returns the number of
TMBOY	47:9e361da97763	1353	uncompressed bytes actually written, or 0 in case of error. The number of
TMBOY	47:9e361da97763	1354	uncompressed bytes written is limited to 8191, or one less than the buffer
TMBOY	47:9e361da97763	1355	size given to gzbuffer(). The caller should assure that this limit is not
TMBOY	47:9e361da97763	1356	exceeded. If it is exceeded, then gzprintf() will return an error (0) with
TMBOY	47:9e361da97763	1357	nothing written. In this case, there may also be a buffer overflow with
TMBOY	47:9e361da97763	1358	unpredictable consequences, which is possible only if zlib was compiled with
TMBOY	47:9e361da97763	1359	the insecure functions sprintf() or vsprintf() because the secure snprintf()
TMBOY	47:9e361da97763	1360	or vsnprintf() functions were not available. This can be determined using
TMBOY	47:9e361da97763	1361	zlibCompileFlags().
TMBOY	47:9e361da97763	1362	*/
TMBOY	47:9e361da97763	1363
TMBOY	47:9e361da97763	1364	ZEXTERN int ZEXPORT gzputs OF((gzFile file, const char *s));
TMBOY	47:9e361da97763	1365	/*
TMBOY	47:9e361da97763	1366	Writes the given null-terminated string to the compressed file, excluding
TMBOY	47:9e361da97763	1367	the terminating null character.
TMBOY	47:9e361da97763	1368
TMBOY	47:9e361da97763	1369	gzputs returns the number of characters written, or -1 in case of error.
TMBOY	47:9e361da97763	1370	*/
TMBOY	47:9e361da97763	1371
TMBOY	47:9e361da97763	1372	ZEXTERN char * ZEXPORT gzgets OF((gzFile file, char *buf, int len));
TMBOY	47:9e361da97763	1373	/*
TMBOY	47:9e361da97763	1374	Reads bytes from the compressed file until len-1 characters are read, or a
TMBOY	47:9e361da97763	1375	newline character is read and transferred to buf, or an end-of-file
TMBOY	47:9e361da97763	1376	condition is encountered. If any characters are read or if len == 1, the
TMBOY	47:9e361da97763	1377	string is terminated with a null character. If no characters are read due
TMBOY	47:9e361da97763	1378	to an end-of-file or len < 1, then the buffer is left untouched.
TMBOY	47:9e361da97763	1379
TMBOY	47:9e361da97763	1380	gzgets returns buf which is a null-terminated string, or it returns NULL
TMBOY	47:9e361da97763	1381	for end-of-file or in case of error. If there was an error, the contents at
TMBOY	47:9e361da97763	1382	buf are indeterminate.
TMBOY	47:9e361da97763	1383	*/
TMBOY	47:9e361da97763	1384
TMBOY	47:9e361da97763	1385	ZEXTERN int ZEXPORT gzputc OF((gzFile file, int c));
TMBOY	47:9e361da97763	1386	/*
TMBOY	47:9e361da97763	1387	Writes c, converted to an unsigned char, into the compressed file. gzputc
TMBOY	47:9e361da97763	1388	returns the value that was written, or -1 in case of error.
TMBOY	47:9e361da97763	1389	*/
TMBOY	47:9e361da97763	1390
TMBOY	47:9e361da97763	1391	ZEXTERN int ZEXPORT gzgetc OF((gzFile file));
TMBOY	47:9e361da97763	1392	/*
TMBOY	47:9e361da97763	1393	Reads one byte from the compressed file. gzgetc returns this byte or -1
TMBOY	47:9e361da97763	1394	in case of end of file or error. This is implemented as a macro for speed.
TMBOY	47:9e361da97763	1395	As such, it does not do all of the checking the other functions do. I.e.
TMBOY	47:9e361da97763	1396	it does not check to see if file is NULL, nor whether the structure file
TMBOY	47:9e361da97763	1397	points to has been clobbered or not.
TMBOY	47:9e361da97763	1398	*/
TMBOY	47:9e361da97763	1399
TMBOY	47:9e361da97763	1400	ZEXTERN int ZEXPORT gzungetc OF((int c, gzFile file));
TMBOY	47:9e361da97763	1401	/*
TMBOY	47:9e361da97763	1402	Push one character back onto the stream to be read as the first character
TMBOY	47:9e361da97763	1403	on the next read. At least one character of push-back is allowed.
TMBOY	47:9e361da97763	1404	gzungetc() returns the character pushed, or -1 on failure. gzungetc() will
TMBOY	47:9e361da97763	1405	fail if c is -1, and may fail if a character has been pushed but not read
TMBOY	47:9e361da97763	1406	yet. If gzungetc is used immediately after gzopen or gzdopen, at least the
TMBOY	47:9e361da97763	1407	output buffer size of pushed characters is allowed. (See gzbuffer above.)
TMBOY	47:9e361da97763	1408	The pushed character will be discarded if the stream is repositioned with
TMBOY	47:9e361da97763	1409	gzseek() or gzrewind().
TMBOY	47:9e361da97763	1410	*/
TMBOY	47:9e361da97763	1411
TMBOY	47:9e361da97763	1412	ZEXTERN int ZEXPORT gzflush OF((gzFile file, int flush));
TMBOY	47:9e361da97763	1413	/*
TMBOY	47:9e361da97763	1414	Flushes all pending output into the compressed file. The parameter flush
TMBOY	47:9e361da97763	1415	is as in the deflate() function. The return value is the zlib error number
TMBOY	47:9e361da97763	1416	(see function gzerror below). gzflush is only permitted when writing.
TMBOY	47:9e361da97763	1417
TMBOY	47:9e361da97763	1418	If the flush parameter is Z_FINISH, the remaining data is written and the
TMBOY	47:9e361da97763	1419	gzip stream is completed in the output. If gzwrite() is called again, a new
TMBOY	47:9e361da97763	1420	gzip stream will be started in the output. gzread() is able to read such
TMBOY	47:9e361da97763	1421	concatented gzip streams.
TMBOY	47:9e361da97763	1422
TMBOY	47:9e361da97763	1423	gzflush should be called only when strictly necessary because it will
TMBOY	47:9e361da97763	1424	degrade compression if called too often.
TMBOY	47:9e361da97763	1425	*/
TMBOY	47:9e361da97763	1426
TMBOY	47:9e361da97763	1427	/*
TMBOY	47:9e361da97763	1428	ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile file,
TMBOY	47:9e361da97763	1429	z_off_t offset, int whence));
TMBOY	47:9e361da97763	1430
TMBOY	47:9e361da97763	1431	Sets the starting position for the next gzread or gzwrite on the given
TMBOY	47:9e361da97763	1432	compressed file. The offset represents a number of bytes in the
TMBOY	47:9e361da97763	1433	uncompressed data stream. The whence parameter is defined as in lseek(2);
TMBOY	47:9e361da97763	1434	the value SEEK_END is not supported.
TMBOY	47:9e361da97763	1435
TMBOY	47:9e361da97763	1436	If the file is opened for reading, this function is emulated but can be
TMBOY	47:9e361da97763	1437	extremely slow. If the file is opened for writing, only forward seeks are
TMBOY	47:9e361da97763	1438	supported; gzseek then compresses a sequence of zeroes up to the new
TMBOY	47:9e361da97763	1439	starting position.
TMBOY	47:9e361da97763	1440
TMBOY	47:9e361da97763	1441	gzseek returns the resulting offset location as measured in bytes from
TMBOY	47:9e361da97763	1442	the beginning of the uncompressed stream, or -1 in case of error, in
TMBOY	47:9e361da97763	1443	particular if the file is opened for writing and the new starting position
TMBOY	47:9e361da97763	1444	would be before the current position.
TMBOY	47:9e361da97763	1445	*/
TMBOY	47:9e361da97763	1446
TMBOY	47:9e361da97763	1447	ZEXTERN int ZEXPORT gzrewind OF((gzFile file));
TMBOY	47:9e361da97763	1448	/*
TMBOY	47:9e361da97763	1449	Rewinds the given file. This function is supported only for reading.
TMBOY	47:9e361da97763	1450
TMBOY	47:9e361da97763	1451	gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET)
TMBOY	47:9e361da97763	1452	*/
TMBOY	47:9e361da97763	1453
TMBOY	47:9e361da97763	1454	/*
TMBOY	47:9e361da97763	1455	ZEXTERN z_off_t ZEXPORT gztell OF((gzFile file));
TMBOY	47:9e361da97763	1456
TMBOY	47:9e361da97763	1457	Returns the starting position for the next gzread or gzwrite on the given
TMBOY	47:9e361da97763	1458	compressed file. This position represents a number of bytes in the
TMBOY	47:9e361da97763	1459	uncompressed data stream, and is zero when starting, even if appending or
TMBOY	47:9e361da97763	1460	reading a gzip stream from the middle of a file using gzdopen().
TMBOY	47:9e361da97763	1461
TMBOY	47:9e361da97763	1462	gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR)
TMBOY	47:9e361da97763	1463	*/
TMBOY	47:9e361da97763	1464
TMBOY	47:9e361da97763	1465	/*
TMBOY	47:9e361da97763	1466	ZEXTERN z_off_t ZEXPORT gzoffset OF((gzFile file));
TMBOY	47:9e361da97763	1467
TMBOY	47:9e361da97763	1468	Returns the current offset in the file being read or written. This offset
TMBOY	47:9e361da97763	1469	includes the count of bytes that precede the gzip stream, for example when
TMBOY	47:9e361da97763	1470	appending or when using gzdopen() for reading. When reading, the offset
TMBOY	47:9e361da97763	1471	does not include as yet unused buffered input. This information can be used
TMBOY	47:9e361da97763	1472	for a progress indicator. On error, gzoffset() returns -1.
TMBOY	47:9e361da97763	1473	*/
TMBOY	47:9e361da97763	1474
TMBOY	47:9e361da97763	1475	ZEXTERN int ZEXPORT gzeof OF((gzFile file));
TMBOY	47:9e361da97763	1476	/*
TMBOY	47:9e361da97763	1477	Returns true (1) if the end-of-file indicator has been set while reading,
TMBOY	47:9e361da97763	1478	false (0) otherwise. Note that the end-of-file indicator is set only if the
TMBOY	47:9e361da97763	1479	read tried to go past the end of the input, but came up short. Therefore,
TMBOY	47:9e361da97763	1480	just like feof(), gzeof() may return false even if there is no more data to
TMBOY	47:9e361da97763	1481	read, in the event that the last read request was for the exact number of
TMBOY	47:9e361da97763	1482	bytes remaining in the input file. This will happen if the input file size
TMBOY	47:9e361da97763	1483	is an exact multiple of the buffer size.
TMBOY	47:9e361da97763	1484
TMBOY	47:9e361da97763	1485	If gzeof() returns true, then the read functions will return no more data,
TMBOY	47:9e361da97763	1486	unless the end-of-file indicator is reset by gzclearerr() and the input file
TMBOY	47:9e361da97763	1487	has grown since the previous end of file was detected.
TMBOY	47:9e361da97763	1488	*/
TMBOY	47:9e361da97763	1489
TMBOY	47:9e361da97763	1490	ZEXTERN int ZEXPORT gzdirect OF((gzFile file));
TMBOY	47:9e361da97763	1491	/*
TMBOY	47:9e361da97763	1492	Returns true (1) if file is being copied directly while reading, or false
TMBOY	47:9e361da97763	1493	(0) if file is a gzip stream being decompressed.
TMBOY	47:9e361da97763	1494
TMBOY	47:9e361da97763	1495	If the input file is empty, gzdirect() will return true, since the input
TMBOY	47:9e361da97763	1496	does not contain a gzip stream.
TMBOY	47:9e361da97763	1497
TMBOY	47:9e361da97763	1498	If gzdirect() is used immediately after gzopen() or gzdopen() it will
TMBOY	47:9e361da97763	1499	cause buffers to be allocated to allow reading the file to determine if it
TMBOY	47:9e361da97763	1500	is a gzip file. Therefore if gzbuffer() is used, it should be called before
TMBOY	47:9e361da97763	1501	gzdirect().
TMBOY	47:9e361da97763	1502
TMBOY	47:9e361da97763	1503	When writing, gzdirect() returns true (1) if transparent writing was
TMBOY	47:9e361da97763	1504	requested ("wT" for the gzopen() mode), or false (0) otherwise. (Note:
TMBOY	47:9e361da97763	1505	gzdirect() is not needed when writing. Transparent writing must be
TMBOY	47:9e361da97763	1506	explicitly requested, so the application already knows the answer. When
TMBOY	47:9e361da97763	1507	linking statically, using gzdirect() will include all of the zlib code for
TMBOY	47:9e361da97763	1508	gzip file reading and decompression, which may not be desired.)
TMBOY	47:9e361da97763	1509	*/
TMBOY	47:9e361da97763	1510
TMBOY	47:9e361da97763	1511	ZEXTERN int ZEXPORT gzclose OF((gzFile file));
TMBOY	47:9e361da97763	1512	/*
TMBOY	47:9e361da97763	1513	Flushes all pending output if necessary, closes the compressed file and
TMBOY	47:9e361da97763	1514	deallocates the (de)compression state. Note that once file is closed, you
TMBOY	47:9e361da97763	1515	cannot call gzerror with file, since its structures have been deallocated.
TMBOY	47:9e361da97763	1516	gzclose must not be called more than once on the same file, just as free
TMBOY	47:9e361da97763	1517	must not be called more than once on the same allocation.
TMBOY	47:9e361da97763	1518
TMBOY	47:9e361da97763	1519	gzclose will return Z_STREAM_ERROR if file is not valid, Z_ERRNO on a
TMBOY	47:9e361da97763	1520	file operation error, Z_MEM_ERROR if out of memory, Z_BUF_ERROR if the
TMBOY	47:9e361da97763	1521	last read ended in the middle of a gzip stream, or Z_OK on success.
TMBOY	47:9e361da97763	1522	*/
TMBOY	47:9e361da97763	1523
TMBOY	47:9e361da97763	1524	ZEXTERN int ZEXPORT gzclose_r OF((gzFile file));
TMBOY	47:9e361da97763	1525	ZEXTERN int ZEXPORT gzclose_w OF((gzFile file));
TMBOY	47:9e361da97763	1526	/*
TMBOY	47:9e361da97763	1527	Same as gzclose(), but gzclose_r() is only for use when reading, and
TMBOY	47:9e361da97763	1528	gzclose_w() is only for use when writing or appending. The advantage to
TMBOY	47:9e361da97763	1529	using these instead of gzclose() is that they avoid linking in zlib
TMBOY	47:9e361da97763	1530	compression or decompression code that is not used when only reading or only
TMBOY	47:9e361da97763	1531	writing respectively. If gzclose() is used, then both compression and
TMBOY	47:9e361da97763	1532	decompression code will be included the application when linking to a static
TMBOY	47:9e361da97763	1533	zlib library.
TMBOY	47:9e361da97763	1534	*/
TMBOY	47:9e361da97763	1535
TMBOY	47:9e361da97763	1536	ZEXTERN const char * ZEXPORT gzerror OF((gzFile file, int *errnum));
TMBOY	47:9e361da97763	1537	/*
TMBOY	47:9e361da97763	1538	Returns the error message for the last error which occurred on the given
TMBOY	47:9e361da97763	1539	compressed file. errnum is set to zlib error number. If an error occurred
TMBOY	47:9e361da97763	1540	in the file system and not in the compression library, errnum is set to
TMBOY	47:9e361da97763	1541	Z_ERRNO and the application may consult errno to get the exact error code.
TMBOY	47:9e361da97763	1542
TMBOY	47:9e361da97763	1543	The application must not modify the returned string. Future calls to
TMBOY	47:9e361da97763	1544	this function may invalidate the previously returned string. If file is
TMBOY	47:9e361da97763	1545	closed, then the string previously returned by gzerror will no longer be
TMBOY	47:9e361da97763	1546	available.
TMBOY	47:9e361da97763	1547
TMBOY	47:9e361da97763	1548	gzerror() should be used to distinguish errors from end-of-file for those
TMBOY	47:9e361da97763	1549	functions above that do not distinguish those cases in their return values.
TMBOY	47:9e361da97763	1550	*/
TMBOY	47:9e361da97763	1551
TMBOY	47:9e361da97763	1552	ZEXTERN void ZEXPORT gzclearerr OF((gzFile file));
TMBOY	47:9e361da97763	1553	/*
TMBOY	47:9e361da97763	1554	Clears the error and end-of-file flags for file. This is analogous to the
TMBOY	47:9e361da97763	1555	clearerr() function in stdio. This is useful for continuing to read a gzip
TMBOY	47:9e361da97763	1556	file that is being written concurrently.
TMBOY	47:9e361da97763	1557	*/
TMBOY	47:9e361da97763	1558
TMBOY	47:9e361da97763	1559	#endif /* !Z_SOLO */
TMBOY	47:9e361da97763	1560
TMBOY	47:9e361da97763	1561	/* checksum functions */
TMBOY	47:9e361da97763	1562
TMBOY	47:9e361da97763	1563	/*
TMBOY	47:9e361da97763	1564	These functions are not related to compression but are exported
TMBOY	47:9e361da97763	1565	anyway because they might be useful in applications using the compression
TMBOY	47:9e361da97763	1566	library.
TMBOY	47:9e361da97763	1567	*/
TMBOY	47:9e361da97763	1568
TMBOY	47:9e361da97763	1569	ZEXTERN uLong ZEXPORT adler32 OF((uLong adler, const Bytef *buf, uInt len));
TMBOY	47:9e361da97763	1570	/*
TMBOY	47:9e361da97763	1571	Update a running Adler-32 checksum with the bytes buf[0..len-1] and
TMBOY	47:9e361da97763	1572	return the updated checksum. If buf is Z_NULL, this function returns the
TMBOY	47:9e361da97763	1573	required initial value for the checksum.
TMBOY	47:9e361da97763	1574
TMBOY	47:9e361da97763	1575	An Adler-32 checksum is almost as reliable as a CRC32 but can be computed
TMBOY	47:9e361da97763	1576	much faster.
TMBOY	47:9e361da97763	1577
TMBOY	47:9e361da97763	1578	Usage example:
TMBOY	47:9e361da97763	1579
TMBOY	47:9e361da97763	1580	uLong adler = adler32(0L, Z_NULL, 0);
TMBOY	47:9e361da97763	1581
TMBOY	47:9e361da97763	1582	while (read_buffer(buffer, length) != EOF) {
TMBOY	47:9e361da97763	1583	adler = adler32(adler, buffer, length);
TMBOY	47:9e361da97763	1584	}
TMBOY	47:9e361da97763	1585	if (adler != original_adler) error();
TMBOY	47:9e361da97763	1586	*/
TMBOY	47:9e361da97763	1587
TMBOY	47:9e361da97763	1588	/*
TMBOY	47:9e361da97763	1589	ZEXTERN uLong ZEXPORT adler32_combine OF((uLong adler1, uLong adler2,
TMBOY	47:9e361da97763	1590	z_off_t len2));
TMBOY	47:9e361da97763	1591
TMBOY	47:9e361da97763	1592	Combine two Adler-32 checksums into one. For two sequences of bytes, seq1
TMBOY	47:9e361da97763	1593	and seq2 with lengths len1 and len2, Adler-32 checksums were calculated for
TMBOY	47:9e361da97763	1594	each, adler1 and adler2. adler32_combine() returns the Adler-32 checksum of
TMBOY	47:9e361da97763	1595	seq1 and seq2 concatenated, requiring only adler1, adler2, and len2. Note
TMBOY	47:9e361da97763	1596	that the z_off_t type (like off_t) is a signed integer. If len2 is
TMBOY	47:9e361da97763	1597	negative, the result has no meaning or utility.
TMBOY	47:9e361da97763	1598	*/
TMBOY	47:9e361da97763	1599
TMBOY	47:9e361da97763	1600	ZEXTERN uLong ZEXPORT crc32 OF((uLong crc, const Bytef *buf, uInt len));
TMBOY	47:9e361da97763	1601	/*
TMBOY	47:9e361da97763	1602	Update a running CRC-32 with the bytes buf[0..len-1] and return the
TMBOY	47:9e361da97763	1603	updated CRC-32. If buf is Z_NULL, this function returns the required
TMBOY	47:9e361da97763	1604	initial value for the crc. Pre- and post-conditioning (one's complement) is
TMBOY	47:9e361da97763	1605	performed within this function so it shouldn't be done by the application.
TMBOY	47:9e361da97763	1606
TMBOY	47:9e361da97763	1607	Usage example:
TMBOY	47:9e361da97763	1608
TMBOY	47:9e361da97763	1609	uLong crc = crc32(0L, Z_NULL, 0);
TMBOY	47:9e361da97763	1610
TMBOY	47:9e361da97763	1611	while (read_buffer(buffer, length) != EOF) {
TMBOY	47:9e361da97763	1612	crc = crc32(crc, buffer, length);
TMBOY	47:9e361da97763	1613	}
TMBOY	47:9e361da97763	1614	if (crc != original_crc) error();
TMBOY	47:9e361da97763	1615	*/
TMBOY	47:9e361da97763	1616
TMBOY	47:9e361da97763	1617	/*
TMBOY	47:9e361da97763	1618	ZEXTERN uLong ZEXPORT crc32_combine OF((uLong crc1, uLong crc2, z_off_t len2));
TMBOY	47:9e361da97763	1619
TMBOY	47:9e361da97763	1620	Combine two CRC-32 check values into one. For two sequences of bytes,
TMBOY	47:9e361da97763	1621	seq1 and seq2 with lengths len1 and len2, CRC-32 check values were
TMBOY	47:9e361da97763	1622	calculated for each, crc1 and crc2. crc32_combine() returns the CRC-32
TMBOY	47:9e361da97763	1623	check value of seq1 and seq2 concatenated, requiring only crc1, crc2, and
TMBOY	47:9e361da97763	1624	len2.
TMBOY	47:9e361da97763	1625	*/
TMBOY	47:9e361da97763	1626
TMBOY	47:9e361da97763	1627
TMBOY	47:9e361da97763	1628	/* various hacks, don't look :) */
TMBOY	47:9e361da97763	1629
TMBOY	47:9e361da97763	1630	/* deflateInit and inflateInit are macros to allow checking the zlib version
TMBOY	47:9e361da97763	1631	* and the compiler's view of z_stream:
TMBOY	47:9e361da97763	1632	*/
TMBOY	47:9e361da97763	1633	ZEXTERN int ZEXPORT deflateInit_ OF((z_streamp strm, int level,
TMBOY	47:9e361da97763	1634	const char *version, int stream_size));
TMBOY	47:9e361da97763	1635	ZEXTERN int ZEXPORT inflateInit_ OF((z_streamp strm,
TMBOY	47:9e361da97763	1636	const char *version, int stream_size));
TMBOY	47:9e361da97763	1637	ZEXTERN int ZEXPORT deflateInit2_ OF((z_streamp strm, int level, int method,
TMBOY	47:9e361da97763	1638	int windowBits, int memLevel,
TMBOY	47:9e361da97763	1639	int strategy, const char *version,
TMBOY	47:9e361da97763	1640	int stream_size));
TMBOY	47:9e361da97763	1641	ZEXTERN int ZEXPORT inflateInit2_ OF((z_streamp strm, int windowBits,
TMBOY	47:9e361da97763	1642	const char *version, int stream_size));
TMBOY	47:9e361da97763	1643	ZEXTERN int ZEXPORT inflateBackInit_ OF((z_streamp strm, int windowBits,
TMBOY	47:9e361da97763	1644	unsigned char FAR *window,
TMBOY	47:9e361da97763	1645	const char *version,
TMBOY	47:9e361da97763	1646	int stream_size));
TMBOY	47:9e361da97763	1647	#define deflateInit(strm, level) \
TMBOY	47:9e361da97763	1648	deflateInit_((strm), (level), ZLIB_VERSION, (int)sizeof(z_stream))
TMBOY	47:9e361da97763	1649	#define inflateInit(strm) \
TMBOY	47:9e361da97763	1650	inflateInit_((strm), ZLIB_VERSION, (int)sizeof(z_stream))
TMBOY	47:9e361da97763	1651	#define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \
TMBOY	47:9e361da97763	1652	deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\
TMBOY	47:9e361da97763	1653	(strategy), ZLIB_VERSION, (int)sizeof(z_stream))
TMBOY	47:9e361da97763	1654	#define inflateInit2(strm, windowBits) \
TMBOY	47:9e361da97763	1655	inflateInit2_((strm), (windowBits), ZLIB_VERSION, \
TMBOY	47:9e361da97763	1656	(int)sizeof(z_stream))
TMBOY	47:9e361da97763	1657	#define inflateBackInit(strm, windowBits, window) \
TMBOY	47:9e361da97763	1658	inflateBackInit_((strm), (windowBits), (window), \
TMBOY	47:9e361da97763	1659	ZLIB_VERSION, (int)sizeof(z_stream))
TMBOY	47:9e361da97763	1660
TMBOY	47:9e361da97763	1661	#ifndef Z_SOLO
TMBOY	47:9e361da97763	1662
TMBOY	47:9e361da97763	1663	/* gzgetc() macro and its supporting function and exposed data structure. Note
TMBOY	47:9e361da97763	1664	* that the real internal state is much larger than the exposed structure.
TMBOY	47:9e361da97763	1665	* This abbreviated structure exposes just enough for the gzgetc() macro. The
TMBOY	47:9e361da97763	1666	* user should not mess with these exposed elements, since their names or
TMBOY	47:9e361da97763	1667	* behavior could change in the future, perhaps even capriciously. They can
TMBOY	47:9e361da97763	1668	* only be used by the gzgetc() macro. You have been warned.
TMBOY	47:9e361da97763	1669	*/
TMBOY	47:9e361da97763	1670	struct gzFile_s {
TMBOY	47:9e361da97763	1671	unsigned have;
TMBOY	47:9e361da97763	1672	unsigned char *next;
TMBOY	47:9e361da97763	1673	z_off64_t pos;
TMBOY	47:9e361da97763	1674	};
TMBOY	47:9e361da97763	1675	ZEXTERN int ZEXPORT gzgetc_ OF((gzFile file)); /* backward compatibility */
TMBOY	47:9e361da97763	1676	#ifdef Z_PREFIX_SET
TMBOY	47:9e361da97763	1677	# undef z_gzgetc
TMBOY	47:9e361da97763	1678	# define z_gzgetc(g) \
TMBOY	47:9e361da97763	1679	((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g))
TMBOY	47:9e361da97763	1680	#else
TMBOY	47:9e361da97763	1681	# define gzgetc(g) \
TMBOY	47:9e361da97763	1682	((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g))
TMBOY	47:9e361da97763	1683	#endif
TMBOY	47:9e361da97763	1684
TMBOY	47:9e361da97763	1685	/* provide 64-bit offset functions if _LARGEFILE64_SOURCE defined, and/or
TMBOY	47:9e361da97763	1686	* change the regular functions to 64 bits if _FILE_OFFSET_BITS is 64 (if
TMBOY	47:9e361da97763	1687	* both are true, the application gets the *64 functions, and the regular
TMBOY	47:9e361da97763	1688	* functions are changed to 64 bits) -- in case these are set on systems
TMBOY	47:9e361da97763	1689	* without large file support, _LFS64_LARGEFILE must also be true
TMBOY	47:9e361da97763	1690	*/
TMBOY	47:9e361da97763	1691	#ifdef Z_LARGE64
TMBOY	47:9e361da97763	1692	ZEXTERN gzFile ZEXPORT gzopen64 OF((const char , const char ));
TMBOY	47:9e361da97763	1693	ZEXTERN z_off64_t ZEXPORT gzseek64 OF((gzFile, z_off64_t, int));
TMBOY	47:9e361da97763	1694	ZEXTERN z_off64_t ZEXPORT gztell64 OF((gzFile));
TMBOY	47:9e361da97763	1695	ZEXTERN z_off64_t ZEXPORT gzoffset64 OF((gzFile));
TMBOY	47:9e361da97763	1696	ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, z_off64_t));
TMBOY	47:9e361da97763	1697	ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, z_off64_t));
TMBOY	47:9e361da97763	1698	#endif
TMBOY	47:9e361da97763	1699
TMBOY	47:9e361da97763	1700	#if !defined(ZLIB_INTERNAL) && defined(Z_WANT64)
TMBOY	47:9e361da97763	1701	# ifdef Z_PREFIX_SET
TMBOY	47:9e361da97763	1702	# define z_gzopen z_gzopen64
TMBOY	47:9e361da97763	1703	# define z_gzseek z_gzseek64
TMBOY	47:9e361da97763	1704	# define z_gztell z_gztell64
TMBOY	47:9e361da97763	1705	# define z_gzoffset z_gzoffset64
TMBOY	47:9e361da97763	1706	# define z_adler32_combine z_adler32_combine64
TMBOY	47:9e361da97763	1707	# define z_crc32_combine z_crc32_combine64
TMBOY	47:9e361da97763	1708	# else
TMBOY	47:9e361da97763	1709	# define gzopen gzopen64
TMBOY	47:9e361da97763	1710	# define gzseek gzseek64
TMBOY	47:9e361da97763	1711	# define gztell gztell64
TMBOY	47:9e361da97763	1712	# define gzoffset gzoffset64
TMBOY	47:9e361da97763	1713	# define adler32_combine adler32_combine64
TMBOY	47:9e361da97763	1714	# define crc32_combine crc32_combine64
TMBOY	47:9e361da97763	1715	# endif
TMBOY	47:9e361da97763	1716	# ifndef Z_LARGE64
TMBOY	47:9e361da97763	1717	ZEXTERN gzFile ZEXPORT gzopen64 OF((const char , const char ));
TMBOY	47:9e361da97763	1718	ZEXTERN z_off_t ZEXPORT gzseek64 OF((gzFile, z_off_t, int));
TMBOY	47:9e361da97763	1719	ZEXTERN z_off_t ZEXPORT gztell64 OF((gzFile));
TMBOY	47:9e361da97763	1720	ZEXTERN z_off_t ZEXPORT gzoffset64 OF((gzFile));
TMBOY	47:9e361da97763	1721	ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, z_off_t));
TMBOY	47:9e361da97763	1722	ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, z_off_t));
TMBOY	47:9e361da97763	1723	# endif
TMBOY	47:9e361da97763	1724	#else
TMBOY	47:9e361da97763	1725	ZEXTERN gzFile ZEXPORT gzopen OF((const char , const char ));
TMBOY	47:9e361da97763	1726	ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile, z_off_t, int));
TMBOY	47:9e361da97763	1727	ZEXTERN z_off_t ZEXPORT gztell OF((gzFile));
TMBOY	47:9e361da97763	1728	ZEXTERN z_off_t ZEXPORT gzoffset OF((gzFile));
TMBOY	47:9e361da97763	1729	ZEXTERN uLong ZEXPORT adler32_combine OF((uLong, uLong, z_off_t));
TMBOY	47:9e361da97763	1730	ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t));
TMBOY	47:9e361da97763	1731	#endif
TMBOY	47:9e361da97763	1732
TMBOY	47:9e361da97763	1733	#else /* Z_SOLO */
TMBOY	47:9e361da97763	1734
TMBOY	47:9e361da97763	1735	ZEXTERN uLong ZEXPORT adler32_combine OF((uLong, uLong, z_off_t));
TMBOY	47:9e361da97763	1736	ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t));
TMBOY	47:9e361da97763	1737
TMBOY	47:9e361da97763	1738	#endif /* !Z_SOLO */
TMBOY	47:9e361da97763	1739
TMBOY	47:9e361da97763	1740	/* hack for buggy compilers */
TMBOY	47:9e361da97763	1741	#if !defined(ZUTIL_H) && !defined(NO_DUMMY_DECL)
TMBOY	47:9e361da97763	1742	struct internal_state {int dummy;};
TMBOY	47:9e361da97763	1743	#endif
TMBOY	47:9e361da97763	1744
TMBOY	47:9e361da97763	1745	/* undocumented functions */
TMBOY	47:9e361da97763	1746	ZEXTERN const char * ZEXPORT zError OF((int));
TMBOY	47:9e361da97763	1747	ZEXTERN int ZEXPORT inflateSyncPoint OF((z_streamp));
TMBOY	47:9e361da97763	1748	ZEXTERN const z_crc_t FAR * ZEXPORT get_crc_table OF((void));
TMBOY	47:9e361da97763	1749	ZEXTERN int ZEXPORT inflateUndermine OF((z_streamp, int));
TMBOY	47:9e361da97763	1750	ZEXTERN int ZEXPORT inflateResetKeep OF((z_streamp));
TMBOY	47:9e361da97763	1751	ZEXTERN int ZEXPORT deflateResetKeep OF((z_streamp));
TMBOY	47:9e361da97763	1752	#if defined(_WIN32) && !defined(Z_SOLO)
TMBOY	47:9e361da97763	1753	ZEXTERN gzFile ZEXPORT gzopen_w OF((const wchar_t *path,
TMBOY	47:9e361da97763	1754	const char *mode));
TMBOY	47:9e361da97763	1755	#endif
TMBOY	47:9e361da97763	1756	#if defined(STDC) \|\| defined(Z_HAVE_STDARG_H)
TMBOY	47:9e361da97763	1757	# ifndef Z_SOLO
TMBOY	47:9e361da97763	1758	ZEXTERN int ZEXPORTVA gzvprintf Z_ARG((gzFile file,
TMBOY	47:9e361da97763	1759	const char *format,
TMBOY	47:9e361da97763	1760	va_list va));
TMBOY	47:9e361da97763	1761	# endif
TMBOY	47:9e361da97763	1762	#endif
TMBOY	47:9e361da97763	1763
TMBOY	47:9e361da97763	1764	#ifdef __cplusplus
TMBOY	47:9e361da97763	1765	}
TMBOY	47:9e361da97763	1766	#endif
TMBOY	47:9e361da97763	1767
TMBOY	47:9e361da97763	1768	#endif /* ZLIB_H */

Repository toolbox

Export to desktop IDE

Build repository

Repository details

Type:	Program
Mbed OS support:	Mbed OS
Created:	17 Jul 2017
Imports:	5
Forks:	0
Commits:	51
Dependents:	0
Dependencies:	0
Followers:	1

DuerOS-Light-SDK-v1.1.0/duer-os-light/src/iot-baidu-ota/baidu_ota_unpack/zliblite/zlib.h@47:9e361da97763, 2017-07-18 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning