+++ /dev/null
-/* zlib.h -- interface of the 'zlib' general purpose compression library\r
- version 1.2.8, April 28th, 2013\r
-\r
- Copyright (C) 1995-2013 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://tools.ietf.org/html/rfc1950\r
- (zlib format), rfc1951 (deflate format) and rfc1952 (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.8"\r
-#define ZLIB_VERNUM 0x1280\r
-#define ZLIB_VER_MAJOR 1\r
-#define ZLIB_VER_MINOR 2\r
-#define ZLIB_VER_REVISION 8\r
-#define ZLIB_VER_SUBREVISION 0\r
-\r
-/*\r
- The 'zlib' compression library provides in-memory compression and\r
- decompression functions, including integrity checks of the uncompressed data.\r
- This version of the library supports only one compression method (deflation)\r
- but other algorithms will be added later and will have the same stream\r
- interface.\r
-\r
- Compression can be done in a single step if the buffers are large enough,\r
- or can be done by repeated calls of the compression function. In the latter\r
- case, the 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 crash\r
- 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
- z_const Bytef *next_in; /* next input byte */\r
- uInt avail_in; /* number of bytes available at next_in */\r
- uLong total_in; /* total number 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 number of bytes output so far */\r
-\r
- z_const 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 dropped\r
- to zero. It must update next_out and avail_out when avail_out has dropped\r
- to zero. The application must initialize zalloc, zfree and opaque before\r
- calling the init function. All other fields are set by the compression\r
- 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 if\r
- the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS, pointers\r
- returned by zalloc for objects of exactly 65536 bytes *must* have their\r
- offset normalized to zero. The default allocation function provided by this\r
- library ensures this (see zutil.c). To reduce memory requirements and avoid\r
- any allocation of 64K objects, at the expense of compression ratio, compile\r
- the library with -DMAX_WBITS=14 (see zconf.h).\r
-\r
- The fields total_in and total_out can be used for statistics or progress\r
- reports. After compression, total_in holds the total size of the\r
- uncompressed data and may be saved for use in the decompressor (particularly\r
- if the decompressor wants to decompress everything in a single step).\r
-*/\r
-\r
- /* constants */\r
-\r
-#define Z_NO_FLUSH 0\r
-#define Z_PARTIAL_FLUSH 1\r
-#define Z_SYNC_FLUSH 2\r
-#define Z_FULL_FLUSH 3\r
-#define Z_FINISH 4\r
-#define Z_BLOCK 5\r
-#define Z_TREES 6\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 values\r
- * 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
-\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 not\r
- compatible with the zlib.h header file used by the application. This check\r
- 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. If\r
- zalloc and zfree are set to Z_NULL, deflateInit updates them to use default\r
- 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 all\r
- (the input data is simply copied a block at a time). Z_DEFAULT_COMPRESSION\r
- requests a default compromise between speed and compression (currently\r
- equivalent to level 6).\r
-\r
- deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough\r
- memory, Z_STREAM_ERROR if level is not a valid compression level, or\r
- Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible\r
- with the version assumed by the caller (ZLIB_VERSION). msg is set to null\r
- if there is no error message. deflateInit does not perform any compression:\r
- 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\r
- some 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). Some\r
- 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 more\r
- output, and updating avail_in or avail_out accordingly; avail_out should\r
- never be zero before the call. The application can consume the compressed\r
- output when it wants, for example when the output buffer is full (avail_out\r
- == 0), or after each call of deflate(). If deflate returns Z_OK and with\r
- zero avail_out, it must be called again after making room in the output\r
- 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 accumulate 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\r
- particular avail_in is zero after the call if enough output space has been\r
- provided before the call.) Flushing may degrade compression for some\r
- compression algorithms and so it should be used only when necessary. This\r
- completes the current deflate block and follows it with an empty stored block\r
- that is three bits plus filler bits to the next byte, followed by four bytes\r
- (00 00 ff ff).\r
-\r
- If flush is set to Z_PARTIAL_FLUSH, all pending output is flushed to the\r
- output buffer, but the output is not aligned to a byte boundary. All of the\r
- input data so far will be available to the decompressor, as for Z_SYNC_FLUSH.\r
- This completes the current deflate block and follows it with an empty fixed\r
- codes block that is 10 bits long. This assures that enough bytes are output\r
- in order for the decompressor to finish the block before the empty fixed code\r
- block.\r
-\r
- If flush is set to Z_BLOCK, a deflate block is completed and emitted, as\r
- for Z_SYNC_FLUSH, but the output is not aligned on a byte boundary, and up to\r
- seven bits of the current block are held to be written as the next byte after\r
- the next deflate block is completed. In this case, the decompressor may not\r
- be provided enough bits at this point in order to complete decompression of\r
- the data provided so far to the compressor. It may need to wait for the next\r
- block to be emitted. This is for advanced applications that need to control\r
- the emission of deflate blocks.\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 was\r
- 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 stream\r
- 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 the\r
- value returned by deflateBound (see below). Then deflate is guaranteed to\r
- return Z_STREAM_END. If not enough output space is provided, deflate will\r
- not return Z_STREAM_END, and 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 the\r
- 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 Z_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 pending\r
- 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, msg\r
- 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\r
- exact 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, or Z_STREAM_ERROR if the parameters are\r
- invalid, such as a null pointer to the structure. msg is set to null if\r
- there is no error message. inflateInit does not perform any decompression\r
- apart from possibly reading the zlib header if present: actual decompression\r
- will be done by inflate(). (So next_in and avail_in may be modified, but\r
- next_out and avail_out are unused and unchanged.) The current implementation\r
- of inflateInit() does not process any header information -- that is deferred\r
- until inflate() is called.\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 will\r
- 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 is\r
- no more input data or no more space in the output buffer (see below about\r
- 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 more\r
- output, and updating the next_* and avail_* values accordingly. The\r
- application can consume the uncompressed output when it wants, for example\r
- when the output buffer is full (avail_out == 0), or after each call of\r
- inflate(). If inflate returns Z_OK and with zero avail_out, it must be\r
- called again after making room in the output buffer because there might be\r
- more output pending.\r
-\r
- The flush parameter of inflate() can be Z_NO_FLUSH, Z_SYNC_FLUSH, Z_FINISH,\r
- Z_BLOCK, or Z_TREES. Z_SYNC_FLUSH requests that inflate() flush as much\r
- output as possible to the output buffer. Z_BLOCK requests that inflate()\r
- stop if and when it gets to the next deflate block boundary. When decoding\r
- the zlib or gzip format, this will cause inflate() to return immediately\r
- after the header and before the first block. When doing a raw inflate,\r
- inflate() will go ahead and process the first block, and will return when it\r
- gets to 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 if\r
- inflate() is currently decoding the last block in the deflate stream, plus\r
- 128 if inflate() returned immediately after decoding an end-of-block code or\r
- decoding the complete header up to just before the first byte of the deflate\r
- stream. The end-of-block will not be indicated until all of the uncompressed\r
- data from that block has been written to strm->next_out. The number of\r
- unused bits may in general be greater than seven, except when bit 7 of\r
- data_type is set, in which case the number of unused bits will be less than\r
- eight. data_type is set as noted here every time inflate() returns for all\r
- flush options, and so can be used to determine the amount of currently\r
- consumed input in bits.\r
-\r
- The Z_TREES option behaves as Z_BLOCK does, but it also returns when the\r
- end of each deflate block header is reached, before any actual data in that\r
- block is decoded. This allows the caller to determine the length of the\r
- deflate block header for later use in random access within a deflate block.\r
- 256 is added to the value of strm->data_type when inflate() returns\r
- immediately after reaching the end of the deflate block header.\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 (a\r
- single call of inflate), the parameter flush should be set to Z_FINISH. In\r
- this case all pending input is processed and all pending output is flushed;\r
- avail_out must be large enough to hold all of the uncompressed data for the\r
- operation to complete. (The size of the uncompressed data may have been\r
- saved by the compressor for this purpose.) The use of Z_FINISH is not\r
- required to perform an inflation in one step. However it may be used to\r
- inform inflate that a faster approach can be used for the single inflate()\r
- call. Z_FINISH also informs inflate to not maintain a sliding window if the\r
- stream completes, which reduces inflate's memory footprint. If the stream\r
- does not complete, either because not all of the stream is provided or not\r
- enough output space is provided, then a sliding window will be allocated and\r
- inflate() can be called again to continue the operation as if Z_NO_FLUSH had\r
- been used.\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 effects of the flush parameter in this implementation are\r
- on the return value of inflate() as noted below, when inflate() returns early\r
- when Z_BLOCK or Z_TREES is used, and when inflate() avoids the allocation of\r
- memory for a sliding window when Z_FINISH is used.\r
-\r
- If a preset dictionary is needed after this call (see inflateSetDictionary\r
- below), inflate sets strm->adler to the Adler-32 checksum of the dictionary\r
- chosen by the compressor and returns Z_NEED_DICT; otherwise it sets\r
- strm->adler to the Adler-32 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() can decompress and check either zlib-wrapped or gzip-wrapped\r
- deflate data. The header type is detected automatically, if requested when\r
- initializing with inflateInit2(). Any information contained in the gzip\r
- header is not retained, so applications that need that information should\r
- instead use raw inflate, see inflateInit2() below, or inflateBack() and\r
- perform their own processing of the gzip header and trailer. When processing\r
- gzip-wrapped deflate data, strm->adler32 is set to the CRC-32 of the output\r
- producted so far. The CRC-32 is checked against the gzip 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
- next_in or next_out was Z_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\r
- then call inflateSync() to look for a good compression block if a partial\r
- recovery 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 pending\r
- 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
-\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 the\r
- 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), no\r
- 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 is\r
- slow and reduces compression ratio; memLevel=9 uses maximum memory for\r
- optimal speed. The default value is 8. See zconf.h for total memory usage\r
- 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_STRATEGY and Z_HUFFMAN_ONLY. Z_RLE is designed to be almost as\r
- fast as Z_HUFFMAN_ONLY, but give better compression for PNG image data. The\r
- strategy parameter only affects the compression ratio but not the\r
- correctness of the compressed output even if it is not set appropriately.\r
- Z_FIXED prevents the use of dynamic Huffman codes, allowing for a simpler\r
- decoder for special applications.\r
-\r
- deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough\r
- memory, Z_STREAM_ERROR if any parameter is invalid (such as an invalid\r
- method), or Z_VERSION_ERROR if the zlib library version (zlib_version) is\r
- incompatible with the version assumed by the caller (ZLIB_VERSION). msg is\r
- set to null if there is no error message. deflateInit2 does not perform any\r
- 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. When using the zlib format, this\r
- function must be called immediately after deflateInit, deflateInit2 or\r
- deflateReset, and before any call of deflate. When doing raw deflate, this\r
- function must be called either before any call of deflate, or immediately\r
- after the completion of a deflate block, i.e. after all input has been\r
- consumed and all output has been delivered when using any of the flush\r
- options Z_BLOCK, Z_PARTIAL_FLUSH, Z_SYNC_FLUSH, or Z_FULL_FLUSH. The\r
- compressor and decompressor must use exactly the same dictionary (see\r
- 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\r
- provided in deflateInit or deflateInit2. Thus the strings most likely to be\r
- useful should be put at the end of the dictionary, not at the front. In\r
- addition, the current implementation of deflate will use at most the window\r
- size minus 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 (e.g. dictionary being Z_NULL) or the stream state is\r
- inconsistent (for example if deflate has already been called for this stream\r
- or if not at a block boundary for raw deflate). deflateSetDictionary does\r
- not 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 can\r
- 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 Z_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. The\r
- stream will keep the same compression level and any other attributes that\r
- 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 Z_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 strategy.\r
- If the compression level is changed, the input available so far is\r
- compressed with the old level (and may be flushed); the new level will take\r
- 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 be\r
- 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 if\r
- 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() or\r
- deflateInit2(), and after deflateSetHeader(), if used. This would be used\r
- to allocate an output buffer for deflation in a single pass, and so would be\r
- called before deflate(). If that first deflate() call is provided the\r
- sourceLen input bytes, an output buffer allocated to the size returned by\r
- deflateBound(), and the flush value Z_FINISH, then deflate() is guaranteed\r
- to return Z_STREAM_END. Note that it is possible for the compressed size to\r
- be larger than the value returned by deflateBound() if flush options other\r
- than Z_FINISH or Z_NO_FLUSH are used.\r
-*/\r
-\r
-ZEXTERN int ZEXPORT deflatePending OF((z_streamp strm,\r
- unsigned *pending,\r
- int *bits));\r
-/*\r
- deflatePending() returns the number of bytes and bits of output that have\r
- been generated, but not yet provided in the available output. The bytes not\r
- provided would be due to the available output space having being consumed.\r
- The number of bits of output not provided are between 0 and 7, where they\r
- await more bits to join them in order to fill out a full byte. If pending\r
- or bits are Z_NULL, then those values are not set.\r
-\r
- deflatePending returns Z_OK if success, or Z_STREAM_ERROR if the source\r
- stream state was inconsistent.\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 bits\r
- leftover from a previous deflate stream when appending to it. As such, this\r
- function can only be used for raw deflate, and must be used before the first\r
- deflate() call after a deflateInit2() or deflateReset(). bits must be less\r
- than or equal to 16, and that many of the least significant bits of value\r
- will be inserted in the output.\r
-\r
- deflatePrime returns Z_OK if success, Z_BUF_ERROR if there was not enough\r
- room in the internal buffer to insert the bits, or Z_STREAM_ERROR if the\r
- source 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 zero to request that inflate use the window size in\r
- the zlib header of the compressed stream.\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 a\r
- crc32 instead of an adler32.\r
-\r
- inflateInit2 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, or Z_STREAM_ERROR if the parameters are\r
- invalid, such as a null pointer to the structure. msg is set to null if\r
- there is no error message. inflateInit2 does not perform any decompression\r
- apart from possibly reading the zlib header if present: actual decompression\r
- will be done by inflate(). (So next_in and avail_in may be modified, but\r
- next_out and avail_out are unused and unchanged.) The current implementation\r
- of inflateInit2() does not process any header information -- that is\r
- deferred until inflate() is called.\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 at any\r
- time to set the dictionary. If the provided dictionary is smaller than the\r
- window and there is already data in the window, then the provided dictionary\r
- will amend what's there. The application must insure that the dictionary\r
- that was used for compression is provided.\r
-\r
- inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a\r
- parameter is invalid (e.g. dictionary being Z_NULL) 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 inflateGetDictionary OF((z_streamp strm,\r
- Bytef *dictionary,\r
- uInt *dictLength));\r
-/*\r
- Returns the sliding dictionary being maintained by inflate. dictLength is\r
- set to the number of bytes in the dictionary, and that many bytes are copied\r
- to dictionary. dictionary must have enough space, where 32768 bytes is\r
- always enough. If inflateGetDictionary() is called with dictionary equal to\r
- Z_NULL, then only the dictionary length is returned, and nothing is copied.\r
- Similary, if dictLength is Z_NULL, then it is not set.\r
-\r
- inflateGetDictionary returns Z_OK on success, or Z_STREAM_ERROR if the\r
- stream state is inconsistent.\r
-*/\r
-\r
-ZEXTERN int ZEXPORT inflateSync OF((z_streamp strm));\r
-/*\r
- Skips invalid compressed data until a possible full flush point (see above\r
- for the 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 searches for a 00 00 FF FF pattern in the compressed data.\r
- All full flush points have this pattern, but not all occurrences of this\r
- pattern are full flush points.\r
-\r
- inflateSync returns Z_OK if a possible full flush point has been found,\r
- Z_BUF_ERROR if no more input was provided, Z_DATA_ERROR if no flush point\r
- has been found, or Z_STREAM_ERROR if the stream structure was inconsistent.\r
- In the success case, the application may save the current current value of\r
- total_in which indicates where valid compressed data was found. In the\r
- error case, the application may repeatedly call inflateSync, providing more\r
- input each time, 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 Z_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. The\r
- 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 Z_NULL).\r
-*/\r
-\r
-ZEXTERN int ZEXPORT inflateReset2 OF((z_streamp strm,\r
- int windowBits));\r
-/*\r
- This function is the same as inflateReset, but it also permits changing\r
- the wrap and window size requests. The windowBits parameter is interpreted\r
- the same as it is for inflateInit2.\r
-\r
- inflateReset2 returns Z_OK if success, or Z_STREAM_ERROR if the source\r
- stream state was inconsistent (such as zalloc or state being Z_NULL), or if\r
- the windowBits parameter is invalid.\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
- If bits is negative, then the input stream bit buffer is emptied. Then\r
- inflatePrime() can be called again to put bits in the buffer. This is used\r
- to clear out bits leftover after feeding inflate a block description prior\r
- to feeding inflate codes.\r
-\r
- inflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source\r
- stream state was inconsistent.\r
-*/\r
-\r
-ZEXTERN long ZEXPORT inflateMark OF((z_streamp strm));\r
-/*\r
- This function returns two values, one in the lower 16 bits of the return\r
- value, and the other in the remaining upper bits, obtained by shifting the\r
- return value down 16 bits. If the upper value is -1 and the lower value is\r
- zero, then inflate() is currently decoding information outside of a block.\r
- If the upper value is -1 and the lower value is non-zero, then inflate is in\r
- the middle of a stored block, with the lower value equaling the number of\r
- bytes from the input remaining to copy. If the upper value is not -1, then\r
- it is the number of bits back from the current bit position in the input of\r
- the code (literal or length/distance pair) currently being processed. In\r
- that case the lower value is the number of bytes already emitted for that\r
- code.\r
-\r
- A code is being processed if inflate is waiting for more input to complete\r
- decoding of the code, or if it has completed decoding but is waiting for\r
- more output space to write the literal or match data.\r
-\r
- inflateMark() is used to mark locations in the input data for random\r
- access, which may be at bit positions, and to note those cases where the\r
- output of a code may span boundaries of random access blocks. The current\r
- location in the input stream can be determined from avail_in and data_type\r
- as noted in the description for the Z_BLOCK flush parameter for inflate.\r
-\r
- inflateMark returns the value noted above or -1 << 16 if the provided\r
- source 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 or Z_TREES can be\r
- used to force inflate() to return immediately after header processing is\r
- complete 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 any\r
- of extra, name, or comment are not Z_NULL and the respective field is not\r
- 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 parameters are invalid, Z_MEM_ERROR if the internal state could not be\r
- allocated, or Z_VERSION_ERROR if the version of the library does not match\r
- the version of the header file.\r
-*/\r
-\r
-typedef unsigned (*in_func) OF((void FAR *,\r
- z_const 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 potentially more efficient than\r
- inflate() for file i/o applications, in that it avoids copying between the\r
- output and the sliding window by simply making the window itself the output\r
- buffer. inflate() can be faster on modern CPUs when used with large\r
- buffers. inflateBack() trusts the application to not change the output\r
- buffer passed by 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 the\r
- 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 only\r
- the raw deflate stream to decompress. This is different from the normal\r
- 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 error\r
- in the deflate stream (in which case strm->msg is set to indicate the nature\r
- of the error), or Z_STREAM_ERROR if the stream was not properly initialized.\r
- In the case of Z_BUF_ERROR, an input or output error can be distinguished\r
- using strm->next_in which will be Z_NULL only if in() returned an error. If\r
- strm->next_in is not Z_NULL, then the Z_BUF_ERROR was due to out() returning\r
- non-zero. (in() will always be called before out(), so strm->next_in is\r
- assured to be defined if out() returns non-zero.) Note that inflateBack()\r
- 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
-#ifndef Z_SOLO\r
-\r
- /* utility functions */\r
-\r
-/*\r
- The following utility functions are implemented on top of the basic\r
- stream-oriented functions. To simplify the interface, some default options\r
- are assumed (compression level and memory usage, standard memory allocation\r
- functions). The source code of these utility functions can be modified if\r
- 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 size\r
- of the 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
- 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 a\r
- 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 size\r
- of the destination buffer, which must be large enough to hold the entire\r
- uncompressed data. (The size of the uncompressed data must have been saved\r
- previously by the compressor and transmitted to the decompressor by some\r
- mechanism outside the scope of this compression library.) Upon exit, destLen\r
- is the actual size of the uncompressed buffer.\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. In\r
- the case where there is not enough room, uncompress() will fill the output\r
- buffer with the uncompressed data up to that point.\r
-*/\r
-\r
- /* gzip file access functions */\r
-\r
-/*\r
- This library supports reading and writing files in gzip (.gz) format with\r
- an interface similar to that of stdio, using the functions that start with\r
- "gz". The gzip format is different from the zlib format. gzip is a gzip\r
- wrapper, documented in RFC 1952, wrapped around a deflate stream.\r
-*/\r
-\r
-typedef struct gzFile_s *gzFile; /* semi-opaque gzip file descriptor */\r
-\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 is as\r
- in fopen ("rb" or "wb") but can also include a compression level ("wb9") or\r
- a strategy: 'f' for filtered data as in "wb6f", 'h' for Huffman-only\r
- compression as in "wb1h", 'R' for run-length encoding as in "wb1R", or 'F'\r
- for fixed code compression as in "wb9F". (See the description of\r
- deflateInit2 for more information about the strategy parameter.) 'T' will\r
- request transparent writing or appending with no compression and not using\r
- the gzip format.\r
-\r
- "a" can be used instead of "w" to request that the gzip stream that will\r
- be written be appended to the file. "+" will result in an error, since\r
- reading and writing to the same gzip file is not supported. The addition of\r
- "x" when writing will create the file exclusively, which fails if the file\r
- already exists. On systems that support it, the addition of "e" when\r
- reading or writing will set the flag to close the file on an execve() call.\r
-\r
- These functions, as well as gzip, will read and decode a sequence of gzip\r
- streams in a file. The append function of gzopen() can be used to create\r
- such a file. (Also see gzflush() for another way to do this.) When\r
- appending, gzopen does not test whether the file begins with a gzip stream,\r
- nor does it look for the end of the gzip streams to begin appending. gzopen\r
- will simply append a gzip stream to the existing file.\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. When\r
- reading, this will be detected automatically by looking for the magic two-\r
- byte gzip header.\r
-\r
- gzopen returns NULL if the file could not be opened, if there was\r
- insufficient memory to allocate the gzFile state, or if an invalid mode was\r
- specified (an 'r', 'w', or 'a' was not provided, or '+' was provided).\r
- errno can be checked to determine if the reason gzopen failed was that the\r
- file could not be opened.\r
-*/\r
-\r
-ZEXTERN gzFile ZEXPORT gzdopen OF((int fd, const char *mode));\r
-/*\r
- gzdopen associates a gzFile with the file descriptor fd. File descriptors\r
- are obtained from calls like open, dup, creat, pipe or fileno (if the file\r
- has been previously opened with fopen). The mode parameter is as in gzopen.\r
-\r
- The next call of gzclose on the returned gzFile will also close the file\r
- descriptor fd, just like fclose(fdopen(fd, mode)) closes the file descriptor\r
- fd. If you want to keep fd open, use fd = dup(fd_keep); gz = gzdopen(fd,\r
- mode);. The duplicated descriptor should be saved to avoid a leak, since\r
- gzdopen does not close fd if it fails. If you are using fileno() to get the\r
- file descriptor from a FILE *, then you will have to use dup() to avoid\r
- double-close()ing the file descriptor. Both gzclose() and fclose() will\r
- close the associated file descriptor, so they need to have different file\r
- descriptors.\r
-\r
- gzdopen returns NULL if there was insufficient memory to allocate the\r
- gzFile state, if an invalid mode was specified (an 'r', 'w', or 'a' was not\r
- provided, or '+' was provided), or if fd is -1. The file descriptor is not\r
- used until the next gz* read, write, seek, or close operation, so gzdopen\r
- will not detect if fd is invalid (unless fd is -1).\r
-*/\r
-\r
-ZEXTERN int ZEXPORT gzbuffer OF((gzFile file, unsigned size));\r
-/*\r
- Set the internal buffer size used by this library's functions. The\r
- default buffer size is 8192 bytes. This function must be called after\r
- gzopen() or gzdopen(), and before any other calls that read or write the\r
- file. The buffer memory allocation is always deferred to the first read or\r
- write. Two buffers are allocated, either both of the specified size when\r
- writing, or one of the specified size and the other twice that size when\r
- reading. A larger buffer size of, for example, 64K or 128K bytes will\r
- noticeably increase the speed of decompression (reading).\r
-\r
- The new buffer size also affects the maximum length for gzprintf().\r
-\r
- gzbuffer() returns 0 on success, or -1 on failure, such as being called\r
- too late.\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
-\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. If\r
- the input file is not in gzip format, gzread copies the given number of\r
- bytes into the buffer directly from the file.\r
-\r
- After reaching the end of a gzip stream in the input, gzread will continue\r
- to read, looking for another gzip stream. Any number of gzip streams may be\r
- concatenated in the input file, and will all be decompressed by gzread().\r
- If something other than a gzip stream is encountered after a gzip stream,\r
- that remaining trailing garbage is ignored (and no error is returned).\r
-\r
- gzread can be used to read a gzip file that is being concurrently written.\r
- Upon reaching the end of the input, gzread will return with the available\r
- data. If the error code returned by gzerror is Z_OK or Z_BUF_ERROR, then\r
- gzclearerr can be used to clear the end of file indicator in order to permit\r
- gzread to be tried again. Z_OK indicates that a gzip stream was completed\r
- on the last gzread. Z_BUF_ERROR indicates that the input file ended in the\r
- middle of a gzip stream. Note that gzread does not return -1 in the event\r
- of an incomplete gzip stream. This error is deferred until gzclose(), which\r
- will return Z_BUF_ERROR if the last gzread ended in the middle of a gzip\r
- stream. Alternatively, gzerror can be used before gzclose to detect this\r
- case.\r
-\r
- gzread returns the number of uncompressed bytes actually read, less than\r
- len for end of file, or -1 for error.\r
-*/\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 written or 0 in case of\r
- error.\r
-*/\r
-\r
-ZEXTERN int ZEXPORTVA gzprintf Z_ARG((gzFile file, const char *format, ...));\r
-/*\r
- Converts, formats, and writes the arguments to the compressed file under\r
- control of the format string, as in fprintf. gzprintf returns the number of\r
- uncompressed bytes actually written, or 0 in case of error. The number of\r
- uncompressed bytes written is limited to 8191, or one less than the buffer\r
- size given to gzbuffer(). The caller should assure that this limit is not\r
- exceeded. If it is exceeded, then gzprintf() will return an error (0) with\r
- nothing written. In this case, there may also be a buffer overflow with\r
- unpredictable consequences, which is possible only if zlib was compiled with\r
- the insecure functions sprintf() or vsprintf() because the secure snprintf()\r
- or vsnprintf() functions were not available. This can be determined using\r
- zlibCompileFlags().\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
-\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 a\r
- newline character is read and transferred to buf, or an end-of-file\r
- condition is encountered. If any characters are read or if len == 1, the\r
- string is terminated with a null character. If no characters are read due\r
- to an end-of-file or len < 1, then the buffer is left untouched.\r
-\r
- gzgets returns buf which is a null-terminated string, or it returns NULL\r
- for end-of-file or in case of error. If there was an error, the contents at\r
- buf are indeterminate.\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. gzputc\r
- 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 or -1\r
- in case of end of file or error. This is implemented as a macro for speed.\r
- As such, it does not do all of the checking the other functions do. I.e.\r
- it does not check to see if file is NULL, nor whether the structure file\r
- points to has been clobbered or not.\r
-*/\r
-\r
-ZEXTERN int ZEXPORT gzungetc OF((int c, gzFile file));\r
-/*\r
- Push one character back onto the stream to be read as the first character\r
- on the next read. At least one character of push-back is allowed.\r
- gzungetc() returns the character pushed, or -1 on failure. gzungetc() will\r
- fail if c is -1, and may fail if a character has been pushed but not read\r
- yet. If gzungetc is used immediately after gzopen or gzdopen, at least the\r
- output buffer size of pushed characters is allowed. (See gzbuffer above.)\r
- The pushed character will be discarded if the stream is repositioned with\r
- gzseek() 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 flush\r
- is as in the deflate() function. The return value is the zlib error number\r
- (see function gzerror below). gzflush is only permitted when writing.\r
-\r
- If the flush parameter is Z_FINISH, the remaining data is written and the\r
- gzip stream is completed in the output. If gzwrite() is called again, a new\r
- gzip stream will be started in the output. gzread() is able to read such\r
- concatented gzip streams.\r
-\r
- gzflush should be called only when strictly necessary because it will\r
- degrade compression if called too often.\r
-*/\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 given\r
- 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
-\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
-/*\r
-ZEXTERN z_off_t ZEXPORT gztell OF((gzFile file));\r
-\r
- Returns the starting position for the next gzread or gzwrite on the given\r
- compressed file. This position represents a number of bytes in the\r
- uncompressed data stream, and is zero when starting, even if appending or\r
- reading a gzip stream from the middle of a file using gzdopen().\r
-\r
- gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR)\r
-*/\r
-\r
-/*\r
-ZEXTERN z_off_t ZEXPORT gzoffset OF((gzFile file));\r
-\r
- Returns the current offset in the file being read or written. This offset\r
- includes the count of bytes that precede the gzip stream, for example when\r
- appending or when using gzdopen() for reading. When reading, the offset\r
- does not include as yet unused buffered input. This information can be used\r
- for a progress indicator. On error, gzoffset() returns -1.\r
-*/\r
-\r
-ZEXTERN int ZEXPORT gzeof OF((gzFile file));\r
-/*\r
- Returns true (1) if the end-of-file indicator has been set while reading,\r
- false (0) otherwise. Note that the end-of-file indicator is set only if the\r
- read tried to go past the end of the input, but came up short. Therefore,\r
- just like feof(), gzeof() may return false even if there is no more data to\r
- read, in the event that the last read request was for the exact number of\r
- bytes remaining in the input file. This will happen if the input file size\r
- is an exact multiple of the buffer size.\r
-\r
- If gzeof() returns true, then the read functions will return no more data,\r
- unless the end-of-file indicator is reset by gzclearerr() and the input file\r
- has grown since the previous end of file was detected.\r
-*/\r
-\r
-ZEXTERN int ZEXPORT gzdirect OF((gzFile file));\r
-/*\r
- Returns true (1) if file is being copied directly while reading, or false\r
- (0) if file is a gzip stream being decompressed.\r
-\r
- If the input file is empty, gzdirect() will return true, since the input\r
- does not contain a gzip stream.\r
-\r
- If gzdirect() is used immediately after gzopen() or gzdopen() it will\r
- cause buffers to be allocated to allow reading the file to determine if it\r
- is a gzip file. Therefore if gzbuffer() is used, it should be called before\r
- gzdirect().\r
-\r
- When writing, gzdirect() returns true (1) if transparent writing was\r
- requested ("wT" for the gzopen() mode), or false (0) otherwise. (Note:\r
- gzdirect() is not needed when writing. Transparent writing must be\r
- explicitly requested, so the application already knows the answer. When\r
- linking statically, using gzdirect() will include all of the zlib code for\r
- gzip file reading and decompression, which may not be desired.)\r
-*/\r
-\r
-ZEXTERN int ZEXPORT gzclose OF((gzFile file));\r
-/*\r
- Flushes all pending output if necessary, closes the compressed file and\r
- deallocates the (de)compression state. Note that once file is closed, you\r
- cannot call gzerror with file, since its structures have been deallocated.\r
- gzclose must not be called more than once on the same file, just as free\r
- must not be called more than once on the same allocation.\r
-\r
- gzclose will return Z_STREAM_ERROR if file is not valid, Z_ERRNO on a\r
- file operation error, Z_MEM_ERROR if out of memory, Z_BUF_ERROR if the\r
- last read ended in the middle of a gzip stream, or Z_OK on success.\r
-*/\r
-\r
-ZEXTERN int ZEXPORT gzclose_r OF((gzFile file));\r
-ZEXTERN int ZEXPORT gzclose_w OF((gzFile file));\r
-/*\r
- Same as gzclose(), but gzclose_r() is only for use when reading, and\r
- gzclose_w() is only for use when writing or appending. The advantage to\r
- using these instead of gzclose() is that they avoid linking in zlib\r
- compression or decompression code that is not used when only reading or only\r
- writing respectively. If gzclose() is used, then both compression and\r
- decompression code will be included the application when linking to a static\r
- zlib library.\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 given\r
- compressed file. errnum is set to zlib error number. If an error occurred\r
- in the file system and not in the compression library, errnum is set to\r
- Z_ERRNO and the application may consult errno to get the exact error code.\r
-\r
- The application must not modify the returned string. Future calls to\r
- this function may invalidate the previously returned string. If file is\r
- closed, then the string previously returned by gzerror will no longer be\r
- available.\r
-\r
- gzerror() should be used to distinguish errors from end-of-file for those\r
- functions above that do not distinguish those cases in their return values.\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
-#endif /* !Z_SOLO */\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 compression\r
- 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 Z_NULL, this function returns the\r
- required initial value for the checksum.\r
-\r
- An Adler-32 checksum is almost as reliable as a CRC32 but can be computed\r
- much faster.\r
-\r
- 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
-/*\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. Note\r
- that the z_off_t type (like off_t) is a signed integer. If len2 is\r
- negative, the result has no meaning or utility.\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 Z_NULL, this function returns the required\r
- initial value 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
-\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
-/*\r
-ZEXTERN uLong ZEXPORT crc32_combine OF((uLong crc1, uLong crc2, z_off_t len2));\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, (int)sizeof(z_stream))\r
-#define inflateInit(strm) \\r
- inflateInit_((strm), ZLIB_VERSION, (int)sizeof(z_stream))\r
-#define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \\r
- deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\\r
- (strategy), ZLIB_VERSION, (int)sizeof(z_stream))\r
-#define inflateInit2(strm, windowBits) \\r
- inflateInit2_((strm), (windowBits), ZLIB_VERSION, \\r
- (int)sizeof(z_stream))\r
-#define inflateBackInit(strm, windowBits, window) \\r
- inflateBackInit_((strm), (windowBits), (window), \\r
- ZLIB_VERSION, (int)sizeof(z_stream))\r
-\r
-#ifndef Z_SOLO\r
-\r
-/* gzgetc() macro and its supporting function and exposed data structure. Note\r
- * that the real internal state is much larger than the exposed structure.\r
- * This abbreviated structure exposes just enough for the gzgetc() macro. The\r
- * user should not mess with these exposed elements, since their names or\r
- * behavior could change in the future, perhaps even capriciously. They can\r
- * only be used by the gzgetc() macro. You have been warned.\r
- */\r
-struct gzFile_s {\r
- unsigned have;\r
- unsigned char *next;\r
- z_off64_t pos;\r
-};\r
-ZEXTERN int ZEXPORT gzgetc_ OF((gzFile file)); /* backward compatibility */\r
-#ifdef Z_PREFIX_SET\r
-# undef z_gzgetc\r
-# define z_gzgetc(g) \\r
- ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g))\r
-#else\r
-# define gzgetc(g) \\r
- ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g))\r
-#endif\r
-\r
-/* provide 64-bit offset functions if _LARGEFILE64_SOURCE defined, and/or\r
- * change the regular functions to 64 bits if _FILE_OFFSET_BITS is 64 (if\r
- * both are true, the application gets the *64 functions, and the regular\r
- * functions are changed to 64 bits) -- in case these are set on systems\r
- * without large file support, _LFS64_LARGEFILE must also be true\r
- */\r
-#ifdef Z_LARGE64\r
- ZEXTERN gzFile ZEXPORT gzopen64 OF((const char *, const char *));\r
- ZEXTERN z_off64_t ZEXPORT gzseek64 OF((gzFile, z_off64_t, int));\r
- ZEXTERN z_off64_t ZEXPORT gztell64 OF((gzFile));\r
- ZEXTERN z_off64_t ZEXPORT gzoffset64 OF((gzFile));\r
- ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, z_off64_t));\r
- ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, z_off64_t));\r
-#endif\r
-\r
-#if !defined(ZLIB_INTERNAL) && defined(Z_WANT64)\r
-# ifdef Z_PREFIX_SET\r
-# define z_gzopen z_gzopen64\r
-# define z_gzseek z_gzseek64\r
-# define z_gztell z_gztell64\r
-# define z_gzoffset z_gzoffset64\r
-# define z_adler32_combine z_adler32_combine64\r
-# define z_crc32_combine z_crc32_combine64\r
-# else\r
-# define gzopen gzopen64\r
-# define gzseek gzseek64\r
-# define gztell gztell64\r
-# define gzoffset gzoffset64\r
-# define adler32_combine adler32_combine64\r
-# define crc32_combine crc32_combine64\r
-# endif\r
-# ifndef Z_LARGE64\r
- ZEXTERN gzFile ZEXPORT gzopen64 OF((const char *, const char *));\r
- ZEXTERN z_off_t ZEXPORT gzseek64 OF((gzFile, z_off_t, int));\r
- ZEXTERN z_off_t ZEXPORT gztell64 OF((gzFile));\r
- ZEXTERN z_off_t ZEXPORT gzoffset64 OF((gzFile));\r
- ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, z_off_t));\r
- ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, z_off_t));\r
-# endif\r
-#else\r
- ZEXTERN gzFile ZEXPORT gzopen OF((const char *, const char *));\r
- ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile, z_off_t, int));\r
- ZEXTERN z_off_t ZEXPORT gztell OF((gzFile));\r
- ZEXTERN z_off_t ZEXPORT gzoffset OF((gzFile));\r
- ZEXTERN uLong ZEXPORT adler32_combine OF((uLong, uLong, z_off_t));\r
- ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t));\r
-#endif\r
-\r
-#else /* Z_SOLO */\r
-\r
- ZEXTERN uLong ZEXPORT adler32_combine OF((uLong, uLong, z_off_t));\r
- ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t));\r
-\r
-#endif /* !Z_SOLO */\r
-\r
-/* hack for buggy compilers */\r
-#if !defined(ZUTIL_H) && !defined(NO_DUMMY_DECL)\r
- struct internal_state {int dummy;};\r
-#endif\r
-\r
-/* undocumented functions */\r
-ZEXTERN const char * ZEXPORT zError OF((int));\r
-ZEXTERN int ZEXPORT inflateSyncPoint OF((z_streamp));\r
-ZEXTERN const z_crc_t FAR * ZEXPORT get_crc_table OF((void));\r
-ZEXTERN int ZEXPORT inflateUndermine OF((z_streamp, int));\r
-ZEXTERN int ZEXPORT inflateResetKeep OF((z_streamp));\r
-ZEXTERN int ZEXPORT deflateResetKeep OF((z_streamp));\r
-#if defined(_WIN32) && !defined(Z_SOLO)\r
-ZEXTERN gzFile ZEXPORT gzopen_w OF((const wchar_t *path,\r
- const char *mode));\r
-#endif\r
-#if defined(STDC) || defined(Z_HAVE_STDARG_H)\r
-# ifndef Z_SOLO\r
-ZEXTERN int ZEXPORTVA gzvprintf Z_ARG((gzFile file,\r
- const char *format,\r
- va_list va));\r
-# endif\r
-#endif\r
-\r
-#ifdef __cplusplus\r
-}\r
-#endif\r
-\r
-#endif /* ZLIB_H */\r
projects / mirror_edk2.git / blobdiff