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