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