--- /dev/null
+/* zlib.h -- interface of the 'zlib' general purpose compression library\r
+ version 1.2.3, July 18th, 2005\r
+\r
+ Copyright (C) 1995-2005 Jean-loup Gailly and Mark Adler\r
+\r
+ This software is provided 'as-is', without any express or implied\r
+ warranty. In no event will the authors be held liable for any damages\r
+ arising from the use of this software.\r
+\r
+ Permission is granted to anyone to use this software for any purpose,\r
+ including commercial applications, and to alter it and redistribute it\r
+ freely, subject to the following restrictions:\r
+\r
+ 1. The origin of this software must not be misrepresented; you must not\r
+ claim that you wrote the original software. If you use this software\r
+ in a product, an acknowledgment in the product documentation would be\r
+ appreciated but is not required.\r
+ 2. Altered source versions must be plainly marked as such, and must not be\r
+ misrepresented as being the original software.\r
+ 3. This notice may not be removed or altered from any source distribution.\r
+\r
+ Jean-loup Gailly Mark Adler\r
+ jloup@gzip.org madler@alumni.caltech.edu\r
+\r
+\r
+ The data format used by the zlib library is described by RFCs (Request for\r
+ Comments) 1950 to 1952 in the files http://www.ietf.org/rfc/rfc1950.txt\r
+ (zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format).\r
+*/\r
+\r
+#ifndef ZLIB_H\r
+#define ZLIB_H\r
+\r
+#include "zconf.h"\r
+\r
+#ifdef __cplusplus\r
+extern "C" {\r
+#endif\r
+\r
+#define ZLIB_VERSION "1.2.3"\r
+#define ZLIB_VERNUM 0x1230\r
+\r
+/*\r
+ The 'zlib' compression library provides in-memory compression and\r
+ decompression functions, including integrity checks of the uncompressed\r
+ data. This version of the library supports only one compression method\r
+ (deflation) but other algorithms will be added later and will have the same\r
+ stream interface.\r
+\r
+ Compression can be done in a single step if the buffers are large\r
+ enough (for example if an input file is mmap'ed), or can be done by\r
+ repeated calls of the compression function. In the latter case, the\r
+ application must provide more input and/or consume the output\r
+ (providing more output space) before each call.\r
+\r
+ The compressed data format used by default by the in-memory functions is\r
+ the zlib format, which is a zlib wrapper documented in RFC 1950, wrapped\r
+ around a deflate stream, which is itself documented in RFC 1951.\r
+\r
+ The library also supports reading and writing files in gzip (.gz) format\r
+ with an interface similar to that of stdio using the functions that start\r
+ with "gz". The gzip format is different from the zlib format. gzip is a\r
+ gzip wrapper, documented in RFC 1952, wrapped around a deflate stream.\r
+\r
+ This library can optionally read and write gzip streams in memory as well.\r
+\r
+ The zlib format was designed to be compact and fast for use in memory\r
+ and on communications channels. The gzip format was designed for single-\r
+ file compression on file systems, has a larger header than zlib to maintain\r
+ directory information, and uses a different, slower check method than zlib.\r
+\r
+ The library does not install any signal handler. The decoder checks\r
+ the consistency of the compressed data, so the library should never\r
+ crash even in case of corrupted input.\r
+*/\r
+\r
+typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size));\r
+typedef void (*free_func) OF((voidpf opaque, voidpf address));\r
+\r
+struct internal_state;\r
+\r
+typedef struct z_stream_s {\r
+ Bytef *next_in; /* next input byte */\r
+ uInt avail_in; /* number of bytes available at next_in */\r
+ uLong total_in; /* total nb of input bytes read so far */\r
+\r
+ Bytef *next_out; /* next output byte should be put there */\r
+ uInt avail_out; /* remaining free space at next_out */\r
+ uLong total_out; /* total nb of bytes output so far */\r
+\r
+ char *msg; /* last error message, NULL if no error */\r
+ struct internal_state FAR *state; /* not visible by applications */\r
+\r
+ alloc_func zalloc; /* used to allocate the internal state */\r
+ free_func zfree; /* used to free the internal state */\r
+ voidpf opaque; /* private data object passed to zalloc and zfree */\r
+\r
+ int data_type; /* best guess about the data type: binary or text */\r
+ uLong adler; /* adler32 value of the uncompressed data */\r
+ uLong reserved; /* reserved for future use */\r
+} z_stream;\r
+\r
+typedef z_stream FAR *z_streamp;\r
+\r
+/*\r
+ gzip header information passed to and from zlib routines. See RFC 1952\r
+ for more details on the meanings of these fields.\r
+*/\r
+typedef struct gz_header_s {\r
+ int text; /* true if compressed data believed to be text */\r
+ uLong time; /* modification time */\r
+ int xflags; /* extra flags (not used when writing a gzip file) */\r
+ int os; /* operating system */\r
+ Bytef *extra; /* pointer to extra field or Z_NULL if none */\r
+ uInt extra_len; /* extra field length (valid if extra != Z_NULL) */\r
+ uInt extra_max; /* space at extra (only when reading header) */\r
+ Bytef *name; /* pointer to zero-terminated file name or Z_NULL */\r
+ uInt name_max; /* space at name (only when reading header) */\r
+ Bytef *comment; /* pointer to zero-terminated comment or Z_NULL */\r
+ uInt comm_max; /* space at comment (only when reading header) */\r
+ int hcrc; /* true if there was or will be a header crc */\r
+ int done; /* true when done reading gzip header (not used\r
+ when writing a gzip file) */\r
+} gz_header;\r
+\r
+typedef gz_header FAR *gz_headerp;\r
+\r
+/*\r
+ The application must update next_in and avail_in when avail_in has\r
+ dropped to zero. It must update next_out and avail_out when avail_out\r
+ has dropped to zero. The application must initialize zalloc, zfree and\r
+ opaque before calling the init function. All other fields are set by the\r
+ compression library and must not be updated by the application.\r
+\r
+ The opaque value provided by the application will be passed as the first\r
+ parameter for calls of zalloc and zfree. This can be useful for custom\r
+ memory management. The compression library attaches no meaning to the\r
+ opaque value.\r
+\r
+ zalloc must return Z_NULL if there is not enough memory for the object.\r
+ If zlib is used in a multi-threaded application, zalloc and zfree must be\r
+ thread safe.\r
+\r
+ On 16-bit systems, the functions zalloc and zfree must be able to allocate\r
+ exactly 65536 bytes, but will not be required to allocate more than this\r
+ if the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS,\r
+ pointers returned by zalloc for objects of exactly 65536 bytes *must*\r
+ have their offset normalized to zero. The default allocation function\r
+ provided by this library ensures this (see zutil.c). To reduce memory\r
+ requirements and avoid any allocation of 64K objects, at the expense of\r
+ compression ratio, compile the library with -DMAX_WBITS=14 (see zconf.h).\r
+\r
+ The fields total_in and total_out can be used for statistics or\r
+ progress reports. After compression, total_in holds the total size of\r
+ the uncompressed data and may be saved for use in the decompressor\r
+ (particularly if the decompressor wants to decompress everything in\r
+ a single step).\r
+*/\r
+\r
+ /* constants */\r
+\r
+#define Z_NO_FLUSH 0\r
+#define Z_PARTIAL_FLUSH 1 /* will be removed, use Z_SYNC_FLUSH instead */\r
+#define Z_SYNC_FLUSH 2\r
+#define Z_FULL_FLUSH 3\r
+#define Z_FINISH 4\r
+#define Z_BLOCK 5\r
+/* Allowed flush values; see deflate() and inflate() below for details */\r
+\r
+#define Z_OK 0\r
+#define Z_STREAM_END 1\r
+#define Z_NEED_DICT 2\r
+#define Z_ERRNO (-1)\r
+#define Z_STREAM_ERROR (-2)\r
+#define Z_DATA_ERROR (-3)\r
+#define Z_MEM_ERROR (-4)\r
+#define Z_BUF_ERROR (-5)\r
+#define Z_VERSION_ERROR (-6)\r
+/* Return codes for the compression/decompression functions. Negative\r
+ * values are errors, positive values are used for special but normal events.\r
+ */\r
+\r
+#define Z_NO_COMPRESSION 0\r
+#define Z_BEST_SPEED 1\r
+#define Z_BEST_COMPRESSION 9\r
+#define Z_DEFAULT_COMPRESSION (-1)\r
+/* compression levels */\r
+\r
+#define Z_FILTERED 1\r
+#define Z_HUFFMAN_ONLY 2\r
+#define Z_RLE 3\r
+#define Z_FIXED 4\r
+#define Z_DEFAULT_STRATEGY 0\r
+/* compression strategy; see deflateInit2() below for details */\r
+\r
+#define Z_BINARY 0\r
+#define Z_TEXT 1\r
+#define Z_ASCII Z_TEXT /* for compatibility with 1.2.2 and earlier */\r
+#define Z_UNKNOWN 2\r
+/* Possible values of the data_type field (though see inflate()) */\r
+\r
+#define Z_DEFLATED 8\r
+/* The deflate compression method (the only one supported in this version) */\r
+\r
+#define Z_NULL 0 /* for initializing zalloc, zfree, opaque */\r
+\r
+#define zlib_version zlibVersion()\r
+/* for compatibility with versions < 1.0.2 */\r
+\r
+ /* basic functions */\r
+\r
+ZEXTERN const char * ZEXPORT zlibVersion OF((void));\r
+/* The application can compare zlibVersion and ZLIB_VERSION for consistency.\r
+ If the first character differs, the library code actually used is\r
+ not compatible with the zlib.h header file used by the application.\r
+ This check is automatically made by deflateInit and inflateInit.\r
+ */\r
+\r
+/*\r
+ZEXTERN int ZEXPORT deflateInit OF((z_streamp strm, int level));\r
+\r
+ Initializes the internal stream state for compression. The fields\r
+ zalloc, zfree and opaque must be initialized before by the caller.\r
+ If zalloc and zfree are set to Z_NULL, deflateInit updates them to\r
+ use default allocation functions.\r
+\r
+ The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9:\r
+ 1 gives best speed, 9 gives best compression, 0 gives no compression at\r
+ all (the input data is simply copied a block at a time).\r
+ Z_DEFAULT_COMPRESSION requests a default compromise between speed and\r
+ compression (currently equivalent to level 6).\r
+\r
+ deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not\r
+ enough memory, Z_STREAM_ERROR if level is not a valid compression level,\r
+ Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible\r
+ with the version assumed by the caller (ZLIB_VERSION).\r
+ msg is set to null if there is no error message. deflateInit does not\r
+ perform any compression: this will be done by deflate().\r
+*/\r
+\r
+\r
+ZEXTERN int ZEXPORT deflate OF((z_streamp strm, int flush));\r
+/*\r
+ deflate compresses as much data as possible, and stops when the input\r
+ buffer becomes empty or the output buffer becomes full. It may introduce some\r
+ output latency (reading input without producing any output) except when\r
+ forced to flush.\r
+\r
+ The detailed semantics are as follows. deflate performs one or both of the\r
+ following actions:\r
+\r
+ - Compress more input starting at next_in and update next_in and avail_in\r
+ accordingly. If not all input can be processed (because there is not\r
+ enough room in the output buffer), next_in and avail_in are updated and\r
+ processing will resume at this point for the next call of deflate().\r
+\r
+ - Provide more output starting at next_out and update next_out and avail_out\r
+ accordingly. This action is forced if the parameter flush is non zero.\r
+ Forcing flush frequently degrades the compression ratio, so this parameter\r
+ should be set only when necessary (in interactive applications).\r
+ Some output may be provided even if flush is not set.\r
+\r
+ Before the call of deflate(), the application should ensure that at least\r
+ one of the actions is possible, by providing more input and/or consuming\r
+ more output, and updating avail_in or avail_out accordingly; avail_out\r
+ should never be zero before the call. The application can consume the\r
+ compressed output when it wants, for example when the output buffer is full\r
+ (avail_out == 0), or after each call of deflate(). If deflate returns Z_OK\r
+ and with zero avail_out, it must be called again after making room in the\r
+ output buffer because there might be more output pending.\r
+\r
+ Normally the parameter flush is set to Z_NO_FLUSH, which allows deflate to\r
+ decide how much data to accumualte before producing output, in order to\r
+ maximize compression.\r
+\r
+ If the parameter flush is set to Z_SYNC_FLUSH, all pending output is\r
+ flushed to the output buffer and the output is aligned on a byte boundary, so\r
+ that the decompressor can get all input data available so far. (In particular\r
+ avail_in is zero after the call if enough output space has been provided\r
+ before the call.) Flushing may degrade compression for some compression\r
+ algorithms and so it should be used only when necessary.\r
+\r
+ If flush is set to Z_FULL_FLUSH, all output is flushed as with\r
+ Z_SYNC_FLUSH, and the compression state is reset so that decompression can\r
+ restart from this point if previous compressed data has been damaged or if\r
+ random access is desired. Using Z_FULL_FLUSH too often can seriously degrade\r
+ compression.\r
+\r
+ If deflate returns with avail_out == 0, this function must be called again\r
+ with the same value of the flush parameter and more output space (updated\r
+ avail_out), until the flush is complete (deflate returns with non-zero\r
+ avail_out). In the case of a Z_FULL_FLUSH or Z_SYNC_FLUSH, make sure that\r
+ avail_out is greater than six to avoid repeated flush markers due to\r
+ avail_out == 0 on return.\r
+\r
+ If the parameter flush is set to Z_FINISH, pending input is processed,\r
+ pending output is flushed and deflate returns with Z_STREAM_END if there\r
+ was enough output space; if deflate returns with Z_OK, this function must be\r
+ called again with Z_FINISH and more output space (updated avail_out) but no\r
+ more input data, until it returns with Z_STREAM_END or an error. After\r
+ deflate has returned Z_STREAM_END, the only possible operations on the\r
+ stream are deflateReset or deflateEnd.\r
+\r
+ Z_FINISH can be used immediately after deflateInit if all the compression\r
+ is to be done in a single step. In this case, avail_out must be at least\r
+ the value returned by deflateBound (see below). If deflate does not return\r
+ Z_STREAM_END, then it must be called again as described above.\r
+\r
+ deflate() sets strm->adler to the adler32 checksum of all input read\r
+ so far (that is, total_in bytes).\r
+\r
+ deflate() may update strm->data_type if it can make a good guess about\r
+ the input data type (Z_BINARY or Z_TEXT). In doubt, the data is considered\r
+ binary. This field is only for information purposes and does not affect\r
+ the compression algorithm in any manner.\r
+\r
+ deflate() returns Z_OK if some progress has been made (more input\r
+ processed or more output produced), Z_STREAM_END if all input has been\r
+ consumed and all output has been produced (only when flush is set to\r
+ Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example\r
+ if next_in or next_out was NULL), Z_BUF_ERROR if no progress is possible\r
+ (for example avail_in or avail_out was zero). Note that Z_BUF_ERROR is not\r
+ fatal, and deflate() can be called again with more input and more output\r
+ space to continue compressing.\r
+*/\r
+\r
+\r
+ZEXTERN int ZEXPORT deflateEnd OF((z_streamp strm));\r
+/*\r
+ All dynamically allocated data structures for this stream are freed.\r
+ This function discards any unprocessed input and does not flush any\r
+ pending output.\r
+\r
+ deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the\r
+ stream state was inconsistent, Z_DATA_ERROR if the stream was freed\r
+ prematurely (some input or output was discarded). In the error case,\r
+ msg may be set but then points to a static string (which must not be\r
+ deallocated).\r
+*/\r
+\r
+\r
+/*\r
+ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm));\r
+\r
+ Initializes the internal stream state for decompression. The fields\r
+ next_in, avail_in, zalloc, zfree and opaque must be initialized before by\r
+ the caller. If next_in is not Z_NULL and avail_in is large enough (the exact\r
+ value depends on the compression method), inflateInit determines the\r
+ compression method from the zlib header and allocates all data structures\r
+ accordingly; otherwise the allocation will be deferred to the first call of\r
+ inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them to\r
+ use default allocation functions.\r
+\r
+ inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough\r
+ memory, Z_VERSION_ERROR if the zlib library version is incompatible with the\r
+ version assumed by the caller. msg is set to null if there is no error\r
+ message. inflateInit does not perform any decompression apart from reading\r
+ the zlib header if present: this will be done by inflate(). (So next_in and\r
+ avail_in may be modified, but next_out and avail_out are unchanged.)\r
+*/\r
+\r
+\r
+ZEXTERN int ZEXPORT inflate OF((z_streamp strm, int flush));\r
+/*\r
+ inflate decompresses as much data as possible, and stops when the input\r
+ buffer becomes empty or the output buffer becomes full. It may introduce\r
+ some output latency (reading input without producing any output) except when\r
+ forced to flush.\r
+\r
+ The detailed semantics are as follows. inflate performs one or both of the\r
+ following actions:\r
+\r
+ - Decompress more input starting at next_in and update next_in and avail_in\r
+ accordingly. If not all input can be processed (because there is not\r
+ enough room in the output buffer), next_in is updated and processing\r
+ will resume at this point for the next call of inflate().\r
+\r
+ - Provide more output starting at next_out and update next_out and avail_out\r
+ accordingly. inflate() provides as much output as possible, until there\r
+ is no more input data or no more space in the output buffer (see below\r
+ about the flush parameter).\r
+\r
+ Before the call of inflate(), the application should ensure that at least\r
+ one of the actions is possible, by providing more input and/or consuming\r
+ more output, and updating the next_* and avail_* values accordingly.\r
+ The application can consume the uncompressed output when it wants, for\r
+ example when the output buffer is full (avail_out == 0), or after each\r
+ call of inflate(). If inflate returns Z_OK and with zero avail_out, it\r
+ must be called again after making room in the output buffer because there\r
+ might be more output pending.\r
+\r
+ The flush parameter of inflate() can be Z_NO_FLUSH, Z_SYNC_FLUSH,\r
+ Z_FINISH, or Z_BLOCK. Z_SYNC_FLUSH requests that inflate() flush as much\r
+ output as possible to the output buffer. Z_BLOCK requests that inflate() stop\r
+ if and when it gets to the next deflate block boundary. When decoding the\r
+ zlib or gzip format, this will cause inflate() to return immediately after\r
+ the header and before the first block. When doing a raw inflate, inflate()\r
+ will go ahead and process the first block, and will return when it gets to\r
+ the end of that block, or when it runs out of data.\r
+\r
+ The Z_BLOCK option assists in appending to or combining deflate streams.\r
+ Also to assist in this, on return inflate() will set strm->data_type to the\r
+ number of unused bits in the last byte taken from strm->next_in, plus 64\r
+ if inflate() is currently decoding the last block in the deflate stream,\r
+ plus 128 if inflate() returned immediately after decoding an end-of-block\r
+ code or decoding the complete header up to just before the first byte of the\r
+ deflate stream. The end-of-block will not be indicated until all of the\r
+ uncompressed data from that block has been written to strm->next_out. The\r
+ number of unused bits may in general be greater than seven, except when\r
+ bit 7 of data_type is set, in which case the number of unused bits will be\r
+ less than eight.\r
+\r
+ inflate() should normally be called until it returns Z_STREAM_END or an\r
+ error. However if all decompression is to be performed in a single step\r
+ (a single call of inflate), the parameter flush should be set to\r
+ Z_FINISH. In this case all pending input is processed and all pending\r
+ output is flushed; avail_out must be large enough to hold all the\r
+ uncompressed data. (The size of the uncompressed data may have been saved\r
+ by the compressor for this purpose.) The next operation on this stream must\r
+ be inflateEnd to deallocate the decompression state. The use of Z_FINISH\r
+ is never required, but can be used to inform inflate that a faster approach\r
+ may be used for the single inflate() call.\r
+\r
+ In this implementation, inflate() always flushes as much output as\r
+ possible to the output buffer, and always uses the faster approach on the\r
+ first call. So the only effect of the flush parameter in this implementation\r
+ is on the return value of inflate(), as noted below, or when it returns early\r
+ because Z_BLOCK is used.\r
+\r
+ If a preset dictionary is needed after this call (see inflateSetDictionary\r
+ below), inflate sets strm->adler to the adler32 checksum of the dictionary\r
+ chosen by the compressor and returns Z_NEED_DICT; otherwise it sets\r
+ strm->adler to the adler32 checksum of all output produced so far (that is,\r
+ total_out bytes) and returns Z_OK, Z_STREAM_END or an error code as described\r
+ below. At the end of the stream, inflate() checks that its computed adler32\r
+ checksum is equal to that saved by the compressor and returns Z_STREAM_END\r
+ only if the checksum is correct.\r
+\r
+ inflate() will decompress and check either zlib-wrapped or gzip-wrapped\r
+ deflate data. The header type is detected automatically. Any information\r
+ contained in the gzip header is not retained, so applications that need that\r
+ information should instead use raw inflate, see inflateInit2() below, or\r
+ inflateBack() and perform their own processing of the gzip header and\r
+ trailer.\r
+\r
+ inflate() returns Z_OK if some progress has been made (more input processed\r
+ or more output produced), Z_STREAM_END if the end of the compressed data has\r
+ been reached and all uncompressed output has been produced, Z_NEED_DICT if a\r
+ preset dictionary is needed at this point, Z_DATA_ERROR if the input data was\r
+ corrupted (input stream not conforming to the zlib format or incorrect check\r
+ value), Z_STREAM_ERROR if the stream structure was inconsistent (for example\r
+ if next_in or next_out was NULL), Z_MEM_ERROR if there was not enough memory,\r
+ Z_BUF_ERROR if no progress is possible or if there was not enough room in the\r
+ output buffer when Z_FINISH is used. Note that Z_BUF_ERROR is not fatal, and\r
+ inflate() can be called again with more input and more output space to\r
+ continue decompressing. If Z_DATA_ERROR is returned, the application may then\r
+ call inflateSync() to look for a good compression block if a partial recovery\r
+ of the data is desired.\r
+*/\r
+\r
+\r
+ZEXTERN int ZEXPORT inflateEnd OF((z_streamp strm));\r
+/*\r
+ All dynamically allocated data structures for this stream are freed.\r
+ This function discards any unprocessed input and does not flush any\r
+ pending output.\r
+\r
+ inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state\r
+ was inconsistent. In the error case, msg may be set but then points to a\r
+ static string (which must not be deallocated).\r
+*/\r
+\r
+ /* Advanced functions */\r
+\r
+/*\r
+ The following functions are needed only in some special applications.\r
+*/\r
+\r
+/*\r
+ZEXTERN int ZEXPORT deflateInit2 OF((z_streamp strm,\r
+ int level,\r
+ int method,\r
+ int windowBits,\r
+ int memLevel,\r
+ int strategy));\r
+\r
+ This is another version of deflateInit with more compression options. The\r
+ fields next_in, zalloc, zfree and opaque must be initialized before by\r
+ the caller.\r
+\r
+ The method parameter is the compression method. It must be Z_DEFLATED in\r
+ this version of the library.\r
+\r
+ The windowBits parameter is the base two logarithm of the window size\r
+ (the size of the history buffer). It should be in the range 8..15 for this\r
+ version of the library. Larger values of this parameter result in better\r
+ compression at the expense of memory usage. The default value is 15 if\r
+ deflateInit is used instead.\r
+\r
+ windowBits can also be -8..-15 for raw deflate. In this case, -windowBits\r
+ determines the window size. deflate() will then generate raw deflate data\r
+ with no zlib header or trailer, and will not compute an adler32 check value.\r
+\r
+ windowBits can also be greater than 15 for optional gzip encoding. Add\r
+ 16 to windowBits to write a simple gzip header and trailer around the\r
+ compressed data instead of a zlib wrapper. The gzip header will have no\r
+ file name, no extra data, no comment, no modification time (set to zero),\r
+ no header crc, and the operating system will be set to 255 (unknown). If a\r
+ gzip stream is being written, strm->adler is a crc32 instead of an adler32.\r
+\r
+ The memLevel parameter specifies how much memory should be allocated\r
+ for the internal compression state. memLevel=1 uses minimum memory but\r
+ is slow and reduces compression ratio; memLevel=9 uses maximum memory\r
+ for optimal speed. The default value is 8. See zconf.h for total memory\r
+ usage as a function of windowBits and memLevel.\r
+\r
+ The strategy parameter is used to tune the compression algorithm. Use the\r
+ value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a\r
+ filter (or predictor), Z_HUFFMAN_ONLY to force Huffman encoding only (no\r
+ string match), or Z_RLE to limit match distances to one (run-length\r
+ encoding). Filtered data consists mostly of small values with a somewhat\r
+ random distribution. In this case, the compression algorithm is tuned to\r
+ compress them better. The effect of Z_FILTERED is to force more Huffman\r
+ coding and less string matching; it is somewhat intermediate between\r
+ Z_DEFAULT and Z_HUFFMAN_ONLY. Z_RLE is designed to be almost as fast as\r
+ Z_HUFFMAN_ONLY, but give better compression for PNG image data. The strategy\r
+ parameter only affects the compression ratio but not the correctness of the\r
+ compressed output even if it is not set appropriately. Z_FIXED prevents the\r
+ use of dynamic Huffman codes, allowing for a simpler decoder for special\r
+ applications.\r
+\r
+ deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough\r
+ memory, Z_STREAM_ERROR if a parameter is invalid (such as an invalid\r
+ method). msg is set to null if there is no error message. deflateInit2 does\r
+ not perform any compression: this will be done by deflate().\r
+*/\r
+\r
+ZEXTERN int ZEXPORT deflateSetDictionary OF((z_streamp strm,\r
+ const Bytef *dictionary,\r
+ uInt dictLength));\r
+/*\r
+ Initializes the compression dictionary from the given byte sequence\r
+ without producing any compressed output. This function must be called\r
+ immediately after deflateInit, deflateInit2 or deflateReset, before any\r
+ call of deflate. The compressor and decompressor must use exactly the same\r
+ dictionary (see inflateSetDictionary).\r
+\r
+ The dictionary should consist of strings (byte sequences) that are likely\r
+ to be encountered later in the data to be compressed, with the most commonly\r
+ used strings preferably put towards the end of the dictionary. Using a\r
+ dictionary is most useful when the data to be compressed is short and can be\r
+ predicted with good accuracy; the data can then be compressed better than\r
+ with the default empty dictionary.\r
+\r
+ Depending on the size of the compression data structures selected by\r
+ deflateInit or deflateInit2, a part of the dictionary may in effect be\r
+ discarded, for example if the dictionary is larger than the window size in\r
+ deflate or deflate2. Thus the strings most likely to be useful should be\r
+ put at the end of the dictionary, not at the front. In addition, the\r
+ current implementation of deflate will use at most the window size minus\r
+ 262 bytes of the provided dictionary.\r
+\r
+ Upon return of this function, strm->adler is set to the adler32 value\r
+ of the dictionary; the decompressor may later use this value to determine\r
+ which dictionary has been used by the compressor. (The adler32 value\r
+ applies to the whole dictionary even if only a subset of the dictionary is\r
+ actually used by the compressor.) If a raw deflate was requested, then the\r
+ adler32 value is not computed and strm->adler is not set.\r
+\r
+ deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a\r
+ parameter is invalid (such as NULL dictionary) or the stream state is\r
+ inconsistent (for example if deflate has already been called for this stream\r
+ or if the compression method is bsort). deflateSetDictionary does not\r
+ perform any compression: this will be done by deflate().\r
+*/\r
+\r
+ZEXTERN int ZEXPORT deflateCopy OF((z_streamp dest,\r
+ z_streamp source));\r
+/*\r
+ Sets the destination stream as a complete copy of the source stream.\r
+\r
+ This function can be useful when several compression strategies will be\r
+ tried, for example when there are several ways of pre-processing the input\r
+ data with a filter. The streams that will be discarded should then be freed\r
+ by calling deflateEnd. Note that deflateCopy duplicates the internal\r
+ compression state which can be quite large, so this strategy is slow and\r
+ can consume lots of memory.\r
+\r
+ deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not\r
+ enough memory, Z_STREAM_ERROR if the source stream state was inconsistent\r
+ (such as zalloc being NULL). msg is left unchanged in both source and\r
+ destination.\r
+*/\r
+\r
+ZEXTERN int ZEXPORT deflateReset OF((z_streamp strm));\r
+/*\r
+ This function is equivalent to deflateEnd followed by deflateInit,\r
+ but does not free and reallocate all the internal compression state.\r
+ The stream will keep the same compression level and any other attributes\r
+ that may have been set by deflateInit2.\r
+\r
+ deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source\r
+ stream state was inconsistent (such as zalloc or state being NULL).\r
+*/\r
+\r
+ZEXTERN int ZEXPORT deflateParams OF((z_streamp strm,\r
+ int level,\r
+ int strategy));\r
+/*\r
+ Dynamically update the compression level and compression strategy. The\r
+ interpretation of level and strategy is as in deflateInit2. This can be\r
+ used to switch between compression and straight copy of the input data, or\r
+ to switch to a different kind of input data requiring a different\r
+ strategy. If the compression level is changed, the input available so far\r
+ is compressed with the old level (and may be flushed); the new level will\r
+ take effect only at the next call of deflate().\r
+\r
+ Before the call of deflateParams, the stream state must be set as for\r
+ a call of deflate(), since the currently available input may have to\r
+ be compressed and flushed. In particular, strm->avail_out must be non-zero.\r
+\r
+ deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source\r
+ stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR\r
+ if strm->avail_out was zero.\r
+*/\r
+\r
+ZEXTERN int ZEXPORT deflateTune OF((z_streamp strm,\r
+ int good_length,\r
+ int max_lazy,\r
+ int nice_length,\r
+ int max_chain));\r
+/*\r
+ Fine tune deflate's internal compression parameters. This should only be\r
+ used by someone who understands the algorithm used by zlib's deflate for\r
+ searching for the best matching string, and even then only by the most\r
+ fanatic optimizer trying to squeeze out the last compressed bit for their\r
+ specific input data. Read the deflate.c source code for the meaning of the\r
+ max_lazy, good_length, nice_length, and max_chain parameters.\r
+\r
+ deflateTune() can be called after deflateInit() or deflateInit2(), and\r
+ returns Z_OK on success, or Z_STREAM_ERROR for an invalid deflate stream.\r
+ */\r
+\r
+ZEXTERN uLong ZEXPORT deflateBound OF((z_streamp strm,\r
+ uLong sourceLen));\r
+/*\r
+ deflateBound() returns an upper bound on the compressed size after\r
+ deflation of sourceLen bytes. It must be called after deflateInit()\r
+ or deflateInit2(). This would be used to allocate an output buffer\r
+ for deflation in a single pass, and so would be called before deflate().\r
+*/\r
+\r
+ZEXTERN int ZEXPORT deflatePrime OF((z_streamp strm,\r
+ int bits,\r
+ int value));\r
+/*\r
+ deflatePrime() inserts bits in the deflate output stream. The intent\r
+ is that this function is used to start off the deflate output with the\r
+ bits leftover from a previous deflate stream when appending to it. As such,\r
+ this function can only be used for raw deflate, and must be used before the\r
+ first deflate() call after a deflateInit2() or deflateReset(). bits must be\r
+ less than or equal to 16, and that many of the least significant bits of\r
+ value will be inserted in the output.\r
+\r
+ deflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source\r
+ stream state was inconsistent.\r
+*/\r
+\r
+ZEXTERN int ZEXPORT deflateSetHeader OF((z_streamp strm,\r
+ gz_headerp head));\r
+/*\r
+ deflateSetHeader() provides gzip header information for when a gzip\r
+ stream is requested by deflateInit2(). deflateSetHeader() may be called\r
+ after deflateInit2() or deflateReset() and before the first call of\r
+ deflate(). The text, time, os, extra field, name, and comment information\r
+ in the provided gz_header structure are written to the gzip header (xflag is\r
+ ignored -- the extra flags are set according to the compression level). The\r
+ caller must assure that, if not Z_NULL, name and comment are terminated with\r
+ a zero byte, and that if extra is not Z_NULL, that extra_len bytes are\r
+ available there. If hcrc is true, a gzip header crc is included. Note that\r
+ the current versions of the command-line version of gzip (up through version\r
+ 1.3.x) do not support header crc's, and will report that it is a "multi-part\r
+ gzip file" and give up.\r
+\r
+ If deflateSetHeader is not used, the default gzip header has text false,\r
+ the time set to zero, and os set to 255, with no extra, name, or comment\r
+ fields. The gzip header is returned to the default state by deflateReset().\r
+\r
+ deflateSetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source\r
+ stream state was inconsistent.\r
+*/\r
+\r
+/*\r
+ZEXTERN int ZEXPORT inflateInit2 OF((z_streamp strm,\r
+ int windowBits));\r
+\r
+ This is another version of inflateInit with an extra parameter. The\r
+ fields next_in, avail_in, zalloc, zfree and opaque must be initialized\r
+ before by the caller.\r
+\r
+ The windowBits parameter is the base two logarithm of the maximum window\r
+ size (the size of the history buffer). It should be in the range 8..15 for\r
+ this version of the library. The default value is 15 if inflateInit is used\r
+ instead. windowBits must be greater than or equal to the windowBits value\r
+ provided to deflateInit2() while compressing, or it must be equal to 15 if\r
+ deflateInit2() was not used. If a compressed stream with a larger window\r
+ size is given as input, inflate() will return with the error code\r
+ Z_DATA_ERROR instead of trying to allocate a larger window.\r
+\r
+ windowBits can also be -8..-15 for raw inflate. In this case, -windowBits\r
+ determines the window size. inflate() will then process raw deflate data,\r
+ not looking for a zlib or gzip header, not generating a check value, and not\r
+ looking for any check values for comparison at the end of the stream. This\r
+ is for use with other formats that use the deflate compressed data format\r
+ such as zip. Those formats provide their own check values. If a custom\r
+ format is developed using the raw deflate format for compressed data, it is\r
+ recommended that a check value such as an adler32 or a crc32 be applied to\r
+ the uncompressed data as is done in the zlib, gzip, and zip formats. For\r
+ most applications, the zlib format should be used as is. Note that comments\r
+ above on the use in deflateInit2() applies to the magnitude of windowBits.\r
+\r
+ windowBits can also be greater than 15 for optional gzip decoding. Add\r
+ 32 to windowBits to enable zlib and gzip decoding with automatic header\r
+ detection, or add 16 to decode only the gzip format (the zlib format will\r
+ return a Z_DATA_ERROR). If a gzip stream is being decoded, strm->adler is\r
+ a crc32 instead of an adler32.\r
+\r
+ inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough\r
+ memory, Z_STREAM_ERROR if a parameter is invalid (such as a null strm). msg\r
+ is set to null if there is no error message. inflateInit2 does not perform\r
+ any decompression apart from reading the zlib header if present: this will\r
+ be done by inflate(). (So next_in and avail_in may be modified, but next_out\r
+ and avail_out are unchanged.)\r
+*/\r
+\r
+ZEXTERN int ZEXPORT inflateSetDictionary OF((z_streamp strm,\r
+ const Bytef *dictionary,\r
+ uInt dictLength));\r
+/*\r
+ Initializes the decompression dictionary from the given uncompressed byte\r
+ sequence. This function must be called immediately after a call of inflate,\r
+ if that call returned Z_NEED_DICT. The dictionary chosen by the compressor\r
+ can be determined from the adler32 value returned by that call of inflate.\r
+ The compressor and decompressor must use exactly the same dictionary (see\r
+ deflateSetDictionary). For raw inflate, this function can be called\r
+ immediately after inflateInit2() or inflateReset() and before any call of\r
+ inflate() to set the dictionary. The application must insure that the\r
+ dictionary that was used for compression is provided.\r
+\r
+ inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a\r
+ parameter is invalid (such as NULL dictionary) or the stream state is\r
+ inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the\r
+ expected one (incorrect adler32 value). inflateSetDictionary does not\r
+ perform any decompression: this will be done by subsequent calls of\r
+ inflate().\r
+*/\r
+\r
+ZEXTERN int ZEXPORT inflateSync OF((z_streamp strm));\r
+/*\r
+ Skips invalid compressed data until a full flush point (see above the\r
+ description of deflate with Z_FULL_FLUSH) can be found, or until all\r
+ available input is skipped. No output is provided.\r
+\r
+ inflateSync returns Z_OK if a full flush point has been found, Z_BUF_ERROR\r
+ if no more input was provided, Z_DATA_ERROR if no flush point has been found,\r
+ or Z_STREAM_ERROR if the stream structure was inconsistent. In the success\r
+ case, the application may save the current current value of total_in which\r
+ indicates where valid compressed data was found. In the error case, the\r
+ application may repeatedly call inflateSync, providing more input each time,\r
+ until success or end of the input data.\r
+*/\r
+\r
+ZEXTERN int ZEXPORT inflateCopy OF((z_streamp dest,\r
+ z_streamp source));\r
+/*\r
+ Sets the destination stream as a complete copy of the source stream.\r
+\r
+ This function can be useful when randomly accessing a large stream. The\r
+ first pass through the stream can periodically record the inflate state,\r
+ allowing restarting inflate at those points when randomly accessing the\r
+ stream.\r
+\r
+ inflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not\r
+ enough memory, Z_STREAM_ERROR if the source stream state was inconsistent\r
+ (such as zalloc being NULL). msg is left unchanged in both source and\r
+ destination.\r
+*/\r
+\r
+ZEXTERN int ZEXPORT inflateReset OF((z_streamp strm));\r
+/*\r
+ This function is equivalent to inflateEnd followed by inflateInit,\r
+ but does not free and reallocate all the internal decompression state.\r
+ The stream will keep attributes that may have been set by inflateInit2.\r
+\r
+ inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source\r
+ stream state was inconsistent (such as zalloc or state being NULL).\r
+*/\r
+\r
+ZEXTERN int ZEXPORT inflatePrime OF((z_streamp strm,\r
+ int bits,\r
+ int value));\r
+/*\r
+ This function inserts bits in the inflate input stream. The intent is\r
+ that this function is used to start inflating at a bit position in the\r
+ middle of a byte. The provided bits will be used before any bytes are used\r
+ from next_in. This function should only be used with raw inflate, and\r
+ should be used before the first inflate() call after inflateInit2() or\r
+ inflateReset(). bits must be less than or equal to 16, and that many of the\r
+ least significant bits of value will be inserted in the input.\r
+\r
+ inflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source\r
+ stream state was inconsistent.\r
+*/\r
+\r
+ZEXTERN int ZEXPORT inflateGetHeader OF((z_streamp strm,\r
+ gz_headerp head));\r
+/*\r
+ inflateGetHeader() requests that gzip header information be stored in the\r
+ provided gz_header structure. inflateGetHeader() may be called after\r
+ inflateInit2() or inflateReset(), and before the first call of inflate().\r
+ As inflate() processes the gzip stream, head->done is zero until the header\r
+ is completed, at which time head->done is set to one. If a zlib stream is\r
+ being decoded, then head->done is set to -1 to indicate that there will be\r
+ no gzip header information forthcoming. Note that Z_BLOCK can be used to\r
+ force inflate() to return immediately after header processing is complete\r
+ and before any actual data is decompressed.\r
+\r
+ The text, time, xflags, and os fields are filled in with the gzip header\r
+ contents. hcrc is set to true if there is a header CRC. (The header CRC\r
+ was valid if done is set to one.) If extra is not Z_NULL, then extra_max\r
+ contains the maximum number of bytes to write to extra. Once done is true,\r
+ extra_len contains the actual extra field length, and extra contains the\r
+ extra field, or that field truncated if extra_max is less than extra_len.\r
+ If name is not Z_NULL, then up to name_max characters are written there,\r
+ terminated with a zero unless the length is greater than name_max. If\r
+ comment is not Z_NULL, then up to comm_max characters are written there,\r
+ terminated with a zero unless the length is greater than comm_max. When\r
+ any of extra, name, or comment are not Z_NULL and the respective field is\r
+ not present in the header, then that field is set to Z_NULL to signal its\r
+ absence. This allows the use of deflateSetHeader() with the returned\r
+ structure to duplicate the header. However if those fields are set to\r
+ allocated memory, then the application will need to save those pointers\r
+ elsewhere so that they can be eventually freed.\r
+\r
+ If inflateGetHeader is not used, then the header information is simply\r
+ discarded. The header is always checked for validity, including the header\r
+ CRC if present. inflateReset() will reset the process to discard the header\r
+ information. The application would need to call inflateGetHeader() again to\r
+ retrieve the header from the next gzip stream.\r
+\r
+ inflateGetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source\r
+ stream state was inconsistent.\r
+*/\r
+\r
+/*\r
+ZEXTERN int ZEXPORT inflateBackInit OF((z_streamp strm, int windowBits,\r
+ unsigned char FAR *window));\r
+\r
+ Initialize the internal stream state for decompression using inflateBack()\r
+ calls. The fields zalloc, zfree and opaque in strm must be initialized\r
+ before the call. If zalloc and zfree are Z_NULL, then the default library-\r
+ derived memory allocation routines are used. windowBits is the base two\r
+ logarithm of the window size, in the range 8..15. window is a caller\r
+ supplied buffer of that size. Except for special applications where it is\r
+ assured that deflate was used with small window sizes, windowBits must be 15\r
+ and a 32K byte window must be supplied to be able to decompress general\r
+ deflate streams.\r
+\r
+ See inflateBack() for the usage of these routines.\r
+\r
+ inflateBackInit will return Z_OK on success, Z_STREAM_ERROR if any of\r
+ the paramaters are invalid, Z_MEM_ERROR if the internal state could not\r
+ be allocated, or Z_VERSION_ERROR if the version of the library does not\r
+ match the version of the header file.\r
+*/\r
+\r
+typedef unsigned (*in_func) OF((void FAR *, unsigned char FAR * FAR *));\r
+typedef int (*out_func) OF((void FAR *, unsigned char FAR *, unsigned));\r
+\r
+ZEXTERN int ZEXPORT inflateBack OF((z_streamp strm,\r
+ in_func in, void FAR *in_desc,\r
+ out_func out, void FAR *out_desc));\r
+/*\r
+ inflateBack() does a raw inflate with a single call using a call-back\r
+ interface for input and output. This is more efficient than inflate() for\r
+ file i/o applications in that it avoids copying between the output and the\r
+ sliding window by simply making the window itself the output buffer. This\r
+ function trusts the application to not change the output buffer passed by\r
+ the output function, at least until inflateBack() returns.\r
+\r
+ inflateBackInit() must be called first to allocate the internal state\r
+ and to initialize the state with the user-provided window buffer.\r
+ inflateBack() may then be used multiple times to inflate a complete, raw\r
+ deflate stream with each call. inflateBackEnd() is then called to free\r
+ the allocated state.\r
+\r
+ A raw deflate stream is one with no zlib or gzip header or trailer.\r
+ This routine would normally be used in a utility that reads zip or gzip\r
+ files and writes out uncompressed files. The utility would decode the\r
+ header and process the trailer on its own, hence this routine expects\r
+ only the raw deflate stream to decompress. This is different from the\r
+ normal behavior of inflate(), which expects either a zlib or gzip header and\r
+ trailer around the deflate stream.\r
+\r
+ inflateBack() uses two subroutines supplied by the caller that are then\r
+ called by inflateBack() for input and output. inflateBack() calls those\r
+ routines until it reads a complete deflate stream and writes out all of the\r
+ uncompressed data, or until it encounters an error. The function's\r
+ parameters and return types are defined above in the in_func and out_func\r
+ typedefs. inflateBack() will call in(in_desc, &buf) which should return the\r
+ number of bytes of provided input, and a pointer to that input in buf. If\r
+ there is no input available, in() must return zero--buf is ignored in that\r
+ case--and inflateBack() will return a buffer error. inflateBack() will call\r
+ out(out_desc, buf, len) to write the uncompressed data buf[0..len-1]. out()\r
+ should return zero on success, or non-zero on failure. If out() returns\r
+ non-zero, inflateBack() will return with an error. Neither in() nor out()\r
+ are permitted to change the contents of the window provided to\r
+ inflateBackInit(), which is also the buffer that out() uses to write from.\r
+ The length written by out() will be at most the window size. Any non-zero\r
+ amount of input may be provided by in().\r
+\r
+ For convenience, inflateBack() can be provided input on the first call by\r
+ setting strm->next_in and strm->avail_in. If that input is exhausted, then\r
+ in() will be called. Therefore strm->next_in must be initialized before\r
+ calling inflateBack(). If strm->next_in is Z_NULL, then in() will be called\r
+ immediately for input. If strm->next_in is not Z_NULL, then strm->avail_in\r
+ must also be initialized, and then if strm->avail_in is not zero, input will\r
+ initially be taken from strm->next_in[0 .. strm->avail_in - 1].\r
+\r
+ The in_desc and out_desc parameters of inflateBack() is passed as the\r
+ first parameter of in() and out() respectively when they are called. These\r
+ descriptors can be optionally used to pass any information that the caller-\r
+ supplied in() and out() functions need to do their job.\r
+\r
+ On return, inflateBack() will set strm->next_in and strm->avail_in to\r
+ pass back any unused input that was provided by the last in() call. The\r
+ return values of inflateBack() can be Z_STREAM_END on success, Z_BUF_ERROR\r
+ if in() or out() returned an error, Z_DATA_ERROR if there was a format\r
+ error in the deflate stream (in which case strm->msg is set to indicate the\r
+ nature of the error), or Z_STREAM_ERROR if the stream was not properly\r
+ initialized. In the case of Z_BUF_ERROR, an input or output error can be\r
+ distinguished using strm->next_in which will be Z_NULL only if in() returned\r
+ an error. If strm->next is not Z_NULL, then the Z_BUF_ERROR was due to\r
+ out() returning non-zero. (in() will always be called before out(), so\r
+ strm->next_in is assured to be defined if out() returns non-zero.) Note\r
+ that inflateBack() cannot return Z_OK.\r
+*/\r
+\r
+ZEXTERN int ZEXPORT inflateBackEnd OF((z_streamp strm));\r
+/*\r
+ All memory allocated by inflateBackInit() is freed.\r
+\r
+ inflateBackEnd() returns Z_OK on success, or Z_STREAM_ERROR if the stream\r
+ state was inconsistent.\r
+*/\r
+\r
+ZEXTERN uLong ZEXPORT zlibCompileFlags OF((void));\r
+/* Return flags indicating compile-time options.\r
+\r
+ Type sizes, two bits each, 00 = 16 bits, 01 = 32, 10 = 64, 11 = other:\r
+ 1.0: size of uInt\r
+ 3.2: size of uLong\r
+ 5.4: size of voidpf (pointer)\r
+ 7.6: size of z_off_t\r
+\r
+ Compiler, assembler, and debug options:\r
+ 8: DEBUG\r
+ 9: ASMV or ASMINF -- use ASM code\r
+ 10: ZLIB_WINAPI -- exported functions use the WINAPI calling convention\r
+ 11: 0 (reserved)\r
+\r
+ One-time table building (smaller code, but not thread-safe if true):\r
+ 12: BUILDFIXED -- build static block decoding tables when needed\r
+ 13: DYNAMIC_CRC_TABLE -- build CRC calculation tables when needed\r
+ 14,15: 0 (reserved)\r
+\r
+ Library content (indicates missing functionality):\r
+ 16: NO_GZCOMPRESS -- gz* functions cannot compress (to avoid linking\r
+ deflate code when not needed)\r
+ 17: NO_GZIP -- deflate can't write gzip streams, and inflate can't detect\r
+ and decode gzip streams (to avoid linking crc code)\r
+ 18-19: 0 (reserved)\r
+\r
+ Operation variations (changes in library functionality):\r
+ 20: PKZIP_BUG_WORKAROUND -- slightly more permissive inflate\r
+ 21: FASTEST -- deflate algorithm with only one, lowest compression level\r
+ 22,23: 0 (reserved)\r
+\r
+ The sprintf variant used by gzprintf (zero is best):\r
+ 24: 0 = vs*, 1 = s* -- 1 means limited to 20 arguments after the format\r
+ 25: 0 = *nprintf, 1 = *printf -- 1 means gzprintf() not secure!\r
+ 26: 0 = returns value, 1 = void -- 1 means inferred string length returned\r
+\r
+ Remainder:\r
+ 27-31: 0 (reserved)\r
+ */\r
+\r
+\r
+ /* utility functions */\r
+\r
+/*\r
+ The following utility functions are implemented on top of the\r
+ basic stream-oriented functions. To simplify the interface, some\r
+ default options are assumed (compression level and memory usage,\r
+ standard memory allocation functions). The source code of these\r
+ utility functions can easily be modified if you need special options.\r
+*/\r
+\r
+ZEXTERN int ZEXPORT compress OF((Bytef *dest, uLongf *destLen,\r
+ const Bytef *source, uLong sourceLen));\r
+/*\r
+ Compresses the source buffer into the destination buffer. sourceLen is\r
+ the byte length of the source buffer. Upon entry, destLen is the total\r
+ size of the destination buffer, which must be at least the value returned\r
+ by compressBound(sourceLen). Upon exit, destLen is the actual size of the\r
+ compressed buffer.\r
+ This function can be used to compress a whole file at once if the\r
+ input file is mmap'ed.\r
+ compress returns Z_OK if success, Z_MEM_ERROR if there was not\r
+ enough memory, Z_BUF_ERROR if there was not enough room in the output\r
+ buffer.\r
+*/\r
+\r
+ZEXTERN int ZEXPORT compress2 OF((Bytef *dest, uLongf *destLen,\r
+ const Bytef *source, uLong sourceLen,\r
+ int level));\r
+/*\r
+ Compresses the source buffer into the destination buffer. The level\r
+ parameter has the same meaning as in deflateInit. sourceLen is the byte\r
+ length of the source buffer. Upon entry, destLen is the total size of the\r
+ destination buffer, which must be at least the value returned by\r
+ compressBound(sourceLen). Upon exit, destLen is the actual size of the\r
+ compressed buffer.\r
+\r
+ compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough\r
+ memory, Z_BUF_ERROR if there was not enough room in the output buffer,\r
+ Z_STREAM_ERROR if the level parameter is invalid.\r
+*/\r
+\r
+ZEXTERN uLong ZEXPORT compressBound OF((uLong sourceLen));\r
+/*\r
+ compressBound() returns an upper bound on the compressed size after\r
+ compress() or compress2() on sourceLen bytes. It would be used before\r
+ a compress() or compress2() call to allocate the destination buffer.\r
+*/\r
+\r
+ZEXTERN int ZEXPORT uncompress OF((Bytef *dest, uLongf *destLen,\r
+ const Bytef *source, uLong sourceLen));\r
+/*\r
+ Decompresses the source buffer into the destination buffer. sourceLen is\r
+ the byte length of the source buffer. Upon entry, destLen is the total\r
+ size of the destination buffer, which must be large enough to hold the\r
+ entire uncompressed data. (The size of the uncompressed data must have\r
+ been saved previously by the compressor and transmitted to the decompressor\r
+ by some mechanism outside the scope of this compression library.)\r
+ Upon exit, destLen is the actual size of the compressed buffer.\r
+ This function can be used to decompress a whole file at once if the\r
+ input file is mmap'ed.\r
+\r
+ uncompress returns Z_OK if success, Z_MEM_ERROR if there was not\r
+ enough memory, Z_BUF_ERROR if there was not enough room in the output\r
+ buffer, or Z_DATA_ERROR if the input data was corrupted or incomplete.\r
+*/\r
+\r
+\r
+typedef voidp gzFile;\r
+\r
+ZEXTERN gzFile ZEXPORT gzopen OF((const char *path, const char *mode));\r
+/*\r
+ Opens a gzip (.gz) file for reading or writing. The mode parameter\r
+ is as in fopen ("rb" or "wb") but can also include a compression level\r
+ ("wb9") or a strategy: 'f' for filtered data as in "wb6f", 'h' for\r
+ Huffman only compression as in "wb1h", or 'R' for run-length encoding\r
+ as in "wb1R". (See the description of deflateInit2 for more information\r
+ about the strategy parameter.)\r
+\r
+ gzopen can be used to read a file which is not in gzip format; in this\r
+ case gzread will directly read from the file without decompression.\r
+\r
+ gzopen returns NULL if the file could not be opened or if there was\r
+ insufficient memory to allocate the (de)compression state; errno\r
+ can be checked to distinguish the two cases (if errno is zero, the\r
+ zlib error is Z_MEM_ERROR). */\r
+\r
+ZEXTERN gzFile ZEXPORT gzdopen OF((int fd, const char *mode));\r
+/*\r
+ gzdopen() associates a gzFile with the file descriptor fd. File\r
+ descriptors are obtained from calls like open, dup, creat, pipe or\r
+ fileno (in the file has been previously opened with fopen).\r
+ The mode parameter is as in gzopen.\r
+ The next call of gzclose on the returned gzFile will also close the\r
+ file descriptor fd, just like fclose(fdopen(fd), mode) closes the file\r
+ descriptor fd. If you want to keep fd open, use gzdopen(dup(fd), mode).\r
+ gzdopen returns NULL if there was insufficient memory to allocate\r
+ the (de)compression state.\r
+*/\r
+\r
+ZEXTERN int ZEXPORT gzsetparams OF((gzFile file, int level, int strategy));\r
+/*\r
+ Dynamically update the compression level or strategy. See the description\r
+ of deflateInit2 for the meaning of these parameters.\r
+ gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not\r
+ opened for writing.\r
+*/\r
+\r
+ZEXTERN int ZEXPORT gzread OF((gzFile file, voidp buf, unsigned len));\r
+/*\r
+ Reads the given number of uncompressed bytes from the compressed file.\r
+ If the input file was not in gzip format, gzread copies the given number\r
+ of bytes into the buffer.\r
+ gzread returns the number of uncompressed bytes actually read (0 for\r
+ end of file, -1 for error). */\r
+\r
+ZEXTERN int ZEXPORT gzwrite OF((gzFile file,\r
+ voidpc buf, unsigned len));\r
+/*\r
+ Writes the given number of uncompressed bytes into the compressed file.\r
+ gzwrite returns the number of uncompressed bytes actually written\r
+ (0 in case of error).\r
+*/\r
+\r
+ZEXTERN int ZEXPORTVA gzprintf OF((gzFile file, const char *format, ...));\r
+/*\r
+ Converts, formats, and writes the args to the compressed file under\r
+ control of the format string, as in fprintf. gzprintf returns the number of\r
+ uncompressed bytes actually written (0 in case of error). The number of\r
+ uncompressed bytes written is limited to 4095. The caller should assure that\r
+ this limit is not exceeded. If it is exceeded, then gzprintf() will return\r
+ return an error (0) with nothing written. In this case, there may also be a\r
+ buffer overflow with unpredictable consequences, which is possible only if\r
+ zlib was compiled with the insecure functions sprintf() or vsprintf()\r
+ because the secure snprintf() or vsnprintf() functions were not available.\r
+*/\r
+\r
+ZEXTERN int ZEXPORT gzputs OF((gzFile file, const char *s));\r
+/*\r
+ Writes the given null-terminated string to the compressed file, excluding\r
+ the terminating null character.\r
+ gzputs returns the number of characters written, or -1 in case of error.\r
+*/\r
+\r
+ZEXTERN char * ZEXPORT gzgets OF((gzFile file, char *buf, int len));\r
+/*\r
+ Reads bytes from the compressed file until len-1 characters are read, or\r
+ a newline character is read and transferred to buf, or an end-of-file\r
+ condition is encountered. The string is then terminated with a null\r
+ character.\r
+ gzgets returns buf, or Z_NULL in case of error.\r
+*/\r
+\r
+ZEXTERN int ZEXPORT gzputc OF((gzFile file, int c));\r
+/*\r
+ Writes c, converted to an unsigned char, into the compressed file.\r
+ gzputc returns the value that was written, or -1 in case of error.\r
+*/\r
+\r
+ZEXTERN int ZEXPORT gzgetc OF((gzFile file));\r
+/*\r
+ Reads one byte from the compressed file. gzgetc returns this byte\r
+ or -1 in case of end of file or error.\r
+*/\r
+\r
+ZEXTERN int ZEXPORT gzungetc OF((int c, gzFile file));\r
+/*\r
+ Push one character back onto the stream to be read again later.\r
+ Only one character of push-back is allowed. gzungetc() returns the\r
+ character pushed, or -1 on failure. gzungetc() will fail if a\r
+ character has been pushed but not read yet, or if c is -1. The pushed\r
+ character will be discarded if the stream is repositioned with gzseek()\r
+ or gzrewind().\r
+*/\r
+\r
+ZEXTERN int ZEXPORT gzflush OF((gzFile file, int flush));\r
+/*\r
+ Flushes all pending output into the compressed file. The parameter\r
+ flush is as in the deflate() function. The return value is the zlib\r
+ error number (see function gzerror below). gzflush returns Z_OK if\r
+ the flush parameter is Z_FINISH and all output could be flushed.\r
+ gzflush should be called only when strictly necessary because it can\r
+ degrade compression.\r
+*/\r
+\r
+ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile file,\r
+ z_off_t offset, int whence));\r
+/*\r
+ Sets the starting position for the next gzread or gzwrite on the\r
+ given compressed file. The offset represents a number of bytes in the\r
+ uncompressed data stream. The whence parameter is defined as in lseek(2);\r
+ the value SEEK_END is not supported.\r
+ If the file is opened for reading, this function is emulated but can be\r
+ extremely slow. If the file is opened for writing, only forward seeks are\r
+ supported; gzseek then compresses a sequence of zeroes up to the new\r
+ starting position.\r
+\r
+ gzseek returns the resulting offset location as measured in bytes from\r
+ the beginning of the uncompressed stream, or -1 in case of error, in\r
+ particular if the file is opened for writing and the new starting position\r
+ would be before the current position.\r
+*/\r
+\r
+ZEXTERN int ZEXPORT gzrewind OF((gzFile file));\r
+/*\r
+ Rewinds the given file. This function is supported only for reading.\r
+\r
+ gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET)\r
+*/\r
+\r
+ZEXTERN z_off_t ZEXPORT gztell OF((gzFile file));\r
+/*\r
+ Returns the starting position for the next gzread or gzwrite on the\r
+ given compressed file. This position represents a number of bytes in the\r
+ uncompressed data stream.\r
+\r
+ gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR)\r
+*/\r
+\r
+ZEXTERN int ZEXPORT gzeof OF((gzFile file));\r
+/*\r
+ Returns 1 when EOF has previously been detected reading the given\r
+ input stream, otherwise zero.\r
+*/\r
+\r
+ZEXTERN int ZEXPORT gzdirect OF((gzFile file));\r
+/*\r
+ Returns 1 if file is being read directly without decompression, otherwise\r
+ zero.\r
+*/\r
+\r
+ZEXTERN int ZEXPORT gzclose OF((gzFile file));\r
+/*\r
+ Flushes all pending output if necessary, closes the compressed file\r
+ and deallocates all the (de)compression state. The return value is the zlib\r
+ error number (see function gzerror below).\r
+*/\r
+\r
+ZEXTERN const char * ZEXPORT gzerror OF((gzFile file, int *errnum));\r
+/*\r
+ Returns the error message for the last error which occurred on the\r
+ given compressed file. errnum is set to zlib error number. If an\r
+ error occurred in the file system and not in the compression library,\r
+ errnum is set to Z_ERRNO and the application may consult errno\r
+ to get the exact error code.\r
+*/\r
+\r
+ZEXTERN void ZEXPORT gzclearerr OF((gzFile file));\r
+/*\r
+ Clears the error and end-of-file flags for file. This is analogous to the\r
+ clearerr() function in stdio. This is useful for continuing to read a gzip\r
+ file that is being written concurrently.\r
+*/\r
+\r
+ /* checksum functions */\r
+\r
+/*\r
+ These functions are not related to compression but are exported\r
+ anyway because they might be useful in applications using the\r
+ compression library.\r
+*/\r
+\r
+ZEXTERN uLong ZEXPORT adler32 OF((uLong adler, const Bytef *buf, uInt len));\r
+/*\r
+ Update a running Adler-32 checksum with the bytes buf[0..len-1] and\r
+ return the updated checksum. If buf is NULL, this function returns\r
+ the required initial value for the checksum.\r
+ An Adler-32 checksum is almost as reliable as a CRC32 but can be computed\r
+ much faster. Usage example:\r
+\r
+ uLong adler = adler32(0L, Z_NULL, 0);\r
+\r
+ while (read_buffer(buffer, length) != EOF) {\r
+ adler = adler32(adler, buffer, length);\r
+ }\r
+ if (adler != original_adler) error();\r
+*/\r
+\r
+ZEXTERN uLong ZEXPORT adler32_combine OF((uLong adler1, uLong adler2,\r
+ z_off_t len2));\r
+/*\r
+ Combine two Adler-32 checksums into one. For two sequences of bytes, seq1\r
+ and seq2 with lengths len1 and len2, Adler-32 checksums were calculated for\r
+ each, adler1 and adler2. adler32_combine() returns the Adler-32 checksum of\r
+ seq1 and seq2 concatenated, requiring only adler1, adler2, and len2.\r
+*/\r
+\r
+ZEXTERN uLong ZEXPORT crc32 OF((uLong crc, const Bytef *buf, uInt len));\r
+/*\r
+ Update a running CRC-32 with the bytes buf[0..len-1] and return the\r
+ updated CRC-32. If buf is NULL, this function returns the required initial\r
+ value for the for the crc. Pre- and post-conditioning (one's complement) is\r
+ performed within this function so it shouldn't be done by the application.\r
+ Usage example:\r
+\r
+ uLong crc = crc32(0L, Z_NULL, 0);\r
+\r
+ while (read_buffer(buffer, length) != EOF) {\r
+ crc = crc32(crc, buffer, length);\r
+ }\r
+ if (crc != original_crc) error();\r
+*/\r
+\r
+ZEXTERN uLong ZEXPORT crc32_combine OF((uLong crc1, uLong crc2, z_off_t len2));\r
+\r
+/*\r
+ Combine two CRC-32 check values into one. For two sequences of bytes,\r
+ seq1 and seq2 with lengths len1 and len2, CRC-32 check values were\r
+ calculated for each, crc1 and crc2. crc32_combine() returns the CRC-32\r
+ check value of seq1 and seq2 concatenated, requiring only crc1, crc2, and\r
+ len2.\r
+*/\r
+\r
+\r
+ /* various hacks, don't look :) */\r
+\r
+/* deflateInit and inflateInit are macros to allow checking the zlib version\r
+ * and the compiler's view of z_stream:\r
+ */\r
+ZEXTERN int ZEXPORT deflateInit_ OF((z_streamp strm, int level,\r
+ const char *version, int stream_size));\r
+ZEXTERN int ZEXPORT inflateInit_ OF((z_streamp strm,\r
+ const char *version, int stream_size));\r
+ZEXTERN int ZEXPORT deflateInit2_ OF((z_streamp strm, int level, int method,\r
+ int windowBits, int memLevel,\r
+ int strategy, const char *version,\r
+ int stream_size));\r
+ZEXTERN int ZEXPORT inflateInit2_ OF((z_streamp strm, int windowBits,\r
+ const char *version, int stream_size));\r
+ZEXTERN int ZEXPORT inflateBackInit_ OF((z_streamp strm, int windowBits,\r
+ unsigned char FAR *window,\r
+ const char *version,\r
+ int stream_size));\r
+#define deflateInit(strm, level) \\r
+ deflateInit_((strm), (level), ZLIB_VERSION, sizeof(z_stream))\r
+#define inflateInit(strm) \\r
+ inflateInit_((strm), ZLIB_VERSION, sizeof(z_stream))\r
+#define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \\r
+ deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\\r
+ (strategy), ZLIB_VERSION, sizeof(z_stream))\r
+#define inflateInit2(strm, windowBits) \\r
+ inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))\r
+#define inflateBackInit(strm, windowBits, window) \\r
+ inflateBackInit_((strm), (windowBits), (window), \\r
+ ZLIB_VERSION, sizeof(z_stream))\r
+\r
+\r
+#if !defined(ZUTIL_H) && !defined(NO_DUMMY_DECL)\r
+ struct internal_state {int dummy;}; /* hack for buggy compilers */\r
+#endif\r
+\r
+ZEXTERN const char * ZEXPORT zError OF((int));\r
+ZEXTERN int ZEXPORT inflateSyncPoint OF((z_streamp z));\r
+ZEXTERN const uLongf * ZEXPORT get_crc_table OF((void));\r
+\r
+#ifdef __cplusplus\r
+}\r
+#endif\r
+\r
+#endif /* ZLIB_H */\r
projects / lab.git / blobdiff