117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* zlib.h -- interface of the 'zlib' general purpose compression library 217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner version 1.2.8, April 28th, 2013 317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler 517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner This software is provided 'as-is', without any express or implied 717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner warranty. In no event will the authors be held liable for any damages 817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner arising from the use of this software. 917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 1017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Permission is granted to anyone to use this software for any purpose, 1117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner including commercial applications, and to alter it and redistribute it 1217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner freely, subject to the following restrictions: 1317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 1417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 1. The origin of this software must not be misrepresented; you must not 1517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner claim that you wrote the original software. If you use this software 1617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner in a product, an acknowledgment in the product documentation would be 1717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner appreciated but is not required. 1817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 2. Altered source versions must be plainly marked as such, and must not be 1917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner misrepresented as being the original software. 2017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 3. This notice may not be removed or altered from any source distribution. 2117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 2217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Jean-loup Gailly Mark Adler 2317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner jloup@gzip.org madler@alumni.caltech.edu 2417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 2517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 2617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The data format used by the zlib library is described by RFCs (Request for 2717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Comments) 1950 to 1952 in the files http://tools.ietf.org/html/rfc1950 2817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner (zlib format), rfc1951 (deflate format) and rfc1952 (gzip format). 2917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 3017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 3117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#ifndef ZLIB_H 3217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define ZLIB_H 3317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 3417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#include "zconf.h" 3517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 3617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#ifdef __cplusplus 3717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turnerextern "C" { 3817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#endif 3917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 4017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define ZLIB_VERSION "1.2.8" 4117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define ZLIB_VERNUM 0x1280 4217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define ZLIB_VER_MAJOR 1 4317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define ZLIB_VER_MINOR 2 4417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define ZLIB_VER_REVISION 8 4517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define ZLIB_VER_SUBREVISION 0 4617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 4717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 4817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The 'zlib' compression library provides in-memory compression and 4917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner decompression functions, including integrity checks of the uncompressed data. 5017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner This version of the library supports only one compression method (deflation) 5117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner but other algorithms will be added later and will have the same stream 5217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner interface. 5317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 5417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Compression can be done in a single step if the buffers are large enough, 5517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner or can be done by repeated calls of the compression function. In the latter 5617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner case, the application must provide more input and/or consume the output 5717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner (providing more output space) before each call. 5817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 5917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The compressed data format used by default by the in-memory functions is 6017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the zlib format, which is a zlib wrapper documented in RFC 1950, wrapped 6117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner around a deflate stream, which is itself documented in RFC 1951. 6217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 6317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The library also supports reading and writing files in gzip (.gz) format 6417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner with an interface similar to that of stdio using the functions that start 6517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner with "gz". The gzip format is different from the zlib format. gzip is a 6617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzip wrapper, documented in RFC 1952, wrapped around a deflate stream. 6717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 6817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner This library can optionally read and write gzip streams in memory as well. 6917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 7017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The zlib format was designed to be compact and fast for use in memory 7117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner and on communications channels. The gzip format was designed for single- 7217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner file compression on file systems, has a larger header than zlib to maintain 7317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner directory information, and uses a different, slower check method than zlib. 7417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 7517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The library does not install any signal handler. The decoder checks 7617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the consistency of the compressed data, so the library should never crash 7717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner even in case of corrupted input. 7817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 7917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 8017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turnertypedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size)); 8117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turnertypedef void (*free_func) OF((voidpf opaque, voidpf address)); 8217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 8317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turnerstruct internal_state; 8417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 8517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turnertypedef struct z_stream_s { 8617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner z_const Bytef *next_in; /* next input byte */ 8717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uInt avail_in; /* number of bytes available at next_in */ 8817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uLong total_in; /* total number of input bytes read so far */ 8917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 9017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Bytef *next_out; /* next output byte should be put there */ 9117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uInt avail_out; /* remaining free space at next_out */ 9217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uLong total_out; /* total number of bytes output so far */ 9317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 9417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner z_const char *msg; /* last error message, NULL if no error */ 9517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner struct internal_state FAR *state; /* not visible by applications */ 9617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 9717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner alloc_func zalloc; /* used to allocate the internal state */ 9817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner free_func zfree; /* used to free the internal state */ 9917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner voidpf opaque; /* private data object passed to zalloc and zfree */ 10017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 10117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int data_type; /* best guess about the data type: binary or text */ 10217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uLong adler; /* adler32 value of the uncompressed data */ 10317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uLong reserved; /* reserved for future use */ 10417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner} z_stream; 10517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 10617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turnertypedef z_stream FAR *z_streamp; 10717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 10817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 10917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzip header information passed to and from zlib routines. See RFC 1952 11017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner for more details on the meanings of these fields. 11117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 11217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turnertypedef struct gz_header_s { 11317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int text; /* true if compressed data believed to be text */ 11417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uLong time; /* modification time */ 11517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int xflags; /* extra flags (not used when writing a gzip file) */ 11617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int os; /* operating system */ 11717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Bytef *extra; /* pointer to extra field or Z_NULL if none */ 11817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uInt extra_len; /* extra field length (valid if extra != Z_NULL) */ 11917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uInt extra_max; /* space at extra (only when reading header) */ 12017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Bytef *name; /* pointer to zero-terminated file name or Z_NULL */ 12117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uInt name_max; /* space at name (only when reading header) */ 12217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Bytef *comment; /* pointer to zero-terminated comment or Z_NULL */ 12317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uInt comm_max; /* space at comment (only when reading header) */ 12417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int hcrc; /* true if there was or will be a header crc */ 12517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int done; /* true when done reading gzip header (not used 12617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner when writing a gzip file) */ 12717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner} gz_header; 12817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 12917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turnertypedef gz_header FAR *gz_headerp; 13017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 13117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 13217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The application must update next_in and avail_in when avail_in has dropped 13317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner to zero. It must update next_out and avail_out when avail_out has dropped 13417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner to zero. The application must initialize zalloc, zfree and opaque before 13517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner calling the init function. All other fields are set by the compression 13617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner library and must not be updated by the application. 13717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 13817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The opaque value provided by the application will be passed as the first 13917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner parameter for calls of zalloc and zfree. This can be useful for custom 14017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner memory management. The compression library attaches no meaning to the 14117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner opaque value. 14217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 14317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner zalloc must return Z_NULL if there is not enough memory for the object. 14417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If zlib is used in a multi-threaded application, zalloc and zfree must be 14517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner thread safe. 14617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 14717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner On 16-bit systems, the functions zalloc and zfree must be able to allocate 14817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner exactly 65536 bytes, but will not be required to allocate more than this if 14917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS, pointers 15017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner returned by zalloc for objects of exactly 65536 bytes *must* have their 15117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner offset normalized to zero. The default allocation function provided by this 15217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner library ensures this (see zutil.c). To reduce memory requirements and avoid 15317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner any allocation of 64K objects, at the expense of compression ratio, compile 15417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the library with -DMAX_WBITS=14 (see zconf.h). 15517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 15617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The fields total_in and total_out can be used for statistics or progress 15717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner reports. After compression, total_in holds the total size of the 15817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uncompressed data and may be saved for use in the decompressor (particularly 15917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner if the decompressor wants to decompress everything in a single step). 16017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 16117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 16217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner /* constants */ 16317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 16417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_NO_FLUSH 0 16517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_PARTIAL_FLUSH 1 16617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_SYNC_FLUSH 2 16717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_FULL_FLUSH 3 16817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_FINISH 4 16917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_BLOCK 5 17017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_TREES 6 17117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* Allowed flush values; see deflate() and inflate() below for details */ 17217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 17317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_OK 0 17417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_STREAM_END 1 17517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_NEED_DICT 2 17617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_ERRNO (-1) 17717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_STREAM_ERROR (-2) 17817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_DATA_ERROR (-3) 17917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_MEM_ERROR (-4) 18017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_BUF_ERROR (-5) 18117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_VERSION_ERROR (-6) 18217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* Return codes for the compression/decompression functions. Negative values 18317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner * are errors, positive values are used for special but normal events. 18417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner */ 18517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 18617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_NO_COMPRESSION 0 18717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_BEST_SPEED 1 18817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_BEST_COMPRESSION 9 18917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_DEFAULT_COMPRESSION (-1) 19017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* compression levels */ 19117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 19217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_FILTERED 1 19317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_HUFFMAN_ONLY 2 19417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_RLE 3 19517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_FIXED 4 19617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_DEFAULT_STRATEGY 0 19717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* compression strategy; see deflateInit2() below for details */ 19817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 19917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_BINARY 0 20017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_TEXT 1 20117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_ASCII Z_TEXT /* for compatibility with 1.2.2 and earlier */ 20217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_UNKNOWN 2 20317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* Possible values of the data_type field (though see inflate()) */ 20417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 20517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_DEFLATED 8 20617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* The deflate compression method (the only one supported in this version) */ 20717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 20817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define Z_NULL 0 /* for initializing zalloc, zfree, opaque */ 20917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 21017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define zlib_version zlibVersion() 21117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* for compatibility with versions < 1.0.2 */ 21217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 21317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 21417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner /* basic functions */ 21517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 21617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN const char * ZEXPORT zlibVersion OF((void)); 21717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* The application can compare zlibVersion and ZLIB_VERSION for consistency. 21817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If the first character differs, the library code actually used is not 21917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compatible with the zlib.h header file used by the application. This check 22017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner is automatically made by deflateInit and inflateInit. 22117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner */ 22217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 22317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 22417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT deflateInit OF((z_streamp strm, int level)); 22517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 22617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Initializes the internal stream state for compression. The fields 22717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner zalloc, zfree and opaque must be initialized before by the caller. If 22817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner zalloc and zfree are set to Z_NULL, deflateInit updates them to use default 22917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner allocation functions. 23017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 23117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9: 23217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 1 gives best speed, 9 gives best compression, 0 gives no compression at all 23317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner (the input data is simply copied a block at a time). Z_DEFAULT_COMPRESSION 23417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner requests a default compromise between speed and compression (currently 23517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner equivalent to level 6). 23617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 23717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough 23817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner memory, Z_STREAM_ERROR if level is not a valid compression level, or 23917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible 24017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner with the version assumed by the caller (ZLIB_VERSION). msg is set to null 24117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner if there is no error message. deflateInit does not perform any compression: 24217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner this will be done by deflate(). 24317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 24417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 24517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 24617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT deflate OF((z_streamp strm, int flush)); 24717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 24817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflate compresses as much data as possible, and stops when the input 24917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner buffer becomes empty or the output buffer becomes full. It may introduce 25017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner some output latency (reading input without producing any output) except when 25117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner forced to flush. 25217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 25317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The detailed semantics are as follows. deflate performs one or both of the 25417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner following actions: 25517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 25617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner - Compress more input starting at next_in and update next_in and avail_in 25717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner accordingly. If not all input can be processed (because there is not 25817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner enough room in the output buffer), next_in and avail_in are updated and 25917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner processing will resume at this point for the next call of deflate(). 26017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 26117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner - Provide more output starting at next_out and update next_out and avail_out 26217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner accordingly. This action is forced if the parameter flush is non zero. 26317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Forcing flush frequently degrades the compression ratio, so this parameter 26417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner should be set only when necessary (in interactive applications). Some 26517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner output may be provided even if flush is not set. 26617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 26717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Before the call of deflate(), the application should ensure that at least 26817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner one of the actions is possible, by providing more input and/or consuming more 26917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner output, and updating avail_in or avail_out accordingly; avail_out should 27017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner never be zero before the call. The application can consume the compressed 27117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner output when it wants, for example when the output buffer is full (avail_out 27217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner == 0), or after each call of deflate(). If deflate returns Z_OK and with 27317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner zero avail_out, it must be called again after making room in the output 27417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner buffer because there might be more output pending. 27517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 27617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Normally the parameter flush is set to Z_NO_FLUSH, which allows deflate to 27717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner decide how much data to accumulate before producing output, in order to 27817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner maximize compression. 27917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 28017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If the parameter flush is set to Z_SYNC_FLUSH, all pending output is 28117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner flushed to the output buffer and the output is aligned on a byte boundary, so 28217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner that the decompressor can get all input data available so far. (In 28317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner particular avail_in is zero after the call if enough output space has been 28417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner provided before the call.) Flushing may degrade compression for some 28517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compression algorithms and so it should be used only when necessary. This 28617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner completes the current deflate block and follows it with an empty stored block 28717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner that is three bits plus filler bits to the next byte, followed by four bytes 28817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner (00 00 ff ff). 28917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 29017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If flush is set to Z_PARTIAL_FLUSH, all pending output is flushed to the 29117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner output buffer, but the output is not aligned to a byte boundary. All of the 29217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner input data so far will be available to the decompressor, as for Z_SYNC_FLUSH. 29317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner This completes the current deflate block and follows it with an empty fixed 29417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner codes block that is 10 bits long. This assures that enough bytes are output 29517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner in order for the decompressor to finish the block before the empty fixed code 29617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner block. 29717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 29817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If flush is set to Z_BLOCK, a deflate block is completed and emitted, as 29917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner for Z_SYNC_FLUSH, but the output is not aligned on a byte boundary, and up to 30017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner seven bits of the current block are held to be written as the next byte after 30117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the next deflate block is completed. In this case, the decompressor may not 30217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner be provided enough bits at this point in order to complete decompression of 30317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the data provided so far to the compressor. It may need to wait for the next 30417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner block to be emitted. This is for advanced applications that need to control 30517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the emission of deflate blocks. 30617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 30717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If flush is set to Z_FULL_FLUSH, all output is flushed as with 30817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Z_SYNC_FLUSH, and the compression state is reset so that decompression can 30917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner restart from this point if previous compressed data has been damaged or if 31017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner random access is desired. Using Z_FULL_FLUSH too often can seriously degrade 31117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compression. 31217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 31317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If deflate returns with avail_out == 0, this function must be called again 31417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner with the same value of the flush parameter and more output space (updated 31517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner avail_out), until the flush is complete (deflate returns with non-zero 31617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner avail_out). In the case of a Z_FULL_FLUSH or Z_SYNC_FLUSH, make sure that 31717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner avail_out is greater than six to avoid repeated flush markers due to 31817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner avail_out == 0 on return. 31917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 32017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If the parameter flush is set to Z_FINISH, pending input is processed, 32117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner pending output is flushed and deflate returns with Z_STREAM_END if there was 32217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner enough output space; if deflate returns with Z_OK, this function must be 32317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner called again with Z_FINISH and more output space (updated avail_out) but no 32417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner more input data, until it returns with Z_STREAM_END or an error. After 32517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflate has returned Z_STREAM_END, the only possible operations on the stream 32617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner are deflateReset or deflateEnd. 32717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 32817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Z_FINISH can be used immediately after deflateInit if all the compression 32917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner is to be done in a single step. In this case, avail_out must be at least the 33017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner value returned by deflateBound (see below). Then deflate is guaranteed to 33117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner return Z_STREAM_END. If not enough output space is provided, deflate will 33217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner not return Z_STREAM_END, and it must be called again as described above. 33317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 33417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflate() sets strm->adler to the adler32 checksum of all input read 33517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner so far (that is, total_in bytes). 33617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 33717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflate() may update strm->data_type if it can make a good guess about 33817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the input data type (Z_BINARY or Z_TEXT). In doubt, the data is considered 33917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner binary. This field is only for information purposes and does not affect the 34017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compression algorithm in any manner. 34117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 34217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflate() returns Z_OK if some progress has been made (more input 34317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner processed or more output produced), Z_STREAM_END if all input has been 34417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner consumed and all output has been produced (only when flush is set to 34517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example 34617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner if next_in or next_out was Z_NULL), Z_BUF_ERROR if no progress is possible 34717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner (for example avail_in or avail_out was zero). Note that Z_BUF_ERROR is not 34817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner fatal, and deflate() can be called again with more input and more output 34917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner space to continue compressing. 35017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 35117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 35217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 35317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT deflateEnd OF((z_streamp strm)); 35417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 35517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner All dynamically allocated data structures for this stream are freed. 35617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner This function discards any unprocessed input and does not flush any pending 35717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner output. 35817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 35917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the 36017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner stream state was inconsistent, Z_DATA_ERROR if the stream was freed 36117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner prematurely (some input or output was discarded). In the error case, msg 36217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner may be set but then points to a static string (which must not be 36317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deallocated). 36417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 36517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 36617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 36717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 36817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflateInit OF((z_streamp strm)); 36917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 37017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Initializes the internal stream state for decompression. The fields 37117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner next_in, avail_in, zalloc, zfree and opaque must be initialized before by 37217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the caller. If next_in is not Z_NULL and avail_in is large enough (the 37317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner exact value depends on the compression method), inflateInit determines the 37417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compression method from the zlib header and allocates all data structures 37517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner accordingly; otherwise the allocation will be deferred to the first call of 37617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them to 37717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner use default allocation functions. 37817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 37917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough 38017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner memory, Z_VERSION_ERROR if the zlib library version is incompatible with the 38117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner version assumed by the caller, or Z_STREAM_ERROR if the parameters are 38217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner invalid, such as a null pointer to the structure. msg is set to null if 38317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner there is no error message. inflateInit does not perform any decompression 38417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner apart from possibly reading the zlib header if present: actual decompression 38517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner will be done by inflate(). (So next_in and avail_in may be modified, but 38617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner next_out and avail_out are unused and unchanged.) The current implementation 38717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner of inflateInit() does not process any header information -- that is deferred 38817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner until inflate() is called. 38917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 39017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 39117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 39217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflate OF((z_streamp strm, int flush)); 39317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 39417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflate decompresses as much data as possible, and stops when the input 39517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner buffer becomes empty or the output buffer becomes full. It may introduce 39617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner some output latency (reading input without producing any output) except when 39717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner forced to flush. 39817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 39917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The detailed semantics are as follows. inflate performs one or both of the 40017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner following actions: 40117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 40217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner - Decompress more input starting at next_in and update next_in and avail_in 40317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner accordingly. If not all input can be processed (because there is not 40417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner enough room in the output buffer), next_in is updated and processing will 40517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner resume at this point for the next call of inflate(). 40617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 40717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner - Provide more output starting at next_out and update next_out and avail_out 40817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner accordingly. inflate() provides as much output as possible, until there is 40917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner no more input data or no more space in the output buffer (see below about 41017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the flush parameter). 41117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 41217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Before the call of inflate(), the application should ensure that at least 41317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner one of the actions is possible, by providing more input and/or consuming more 41417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner output, and updating the next_* and avail_* values accordingly. The 41517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner application can consume the uncompressed output when it wants, for example 41617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner when the output buffer is full (avail_out == 0), or after each call of 41717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflate(). If inflate returns Z_OK and with zero avail_out, it must be 41817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner called again after making room in the output buffer because there might be 41917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner more output pending. 42017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 42117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The flush parameter of inflate() can be Z_NO_FLUSH, Z_SYNC_FLUSH, Z_FINISH, 42217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Z_BLOCK, or Z_TREES. Z_SYNC_FLUSH requests that inflate() flush as much 42317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner output as possible to the output buffer. Z_BLOCK requests that inflate() 42417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner stop if and when it gets to the next deflate block boundary. When decoding 42517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the zlib or gzip format, this will cause inflate() to return immediately 42617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner after the header and before the first block. When doing a raw inflate, 42717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflate() will go ahead and process the first block, and will return when it 42817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gets to the end of that block, or when it runs out of data. 42917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 43017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The Z_BLOCK option assists in appending to or combining deflate streams. 43117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Also to assist in this, on return inflate() will set strm->data_type to the 43217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner number of unused bits in the last byte taken from strm->next_in, plus 64 if 43317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflate() is currently decoding the last block in the deflate stream, plus 43417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 128 if inflate() returned immediately after decoding an end-of-block code or 43517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner decoding the complete header up to just before the first byte of the deflate 43617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner stream. The end-of-block will not be indicated until all of the uncompressed 43717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner data from that block has been written to strm->next_out. The number of 43817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner unused bits may in general be greater than seven, except when bit 7 of 43917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner data_type is set, in which case the number of unused bits will be less than 44017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner eight. data_type is set as noted here every time inflate() returns for all 44117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner flush options, and so can be used to determine the amount of currently 44217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner consumed input in bits. 44317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 44417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The Z_TREES option behaves as Z_BLOCK does, but it also returns when the 44517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner end of each deflate block header is reached, before any actual data in that 44617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner block is decoded. This allows the caller to determine the length of the 44717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflate block header for later use in random access within a deflate block. 44817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 256 is added to the value of strm->data_type when inflate() returns 44917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner immediately after reaching the end of the deflate block header. 45017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 45117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflate() should normally be called until it returns Z_STREAM_END or an 45217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner error. However if all decompression is to be performed in a single step (a 45317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner single call of inflate), the parameter flush should be set to Z_FINISH. In 45417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner this case all pending input is processed and all pending output is flushed; 45517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner avail_out must be large enough to hold all of the uncompressed data for the 45617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner operation to complete. (The size of the uncompressed data may have been 45717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner saved by the compressor for this purpose.) The use of Z_FINISH is not 45817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner required to perform an inflation in one step. However it may be used to 45917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inform inflate that a faster approach can be used for the single inflate() 46017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner call. Z_FINISH also informs inflate to not maintain a sliding window if the 46117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner stream completes, which reduces inflate's memory footprint. If the stream 46217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner does not complete, either because not all of the stream is provided or not 46317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner enough output space is provided, then a sliding window will be allocated and 46417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflate() can be called again to continue the operation as if Z_NO_FLUSH had 46517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner been used. 46617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 46717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner In this implementation, inflate() always flushes as much output as 46817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner possible to the output buffer, and always uses the faster approach on the 46917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner first call. So the effects of the flush parameter in this implementation are 47017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner on the return value of inflate() as noted below, when inflate() returns early 47117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner when Z_BLOCK or Z_TREES is used, and when inflate() avoids the allocation of 47217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner memory for a sliding window when Z_FINISH is used. 47317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 47417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If a preset dictionary is needed after this call (see inflateSetDictionary 47517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner below), inflate sets strm->adler to the Adler-32 checksum of the dictionary 47617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner chosen by the compressor and returns Z_NEED_DICT; otherwise it sets 47717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner strm->adler to the Adler-32 checksum of all output produced so far (that is, 47817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner total_out bytes) and returns Z_OK, Z_STREAM_END or an error code as described 47917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner below. At the end of the stream, inflate() checks that its computed adler32 48017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner checksum is equal to that saved by the compressor and returns Z_STREAM_END 48117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner only if the checksum is correct. 48217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 48317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflate() can decompress and check either zlib-wrapped or gzip-wrapped 48417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflate data. The header type is detected automatically, if requested when 48517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner initializing with inflateInit2(). Any information contained in the gzip 48617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner header is not retained, so applications that need that information should 48717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner instead use raw inflate, see inflateInit2() below, or inflateBack() and 48817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner perform their own processing of the gzip header and trailer. When processing 48917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzip-wrapped deflate data, strm->adler32 is set to the CRC-32 of the output 49017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner producted so far. The CRC-32 is checked against the gzip trailer. 49117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 49217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflate() returns Z_OK if some progress has been made (more input processed 49317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner or more output produced), Z_STREAM_END if the end of the compressed data has 49417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner been reached and all uncompressed output has been produced, Z_NEED_DICT if a 49517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner preset dictionary is needed at this point, Z_DATA_ERROR if the input data was 49617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner corrupted (input stream not conforming to the zlib format or incorrect check 49717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner value), Z_STREAM_ERROR if the stream structure was inconsistent (for example 49817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner next_in or next_out was Z_NULL), Z_MEM_ERROR if there was not enough memory, 49917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Z_BUF_ERROR if no progress is possible or if there was not enough room in the 50017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner output buffer when Z_FINISH is used. Note that Z_BUF_ERROR is not fatal, and 50117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflate() can be called again with more input and more output space to 50217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner continue decompressing. If Z_DATA_ERROR is returned, the application may 50317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner then call inflateSync() to look for a good compression block if a partial 50417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner recovery of the data is desired. 50517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 50617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 50717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 50817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflateEnd OF((z_streamp strm)); 50917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 51017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner All dynamically allocated data structures for this stream are freed. 51117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner This function discards any unprocessed input and does not flush any pending 51217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner output. 51317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 51417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state 51517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner was inconsistent. In the error case, msg may be set but then points to a 51617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner static string (which must not be deallocated). 51717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 51817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 51917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 52017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner /* Advanced functions */ 52117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 52217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 52317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The following functions are needed only in some special applications. 52417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 52517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 52617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 52717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT deflateInit2 OF((z_streamp strm, 52817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int level, 52917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int method, 53017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int windowBits, 53117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int memLevel, 53217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int strategy)); 53317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 53417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner This is another version of deflateInit with more compression options. The 53517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner fields next_in, zalloc, zfree and opaque must be initialized before by the 53617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner caller. 53717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 53817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The method parameter is the compression method. It must be Z_DEFLATED in 53917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner this version of the library. 54017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 54117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The windowBits parameter is the base two logarithm of the window size 54217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner (the size of the history buffer). It should be in the range 8..15 for this 54317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner version of the library. Larger values of this parameter result in better 54417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compression at the expense of memory usage. The default value is 15 if 54517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateInit is used instead. 54617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 54717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner windowBits can also be -8..-15 for raw deflate. In this case, -windowBits 54817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner determines the window size. deflate() will then generate raw deflate data 54917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner with no zlib header or trailer, and will not compute an adler32 check value. 55017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 55117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner windowBits can also be greater than 15 for optional gzip encoding. Add 55217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 16 to windowBits to write a simple gzip header and trailer around the 55317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compressed data instead of a zlib wrapper. The gzip header will have no 55417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner file name, no extra data, no comment, no modification time (set to zero), no 55517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner header crc, and the operating system will be set to 255 (unknown). If a 55617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzip stream is being written, strm->adler is a crc32 instead of an adler32. 55717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 55817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The memLevel parameter specifies how much memory should be allocated 55917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner for the internal compression state. memLevel=1 uses minimum memory but is 56017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner slow and reduces compression ratio; memLevel=9 uses maximum memory for 56117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner optimal speed. The default value is 8. See zconf.h for total memory usage 56217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner as a function of windowBits and memLevel. 56317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 56417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The strategy parameter is used to tune the compression algorithm. Use the 56517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a 56617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner filter (or predictor), Z_HUFFMAN_ONLY to force Huffman encoding only (no 56717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner string match), or Z_RLE to limit match distances to one (run-length 56817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner encoding). Filtered data consists mostly of small values with a somewhat 56917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner random distribution. In this case, the compression algorithm is tuned to 57017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compress them better. The effect of Z_FILTERED is to force more Huffman 57117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner coding and less string matching; it is somewhat intermediate between 57217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Z_DEFAULT_STRATEGY and Z_HUFFMAN_ONLY. Z_RLE is designed to be almost as 57317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner fast as Z_HUFFMAN_ONLY, but give better compression for PNG image data. The 57417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner strategy parameter only affects the compression ratio but not the 57517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner correctness of the compressed output even if it is not set appropriately. 57617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Z_FIXED prevents the use of dynamic Huffman codes, allowing for a simpler 57717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner decoder for special applications. 57817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 57917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough 58017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner memory, Z_STREAM_ERROR if any parameter is invalid (such as an invalid 58117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner method), or Z_VERSION_ERROR if the zlib library version (zlib_version) is 58217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner incompatible with the version assumed by the caller (ZLIB_VERSION). msg is 58317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner set to null if there is no error message. deflateInit2 does not perform any 58417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compression: this will be done by deflate(). 58517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 58617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 58717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT deflateSetDictionary OF((z_streamp strm, 58817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner const Bytef *dictionary, 58917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uInt dictLength)); 59017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 59117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Initializes the compression dictionary from the given byte sequence 59217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner without producing any compressed output. When using the zlib format, this 59317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner function must be called immediately after deflateInit, deflateInit2 or 59417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateReset, and before any call of deflate. When doing raw deflate, this 59517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner function must be called either before any call of deflate, or immediately 59617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner after the completion of a deflate block, i.e. after all input has been 59717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner consumed and all output has been delivered when using any of the flush 59817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner options Z_BLOCK, Z_PARTIAL_FLUSH, Z_SYNC_FLUSH, or Z_FULL_FLUSH. The 59917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compressor and decompressor must use exactly the same dictionary (see 60017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateSetDictionary). 60117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 60217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The dictionary should consist of strings (byte sequences) that are likely 60317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner to be encountered later in the data to be compressed, with the most commonly 60417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner used strings preferably put towards the end of the dictionary. Using a 60517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner dictionary is most useful when the data to be compressed is short and can be 60617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner predicted with good accuracy; the data can then be compressed better than 60717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner with the default empty dictionary. 60817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 60917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Depending on the size of the compression data structures selected by 61017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateInit or deflateInit2, a part of the dictionary may in effect be 61117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner discarded, for example if the dictionary is larger than the window size 61217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner provided in deflateInit or deflateInit2. Thus the strings most likely to be 61317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner useful should be put at the end of the dictionary, not at the front. In 61417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner addition, the current implementation of deflate will use at most the window 61517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner size minus 262 bytes of the provided dictionary. 61617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 61717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Upon return of this function, strm->adler is set to the adler32 value 61817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner of the dictionary; the decompressor may later use this value to determine 61917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner which dictionary has been used by the compressor. (The adler32 value 62017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner applies to the whole dictionary even if only a subset of the dictionary is 62117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner actually used by the compressor.) If a raw deflate was requested, then the 62217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner adler32 value is not computed and strm->adler is not set. 62317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 62417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a 62517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is 62617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inconsistent (for example if deflate has already been called for this stream 62717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner or if not at a block boundary for raw deflate). deflateSetDictionary does 62817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner not perform any compression: this will be done by deflate(). 62917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 63017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 63117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT deflateCopy OF((z_streamp dest, 63217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner z_streamp source)); 63317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 63417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Sets the destination stream as a complete copy of the source stream. 63517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 63617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner This function can be useful when several compression strategies will be 63717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner tried, for example when there are several ways of pre-processing the input 63817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner data with a filter. The streams that will be discarded should then be freed 63917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner by calling deflateEnd. Note that deflateCopy duplicates the internal 64017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compression state which can be quite large, so this strategy is slow and can 64117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner consume lots of memory. 64217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 64317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not 64417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner enough memory, Z_STREAM_ERROR if the source stream state was inconsistent 64517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner (such as zalloc being Z_NULL). msg is left unchanged in both source and 64617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner destination. 64717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 64817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 64917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT deflateReset OF((z_streamp strm)); 65017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 65117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner This function is equivalent to deflateEnd followed by deflateInit, 65217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner but does not free and reallocate all the internal compression state. The 65317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner stream will keep the same compression level and any other attributes that 65417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner may have been set by deflateInit2. 65517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 65617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source 65717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner stream state was inconsistent (such as zalloc or state being Z_NULL). 65817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 65917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 66017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT deflateParams OF((z_streamp strm, 66117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int level, 66217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int strategy)); 66317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 66417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Dynamically update the compression level and compression strategy. The 66517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner interpretation of level and strategy is as in deflateInit2. This can be 66617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner used to switch between compression and straight copy of the input data, or 66717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner to switch to a different kind of input data requiring a different strategy. 66817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If the compression level is changed, the input available so far is 66917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compressed with the old level (and may be flushed); the new level will take 67017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner effect only at the next call of deflate(). 67117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 67217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Before the call of deflateParams, the stream state must be set as for 67317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner a call of deflate(), since the currently available input may have to be 67417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compressed and flushed. In particular, strm->avail_out must be non-zero. 67517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 67617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source 67717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR if 67817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner strm->avail_out was zero. 67917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 68017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 68117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT deflateTune OF((z_streamp strm, 68217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int good_length, 68317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int max_lazy, 68417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int nice_length, 68517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int max_chain)); 68617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 68717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Fine tune deflate's internal compression parameters. This should only be 68817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner used by someone who understands the algorithm used by zlib's deflate for 68917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner searching for the best matching string, and even then only by the most 69017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner fanatic optimizer trying to squeeze out the last compressed bit for their 69117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner specific input data. Read the deflate.c source code for the meaning of the 69217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner max_lazy, good_length, nice_length, and max_chain parameters. 69317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 69417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateTune() can be called after deflateInit() or deflateInit2(), and 69517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner returns Z_OK on success, or Z_STREAM_ERROR for an invalid deflate stream. 69617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner */ 69717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 69817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN uLong ZEXPORT deflateBound OF((z_streamp strm, 69917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uLong sourceLen)); 70017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 70117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateBound() returns an upper bound on the compressed size after 70217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflation of sourceLen bytes. It must be called after deflateInit() or 70317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateInit2(), and after deflateSetHeader(), if used. This would be used 70417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner to allocate an output buffer for deflation in a single pass, and so would be 70517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner called before deflate(). If that first deflate() call is provided the 70617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner sourceLen input bytes, an output buffer allocated to the size returned by 70717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateBound(), and the flush value Z_FINISH, then deflate() is guaranteed 70817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner to return Z_STREAM_END. Note that it is possible for the compressed size to 70917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner be larger than the value returned by deflateBound() if flush options other 71017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner than Z_FINISH or Z_NO_FLUSH are used. 71117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 71217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 71317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT deflatePending OF((z_streamp strm, 71417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner unsigned *pending, 71517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int *bits)); 71617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 71717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflatePending() returns the number of bytes and bits of output that have 71817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner been generated, but not yet provided in the available output. The bytes not 71917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner provided would be due to the available output space having being consumed. 72017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The number of bits of output not provided are between 0 and 7, where they 72117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner await more bits to join them in order to fill out a full byte. If pending 72217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner or bits are Z_NULL, then those values are not set. 72317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 72417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflatePending returns Z_OK if success, or Z_STREAM_ERROR if the source 72517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner stream state was inconsistent. 72617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner */ 72717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 72817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT deflatePrime OF((z_streamp strm, 72917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int bits, 73017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int value)); 73117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 73217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflatePrime() inserts bits in the deflate output stream. The intent 73317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner is that this function is used to start off the deflate output with the bits 73417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner leftover from a previous deflate stream when appending to it. As such, this 73517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner function can only be used for raw deflate, and must be used before the first 73617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflate() call after a deflateInit2() or deflateReset(). bits must be less 73717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner than or equal to 16, and that many of the least significant bits of value 73817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner will be inserted in the output. 73917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 74017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflatePrime returns Z_OK if success, Z_BUF_ERROR if there was not enough 74117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner room in the internal buffer to insert the bits, or Z_STREAM_ERROR if the 74217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner source stream state was inconsistent. 74317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 74417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 74517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT deflateSetHeader OF((z_streamp strm, 74617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gz_headerp head)); 74717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 74817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateSetHeader() provides gzip header information for when a gzip 74917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner stream is requested by deflateInit2(). deflateSetHeader() may be called 75017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner after deflateInit2() or deflateReset() and before the first call of 75117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflate(). The text, time, os, extra field, name, and comment information 75217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner in the provided gz_header structure are written to the gzip header (xflag is 75317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ignored -- the extra flags are set according to the compression level). The 75417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner caller must assure that, if not Z_NULL, name and comment are terminated with 75517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner a zero byte, and that if extra is not Z_NULL, that extra_len bytes are 75617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner available there. If hcrc is true, a gzip header crc is included. Note that 75717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the current versions of the command-line version of gzip (up through version 75817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 1.3.x) do not support header crc's, and will report that it is a "multi-part 75917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzip file" and give up. 76017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 76117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If deflateSetHeader is not used, the default gzip header has text false, 76217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the time set to zero, and os set to 255, with no extra, name, or comment 76317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner fields. The gzip header is returned to the default state by deflateReset(). 76417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 76517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateSetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source 76617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner stream state was inconsistent. 76717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 76817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 76917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 77017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflateInit2 OF((z_streamp strm, 77117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int windowBits)); 77217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 77317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner This is another version of inflateInit with an extra parameter. The 77417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner fields next_in, avail_in, zalloc, zfree and opaque must be initialized 77517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner before by the caller. 77617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 77717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The windowBits parameter is the base two logarithm of the maximum window 77817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner size (the size of the history buffer). It should be in the range 8..15 for 77917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner this version of the library. The default value is 15 if inflateInit is used 78017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner instead. windowBits must be greater than or equal to the windowBits value 78117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner provided to deflateInit2() while compressing, or it must be equal to 15 if 78217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateInit2() was not used. If a compressed stream with a larger window 78317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner size is given as input, inflate() will return with the error code 78417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Z_DATA_ERROR instead of trying to allocate a larger window. 78517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 78617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner windowBits can also be zero to request that inflate use the window size in 78717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the zlib header of the compressed stream. 78817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 78917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner windowBits can also be -8..-15 for raw inflate. In this case, -windowBits 79017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner determines the window size. inflate() will then process raw deflate data, 79117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner not looking for a zlib or gzip header, not generating a check value, and not 79217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner looking for any check values for comparison at the end of the stream. This 79317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner is for use with other formats that use the deflate compressed data format 79417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner such as zip. Those formats provide their own check values. If a custom 79517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner format is developed using the raw deflate format for compressed data, it is 79617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner recommended that a check value such as an adler32 or a crc32 be applied to 79717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the uncompressed data as is done in the zlib, gzip, and zip formats. For 79817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner most applications, the zlib format should be used as is. Note that comments 79917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner above on the use in deflateInit2() applies to the magnitude of windowBits. 80017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 80117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner windowBits can also be greater than 15 for optional gzip decoding. Add 80217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 32 to windowBits to enable zlib and gzip decoding with automatic header 80317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner detection, or add 16 to decode only the gzip format (the zlib format will 80417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner return a Z_DATA_ERROR). If a gzip stream is being decoded, strm->adler is a 80517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner crc32 instead of an adler32. 80617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 80717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough 80817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner memory, Z_VERSION_ERROR if the zlib library version is incompatible with the 80917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner version assumed by the caller, or Z_STREAM_ERROR if the parameters are 81017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner invalid, such as a null pointer to the structure. msg is set to null if 81117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner there is no error message. inflateInit2 does not perform any decompression 81217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner apart from possibly reading the zlib header if present: actual decompression 81317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner will be done by inflate(). (So next_in and avail_in may be modified, but 81417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner next_out and avail_out are unused and unchanged.) The current implementation 81517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner of inflateInit2() does not process any header information -- that is 81617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deferred until inflate() is called. 81717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 81817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 81917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflateSetDictionary OF((z_streamp strm, 82017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner const Bytef *dictionary, 82117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uInt dictLength)); 82217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 82317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Initializes the decompression dictionary from the given uncompressed byte 82417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner sequence. This function must be called immediately after a call of inflate, 82517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner if that call returned Z_NEED_DICT. The dictionary chosen by the compressor 82617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner can be determined from the adler32 value returned by that call of inflate. 82717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The compressor and decompressor must use exactly the same dictionary (see 82817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateSetDictionary). For raw inflate, this function can be called at any 82917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner time to set the dictionary. If the provided dictionary is smaller than the 83017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner window and there is already data in the window, then the provided dictionary 83117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner will amend what's there. The application must insure that the dictionary 83217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner that was used for compression is provided. 83317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 83417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a 83517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is 83617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the 83717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner expected one (incorrect adler32 value). inflateSetDictionary does not 83817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner perform any decompression: this will be done by subsequent calls of 83917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflate(). 84017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 84117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 84217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflateGetDictionary OF((z_streamp strm, 84317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Bytef *dictionary, 84417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uInt *dictLength)); 84517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 84617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Returns the sliding dictionary being maintained by inflate. dictLength is 84717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner set to the number of bytes in the dictionary, and that many bytes are copied 84817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner to dictionary. dictionary must have enough space, where 32768 bytes is 84917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner always enough. If inflateGetDictionary() is called with dictionary equal to 85017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Z_NULL, then only the dictionary length is returned, and nothing is copied. 85117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Similary, if dictLength is Z_NULL, then it is not set. 85217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 85317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateGetDictionary returns Z_OK on success, or Z_STREAM_ERROR if the 85417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner stream state is inconsistent. 85517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 85617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 85717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflateSync OF((z_streamp strm)); 85817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 85917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Skips invalid compressed data until a possible full flush point (see above 86017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner for the description of deflate with Z_FULL_FLUSH) can be found, or until all 86117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner available input is skipped. No output is provided. 86217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 86317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateSync searches for a 00 00 FF FF pattern in the compressed data. 86417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner All full flush points have this pattern, but not all occurrences of this 86517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner pattern are full flush points. 86617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 86717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateSync returns Z_OK if a possible full flush point has been found, 86817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Z_BUF_ERROR if no more input was provided, Z_DATA_ERROR if no flush point 86917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner has been found, or Z_STREAM_ERROR if the stream structure was inconsistent. 87017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner In the success case, the application may save the current current value of 87117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner total_in which indicates where valid compressed data was found. In the 87217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner error case, the application may repeatedly call inflateSync, providing more 87317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner input each time, until success or end of the input data. 87417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 87517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 87617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflateCopy OF((z_streamp dest, 87717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner z_streamp source)); 87817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 87917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Sets the destination stream as a complete copy of the source stream. 88017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 88117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner This function can be useful when randomly accessing a large stream. The 88217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner first pass through the stream can periodically record the inflate state, 88317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner allowing restarting inflate at those points when randomly accessing the 88417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner stream. 88517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 88617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not 88717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner enough memory, Z_STREAM_ERROR if the source stream state was inconsistent 88817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner (such as zalloc being Z_NULL). msg is left unchanged in both source and 88917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner destination. 89017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 89117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 89217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflateReset OF((z_streamp strm)); 89317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 89417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner This function is equivalent to inflateEnd followed by inflateInit, 89517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner but does not free and reallocate all the internal decompression state. The 89617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner stream will keep attributes that may have been set by inflateInit2. 89717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 89817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source 89917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner stream state was inconsistent (such as zalloc or state being Z_NULL). 90017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 90117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 90217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflateReset2 OF((z_streamp strm, 90317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int windowBits)); 90417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 90517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner This function is the same as inflateReset, but it also permits changing 90617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the wrap and window size requests. The windowBits parameter is interpreted 90717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the same as it is for inflateInit2. 90817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 90917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateReset2 returns Z_OK if success, or Z_STREAM_ERROR if the source 91017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner stream state was inconsistent (such as zalloc or state being Z_NULL), or if 91117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the windowBits parameter is invalid. 91217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 91317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 91417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflatePrime OF((z_streamp strm, 91517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int bits, 91617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int value)); 91717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 91817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner This function inserts bits in the inflate input stream. The intent is 91917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner that this function is used to start inflating at a bit position in the 92017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner middle of a byte. The provided bits will be used before any bytes are used 92117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner from next_in. This function should only be used with raw inflate, and 92217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner should be used before the first inflate() call after inflateInit2() or 92317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateReset(). bits must be less than or equal to 16, and that many of the 92417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner least significant bits of value will be inserted in the input. 92517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 92617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If bits is negative, then the input stream bit buffer is emptied. Then 92717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflatePrime() can be called again to put bits in the buffer. This is used 92817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner to clear out bits leftover after feeding inflate a block description prior 92917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner to feeding inflate codes. 93017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 93117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source 93217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner stream state was inconsistent. 93317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 93417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 93517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN long ZEXPORT inflateMark OF((z_streamp strm)); 93617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 93717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner This function returns two values, one in the lower 16 bits of the return 93817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner value, and the other in the remaining upper bits, obtained by shifting the 93917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner return value down 16 bits. If the upper value is -1 and the lower value is 94017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner zero, then inflate() is currently decoding information outside of a block. 94117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If the upper value is -1 and the lower value is non-zero, then inflate is in 94217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the middle of a stored block, with the lower value equaling the number of 94317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner bytes from the input remaining to copy. If the upper value is not -1, then 94417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner it is the number of bits back from the current bit position in the input of 94517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the code (literal or length/distance pair) currently being processed. In 94617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner that case the lower value is the number of bytes already emitted for that 94717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner code. 94817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 94917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner A code is being processed if inflate is waiting for more input to complete 95017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner decoding of the code, or if it has completed decoding but is waiting for 95117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner more output space to write the literal or match data. 95217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 95317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateMark() is used to mark locations in the input data for random 95417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner access, which may be at bit positions, and to note those cases where the 95517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner output of a code may span boundaries of random access blocks. The current 95617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner location in the input stream can be determined from avail_in and data_type 95717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner as noted in the description for the Z_BLOCK flush parameter for inflate. 95817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 95917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateMark returns the value noted above or -1 << 16 if the provided 96017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner source stream state was inconsistent. 96117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 96217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 96317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflateGetHeader OF((z_streamp strm, 96417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gz_headerp head)); 96517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 96617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateGetHeader() requests that gzip header information be stored in the 96717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner provided gz_header structure. inflateGetHeader() may be called after 96817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateInit2() or inflateReset(), and before the first call of inflate(). 96917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner As inflate() processes the gzip stream, head->done is zero until the header 97017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner is completed, at which time head->done is set to one. If a zlib stream is 97117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner being decoded, then head->done is set to -1 to indicate that there will be 97217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner no gzip header information forthcoming. Note that Z_BLOCK or Z_TREES can be 97317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner used to force inflate() to return immediately after header processing is 97417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner complete and before any actual data is decompressed. 97517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 97617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The text, time, xflags, and os fields are filled in with the gzip header 97717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner contents. hcrc is set to true if there is a header CRC. (The header CRC 97817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner was valid if done is set to one.) If extra is not Z_NULL, then extra_max 97917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner contains the maximum number of bytes to write to extra. Once done is true, 98017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner extra_len contains the actual extra field length, and extra contains the 98117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner extra field, or that field truncated if extra_max is less than extra_len. 98217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If name is not Z_NULL, then up to name_max characters are written there, 98317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner terminated with a zero unless the length is greater than name_max. If 98417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner comment is not Z_NULL, then up to comm_max characters are written there, 98517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner terminated with a zero unless the length is greater than comm_max. When any 98617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner of extra, name, or comment are not Z_NULL and the respective field is not 98717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner present in the header, then that field is set to Z_NULL to signal its 98817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner absence. This allows the use of deflateSetHeader() with the returned 98917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner structure to duplicate the header. However if those fields are set to 99017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner allocated memory, then the application will need to save those pointers 99117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner elsewhere so that they can be eventually freed. 99217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 99317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If inflateGetHeader is not used, then the header information is simply 99417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner discarded. The header is always checked for validity, including the header 99517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner CRC if present. inflateReset() will reset the process to discard the header 99617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner information. The application would need to call inflateGetHeader() again to 99717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner retrieve the header from the next gzip stream. 99817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 99917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateGetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source 100017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner stream state was inconsistent. 100117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 100217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 100317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 100417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflateBackInit OF((z_streamp strm, int windowBits, 100517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner unsigned char FAR *window)); 100617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 100717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Initialize the internal stream state for decompression using inflateBack() 100817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner calls. The fields zalloc, zfree and opaque in strm must be initialized 100917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner before the call. If zalloc and zfree are Z_NULL, then the default library- 101017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner derived memory allocation routines are used. windowBits is the base two 101117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner logarithm of the window size, in the range 8..15. window is a caller 101217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner supplied buffer of that size. Except for special applications where it is 101317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner assured that deflate was used with small window sizes, windowBits must be 15 101417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner and a 32K byte window must be supplied to be able to decompress general 101517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflate streams. 101617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 101717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner See inflateBack() for the usage of these routines. 101817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 101917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateBackInit will return Z_OK on success, Z_STREAM_ERROR if any of 102017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the parameters are invalid, Z_MEM_ERROR if the internal state could not be 102117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner allocated, or Z_VERSION_ERROR if the version of the library does not match 102217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the version of the header file. 102317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 102417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 102517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turnertypedef unsigned (*in_func) OF((void FAR *, 102617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner z_const unsigned char FAR * FAR *)); 102717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turnertypedef int (*out_func) OF((void FAR *, unsigned char FAR *, unsigned)); 102817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 102917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflateBack OF((z_streamp strm, 103017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner in_func in, void FAR *in_desc, 103117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner out_func out, void FAR *out_desc)); 103217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 103317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateBack() does a raw inflate with a single call using a call-back 103417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner interface for input and output. This is potentially more efficient than 103517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflate() for file i/o applications, in that it avoids copying between the 103617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner output and the sliding window by simply making the window itself the output 103717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner buffer. inflate() can be faster on modern CPUs when used with large 103817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner buffers. inflateBack() trusts the application to not change the output 103917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner buffer passed by the output function, at least until inflateBack() returns. 104017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 104117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateBackInit() must be called first to allocate the internal state 104217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner and to initialize the state with the user-provided window buffer. 104317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateBack() may then be used multiple times to inflate a complete, raw 104417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflate stream with each call. inflateBackEnd() is then called to free the 104517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner allocated state. 104617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 104717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner A raw deflate stream is one with no zlib or gzip header or trailer. 104817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner This routine would normally be used in a utility that reads zip or gzip 104917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner files and writes out uncompressed files. The utility would decode the 105017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner header and process the trailer on its own, hence this routine expects only 105117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the raw deflate stream to decompress. This is different from the normal 105217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner behavior of inflate(), which expects either a zlib or gzip header and 105317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner trailer around the deflate stream. 105417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 105517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateBack() uses two subroutines supplied by the caller that are then 105617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner called by inflateBack() for input and output. inflateBack() calls those 105717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner routines until it reads a complete deflate stream and writes out all of the 105817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uncompressed data, or until it encounters an error. The function's 105917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner parameters and return types are defined above in the in_func and out_func 106017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner typedefs. inflateBack() will call in(in_desc, &buf) which should return the 106117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner number of bytes of provided input, and a pointer to that input in buf. If 106217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner there is no input available, in() must return zero--buf is ignored in that 106317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner case--and inflateBack() will return a buffer error. inflateBack() will call 106417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner out(out_desc, buf, len) to write the uncompressed data buf[0..len-1]. out() 106517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner should return zero on success, or non-zero on failure. If out() returns 106617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner non-zero, inflateBack() will return with an error. Neither in() nor out() 106717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner are permitted to change the contents of the window provided to 106817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateBackInit(), which is also the buffer that out() uses to write from. 106917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The length written by out() will be at most the window size. Any non-zero 107017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner amount of input may be provided by in(). 107117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 107217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner For convenience, inflateBack() can be provided input on the first call by 107317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner setting strm->next_in and strm->avail_in. If that input is exhausted, then 107417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner in() will be called. Therefore strm->next_in must be initialized before 107517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner calling inflateBack(). If strm->next_in is Z_NULL, then in() will be called 107617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner immediately for input. If strm->next_in is not Z_NULL, then strm->avail_in 107717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner must also be initialized, and then if strm->avail_in is not zero, input will 107817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner initially be taken from strm->next_in[0 .. strm->avail_in - 1]. 107917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 108017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The in_desc and out_desc parameters of inflateBack() is passed as the 108117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner first parameter of in() and out() respectively when they are called. These 108217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner descriptors can be optionally used to pass any information that the caller- 108317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner supplied in() and out() functions need to do their job. 108417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 108517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner On return, inflateBack() will set strm->next_in and strm->avail_in to 108617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner pass back any unused input that was provided by the last in() call. The 108717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner return values of inflateBack() can be Z_STREAM_END on success, Z_BUF_ERROR 108817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner if in() or out() returned an error, Z_DATA_ERROR if there was a format error 108917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner in the deflate stream (in which case strm->msg is set to indicate the nature 109017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner of the error), or Z_STREAM_ERROR if the stream was not properly initialized. 109117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner In the case of Z_BUF_ERROR, an input or output error can be distinguished 109217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner using strm->next_in which will be Z_NULL only if in() returned an error. If 109317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner strm->next_in is not Z_NULL, then the Z_BUF_ERROR was due to out() returning 109417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner non-zero. (in() will always be called before out(), so strm->next_in is 109517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner assured to be defined if out() returns non-zero.) Note that inflateBack() 109617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner cannot return Z_OK. 109717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 109817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 109917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflateBackEnd OF((z_streamp strm)); 110017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 110117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner All memory allocated by inflateBackInit() is freed. 110217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 110317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateBackEnd() returns Z_OK on success, or Z_STREAM_ERROR if the stream 110417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner state was inconsistent. 110517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 110617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 110717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN uLong ZEXPORT zlibCompileFlags OF((void)); 110817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* Return flags indicating compile-time options. 110917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 111017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Type sizes, two bits each, 00 = 16 bits, 01 = 32, 10 = 64, 11 = other: 111117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 1.0: size of uInt 111217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 3.2: size of uLong 111317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 5.4: size of voidpf (pointer) 111417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 7.6: size of z_off_t 111517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 111617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Compiler, assembler, and debug options: 111717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 8: DEBUG 111817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 9: ASMV or ASMINF -- use ASM code 111917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 10: ZLIB_WINAPI -- exported functions use the WINAPI calling convention 112017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 11: 0 (reserved) 112117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 112217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner One-time table building (smaller code, but not thread-safe if true): 112317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 12: BUILDFIXED -- build static block decoding tables when needed 112417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 13: DYNAMIC_CRC_TABLE -- build CRC calculation tables when needed 112517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 14,15: 0 (reserved) 112617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 112717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Library content (indicates missing functionality): 112817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 16: NO_GZCOMPRESS -- gz* functions cannot compress (to avoid linking 112917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflate code when not needed) 113017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 17: NO_GZIP -- deflate can't write gzip streams, and inflate can't detect 113117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner and decode gzip streams (to avoid linking crc code) 113217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 18-19: 0 (reserved) 113317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 113417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Operation variations (changes in library functionality): 113517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 20: PKZIP_BUG_WORKAROUND -- slightly more permissive inflate 113617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 21: FASTEST -- deflate algorithm with only one, lowest compression level 113717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 22,23: 0 (reserved) 113817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 113917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The sprintf variant used by gzprintf (zero is best): 114017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 24: 0 = vs*, 1 = s* -- 1 means limited to 20 arguments after the format 114117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 25: 0 = *nprintf, 1 = *printf -- 1 means gzprintf() not secure! 114217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 26: 0 = returns value, 1 = void -- 1 means inferred string length returned 114317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 114417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Remainder: 114517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 27-31: 0 (reserved) 114617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner */ 114717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 114817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#ifndef Z_SOLO 114917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 115017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner /* utility functions */ 115117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 115217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 115317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The following utility functions are implemented on top of the basic 115417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner stream-oriented functions. To simplify the interface, some default options 115517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner are assumed (compression level and memory usage, standard memory allocation 115617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner functions). The source code of these utility functions can be modified if 115717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner you need special options. 115817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 115917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 116017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT compress OF((Bytef *dest, uLongf *destLen, 116117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner const Bytef *source, uLong sourceLen)); 116217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 116317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Compresses the source buffer into the destination buffer. sourceLen is 116417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the byte length of the source buffer. Upon entry, destLen is the total size 116517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner of the destination buffer, which must be at least the value returned by 116617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compressBound(sourceLen). Upon exit, destLen is the actual size of the 116717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compressed buffer. 116817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 116917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compress returns Z_OK if success, Z_MEM_ERROR if there was not 117017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner enough memory, Z_BUF_ERROR if there was not enough room in the output 117117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner buffer. 117217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 117317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 117417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT compress2 OF((Bytef *dest, uLongf *destLen, 117517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner const Bytef *source, uLong sourceLen, 117617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int level)); 117717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 117817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Compresses the source buffer into the destination buffer. The level 117917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner parameter has the same meaning as in deflateInit. sourceLen is the byte 118017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner length of the source buffer. Upon entry, destLen is the total size of the 118117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner destination buffer, which must be at least the value returned by 118217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compressBound(sourceLen). Upon exit, destLen is the actual size of the 118317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compressed buffer. 118417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 118517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough 118617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner memory, Z_BUF_ERROR if there was not enough room in the output buffer, 118717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Z_STREAM_ERROR if the level parameter is invalid. 118817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 118917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 119017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN uLong ZEXPORT compressBound OF((uLong sourceLen)); 119117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 119217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compressBound() returns an upper bound on the compressed size after 119317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compress() or compress2() on sourceLen bytes. It would be used before a 119417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compress() or compress2() call to allocate the destination buffer. 119517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 119617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 119717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT uncompress OF((Bytef *dest, uLongf *destLen, 119817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner const Bytef *source, uLong sourceLen)); 119917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 120017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Decompresses the source buffer into the destination buffer. sourceLen is 120117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the byte length of the source buffer. Upon entry, destLen is the total size 120217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner of the destination buffer, which must be large enough to hold the entire 120317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uncompressed data. (The size of the uncompressed data must have been saved 120417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner previously by the compressor and transmitted to the decompressor by some 120517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner mechanism outside the scope of this compression library.) Upon exit, destLen 120617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner is the actual size of the uncompressed buffer. 120717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 120817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uncompress returns Z_OK if success, Z_MEM_ERROR if there was not 120917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner enough memory, Z_BUF_ERROR if there was not enough room in the output 121017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner buffer, or Z_DATA_ERROR if the input data was corrupted or incomplete. In 121117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the case where there is not enough room, uncompress() will fill the output 121217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner buffer with the uncompressed data up to that point. 121317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 121417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 121517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner /* gzip file access functions */ 121617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 121717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 121817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner This library supports reading and writing files in gzip (.gz) format with 121917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner an interface similar to that of stdio, using the functions that start with 122017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner "gz". The gzip format is different from the zlib format. gzip is a gzip 122117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner wrapper, documented in RFC 1952, wrapped around a deflate stream. 122217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 122317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 122417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turnertypedef struct gzFile_s *gzFile; /* semi-opaque gzip file descriptor */ 122517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 122617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 122717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN gzFile ZEXPORT gzopen OF((const char *path, const char *mode)); 122817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 122917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Opens a gzip (.gz) file for reading or writing. The mode parameter is as 123017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner in fopen ("rb" or "wb") but can also include a compression level ("wb9") or 123117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner a strategy: 'f' for filtered data as in "wb6f", 'h' for Huffman-only 123217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compression as in "wb1h", 'R' for run-length encoding as in "wb1R", or 'F' 123317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner for fixed code compression as in "wb9F". (See the description of 123417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateInit2 for more information about the strategy parameter.) 'T' will 123517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner request transparent writing or appending with no compression and not using 123617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the gzip format. 123717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 123817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner "a" can be used instead of "w" to request that the gzip stream that will 123917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner be written be appended to the file. "+" will result in an error, since 124017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner reading and writing to the same gzip file is not supported. The addition of 124117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner "x" when writing will create the file exclusively, which fails if the file 124217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner already exists. On systems that support it, the addition of "e" when 124317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner reading or writing will set the flag to close the file on an execve() call. 124417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 124517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner These functions, as well as gzip, will read and decode a sequence of gzip 124617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner streams in a file. The append function of gzopen() can be used to create 124717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner such a file. (Also see gzflush() for another way to do this.) When 124817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner appending, gzopen does not test whether the file begins with a gzip stream, 124917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner nor does it look for the end of the gzip streams to begin appending. gzopen 125017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner will simply append a gzip stream to the existing file. 125117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 125217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzopen can be used to read a file which is not in gzip format; in this 125317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner case gzread will directly read from the file without decompression. When 125417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner reading, this will be detected automatically by looking for the magic two- 125517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner byte gzip header. 125617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 125717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzopen returns NULL if the file could not be opened, if there was 125817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner insufficient memory to allocate the gzFile state, or if an invalid mode was 125917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner specified (an 'r', 'w', or 'a' was not provided, or '+' was provided). 126017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner errno can be checked to determine if the reason gzopen failed was that the 126117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner file could not be opened. 126217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 126317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 126417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN gzFile ZEXPORT gzdopen OF((int fd, const char *mode)); 126517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 126617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzdopen associates a gzFile with the file descriptor fd. File descriptors 126717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner are obtained from calls like open, dup, creat, pipe or fileno (if the file 126817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner has been previously opened with fopen). The mode parameter is as in gzopen. 126917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 127017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The next call of gzclose on the returned gzFile will also close the file 127117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner descriptor fd, just like fclose(fdopen(fd, mode)) closes the file descriptor 127217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner fd. If you want to keep fd open, use fd = dup(fd_keep); gz = gzdopen(fd, 127317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner mode);. The duplicated descriptor should be saved to avoid a leak, since 127417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzdopen does not close fd if it fails. If you are using fileno() to get the 127517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner file descriptor from a FILE *, then you will have to use dup() to avoid 127617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner double-close()ing the file descriptor. Both gzclose() and fclose() will 127717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner close the associated file descriptor, so they need to have different file 127817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner descriptors. 127917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 128017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzdopen returns NULL if there was insufficient memory to allocate the 128117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzFile state, if an invalid mode was specified (an 'r', 'w', or 'a' was not 128217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner provided, or '+' was provided), or if fd is -1. The file descriptor is not 128317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner used until the next gz* read, write, seek, or close operation, so gzdopen 128417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner will not detect if fd is invalid (unless fd is -1). 128517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 128617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 128717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT gzbuffer OF((gzFile file, unsigned size)); 128817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 128917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Set the internal buffer size used by this library's functions. The 129017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner default buffer size is 8192 bytes. This function must be called after 129117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzopen() or gzdopen(), and before any other calls that read or write the 129217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner file. The buffer memory allocation is always deferred to the first read or 129317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner write. Two buffers are allocated, either both of the specified size when 129417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner writing, or one of the specified size and the other twice that size when 129517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner reading. A larger buffer size of, for example, 64K or 128K bytes will 129617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner noticeably increase the speed of decompression (reading). 129717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 129817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The new buffer size also affects the maximum length for gzprintf(). 129917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 130017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzbuffer() returns 0 on success, or -1 on failure, such as being called 130117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner too late. 130217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 130317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 130417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT gzsetparams OF((gzFile file, int level, int strategy)); 130517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 130617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Dynamically update the compression level or strategy. See the description 130717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner of deflateInit2 for the meaning of these parameters. 130817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 130917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not 131017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner opened for writing. 131117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 131217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 131317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT gzread OF((gzFile file, voidp buf, unsigned len)); 131417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 131517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Reads the given number of uncompressed bytes from the compressed file. If 131617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the input file is not in gzip format, gzread copies the given number of 131717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner bytes into the buffer directly from the file. 131817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 131917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner After reaching the end of a gzip stream in the input, gzread will continue 132017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner to read, looking for another gzip stream. Any number of gzip streams may be 132117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner concatenated in the input file, and will all be decompressed by gzread(). 132217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If something other than a gzip stream is encountered after a gzip stream, 132317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner that remaining trailing garbage is ignored (and no error is returned). 132417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 132517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzread can be used to read a gzip file that is being concurrently written. 132617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Upon reaching the end of the input, gzread will return with the available 132717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner data. If the error code returned by gzerror is Z_OK or Z_BUF_ERROR, then 132817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzclearerr can be used to clear the end of file indicator in order to permit 132917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzread to be tried again. Z_OK indicates that a gzip stream was completed 133017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner on the last gzread. Z_BUF_ERROR indicates that the input file ended in the 133117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner middle of a gzip stream. Note that gzread does not return -1 in the event 133217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner of an incomplete gzip stream. This error is deferred until gzclose(), which 133317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner will return Z_BUF_ERROR if the last gzread ended in the middle of a gzip 133417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner stream. Alternatively, gzerror can be used before gzclose to detect this 133517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner case. 133617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 133717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzread returns the number of uncompressed bytes actually read, less than 133817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner len for end of file, or -1 for error. 133917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 134017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 134117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT gzwrite OF((gzFile file, 134217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner voidpc buf, unsigned len)); 134317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 134417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Writes the given number of uncompressed bytes into the compressed file. 134517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzwrite returns the number of uncompressed bytes written or 0 in case of 134617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner error. 134717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 134817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 134917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORTVA gzprintf Z_ARG((gzFile file, const char *format, ...)); 135017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 135117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Converts, formats, and writes the arguments to the compressed file under 135217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner control of the format string, as in fprintf. gzprintf returns the number of 135317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uncompressed bytes actually written, or 0 in case of error. The number of 135417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uncompressed bytes written is limited to 8191, or one less than the buffer 135517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner size given to gzbuffer(). The caller should assure that this limit is not 135617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner exceeded. If it is exceeded, then gzprintf() will return an error (0) with 135717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner nothing written. In this case, there may also be a buffer overflow with 135817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner unpredictable consequences, which is possible only if zlib was compiled with 135917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the insecure functions sprintf() or vsprintf() because the secure snprintf() 136017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner or vsnprintf() functions were not available. This can be determined using 136117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner zlibCompileFlags(). 136217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 136317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 136417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT gzputs OF((gzFile file, const char *s)); 136517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 136617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Writes the given null-terminated string to the compressed file, excluding 136717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the terminating null character. 136817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 136917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzputs returns the number of characters written, or -1 in case of error. 137017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 137117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 137217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN char * ZEXPORT gzgets OF((gzFile file, char *buf, int len)); 137317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 137417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Reads bytes from the compressed file until len-1 characters are read, or a 137517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner newline character is read and transferred to buf, or an end-of-file 137617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner condition is encountered. If any characters are read or if len == 1, the 137717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner string is terminated with a null character. If no characters are read due 137817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner to an end-of-file or len < 1, then the buffer is left untouched. 137917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 138017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzgets returns buf which is a null-terminated string, or it returns NULL 138117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner for end-of-file or in case of error. If there was an error, the contents at 138217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner buf are indeterminate. 138317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 138417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 138517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT gzputc OF((gzFile file, int c)); 138617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 138717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Writes c, converted to an unsigned char, into the compressed file. gzputc 138817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner returns the value that was written, or -1 in case of error. 138917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 139017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 139117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT gzgetc OF((gzFile file)); 139217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 139317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Reads one byte from the compressed file. gzgetc returns this byte or -1 139417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner in case of end of file or error. This is implemented as a macro for speed. 139517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner As such, it does not do all of the checking the other functions do. I.e. 139617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner it does not check to see if file is NULL, nor whether the structure file 139717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner points to has been clobbered or not. 139817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 139917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 140017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT gzungetc OF((int c, gzFile file)); 140117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 140217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Push one character back onto the stream to be read as the first character 140317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner on the next read. At least one character of push-back is allowed. 140417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzungetc() returns the character pushed, or -1 on failure. gzungetc() will 140517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner fail if c is -1, and may fail if a character has been pushed but not read 140617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner yet. If gzungetc is used immediately after gzopen or gzdopen, at least the 140717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner output buffer size of pushed characters is allowed. (See gzbuffer above.) 140817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The pushed character will be discarded if the stream is repositioned with 140917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzseek() or gzrewind(). 141017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 141117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 141217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT gzflush OF((gzFile file, int flush)); 141317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 141417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Flushes all pending output into the compressed file. The parameter flush 141517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner is as in the deflate() function. The return value is the zlib error number 141617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner (see function gzerror below). gzflush is only permitted when writing. 141717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 141817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If the flush parameter is Z_FINISH, the remaining data is written and the 141917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzip stream is completed in the output. If gzwrite() is called again, a new 142017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzip stream will be started in the output. gzread() is able to read such 142117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner concatented gzip streams. 142217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 142317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzflush should be called only when strictly necessary because it will 142417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner degrade compression if called too often. 142517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 142617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 142717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 142817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN z_off_t ZEXPORT gzseek OF((gzFile file, 142917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner z_off_t offset, int whence)); 143017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 143117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Sets the starting position for the next gzread or gzwrite on the given 143217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compressed file. The offset represents a number of bytes in the 143317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uncompressed data stream. The whence parameter is defined as in lseek(2); 143417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the value SEEK_END is not supported. 143517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 143617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If the file is opened for reading, this function is emulated but can be 143717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner extremely slow. If the file is opened for writing, only forward seeks are 143817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner supported; gzseek then compresses a sequence of zeroes up to the new 143917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner starting position. 144017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 144117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzseek returns the resulting offset location as measured in bytes from 144217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner the beginning of the uncompressed stream, or -1 in case of error, in 144317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner particular if the file is opened for writing and the new starting position 144417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner would be before the current position. 144517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 144617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 144717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT gzrewind OF((gzFile file)); 144817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 144917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Rewinds the given file. This function is supported only for reading. 145017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 145117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET) 145217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 145317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 145417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 145517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN z_off_t ZEXPORT gztell OF((gzFile file)); 145617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 145717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Returns the starting position for the next gzread or gzwrite on the given 145817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compressed file. This position represents a number of bytes in the 145917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uncompressed data stream, and is zero when starting, even if appending or 146017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner reading a gzip stream from the middle of a file using gzdopen(). 146117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 146217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR) 146317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 146417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 146517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 146617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN z_off_t ZEXPORT gzoffset OF((gzFile file)); 146717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 146817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Returns the current offset in the file being read or written. This offset 146917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner includes the count of bytes that precede the gzip stream, for example when 147017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner appending or when using gzdopen() for reading. When reading, the offset 147117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner does not include as yet unused buffered input. This information can be used 147217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner for a progress indicator. On error, gzoffset() returns -1. 147317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 147417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 147517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT gzeof OF((gzFile file)); 147617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 147717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Returns true (1) if the end-of-file indicator has been set while reading, 147817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner false (0) otherwise. Note that the end-of-file indicator is set only if the 147917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner read tried to go past the end of the input, but came up short. Therefore, 148017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner just like feof(), gzeof() may return false even if there is no more data to 148117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner read, in the event that the last read request was for the exact number of 148217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner bytes remaining in the input file. This will happen if the input file size 148317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner is an exact multiple of the buffer size. 148417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 148517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If gzeof() returns true, then the read functions will return no more data, 148617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner unless the end-of-file indicator is reset by gzclearerr() and the input file 148717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner has grown since the previous end of file was detected. 148817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 148917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 149017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT gzdirect OF((gzFile file)); 149117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 149217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Returns true (1) if file is being copied directly while reading, or false 149317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner (0) if file is a gzip stream being decompressed. 149417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 149517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If the input file is empty, gzdirect() will return true, since the input 149617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner does not contain a gzip stream. 149717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 149817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner If gzdirect() is used immediately after gzopen() or gzdopen() it will 149917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner cause buffers to be allocated to allow reading the file to determine if it 150017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner is a gzip file. Therefore if gzbuffer() is used, it should be called before 150117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzdirect(). 150217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 150317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner When writing, gzdirect() returns true (1) if transparent writing was 150417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner requested ("wT" for the gzopen() mode), or false (0) otherwise. (Note: 150517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzdirect() is not needed when writing. Transparent writing must be 150617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner explicitly requested, so the application already knows the answer. When 150717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner linking statically, using gzdirect() will include all of the zlib code for 150817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzip file reading and decompression, which may not be desired.) 150917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 151017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 151117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT gzclose OF((gzFile file)); 151217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 151317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Flushes all pending output if necessary, closes the compressed file and 151417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deallocates the (de)compression state. Note that once file is closed, you 151517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner cannot call gzerror with file, since its structures have been deallocated. 151617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzclose must not be called more than once on the same file, just as free 151717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner must not be called more than once on the same allocation. 151817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 151917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzclose will return Z_STREAM_ERROR if file is not valid, Z_ERRNO on a 152017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner file operation error, Z_MEM_ERROR if out of memory, Z_BUF_ERROR if the 152117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner last read ended in the middle of a gzip stream, or Z_OK on success. 152217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 152317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 152417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT gzclose_r OF((gzFile file)); 152517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT gzclose_w OF((gzFile file)); 152617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 152717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Same as gzclose(), but gzclose_r() is only for use when reading, and 152817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzclose_w() is only for use when writing or appending. The advantage to 152917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner using these instead of gzclose() is that they avoid linking in zlib 153017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compression or decompression code that is not used when only reading or only 153117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner writing respectively. If gzclose() is used, then both compression and 153217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner decompression code will be included the application when linking to a static 153317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner zlib library. 153417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 153517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 153617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN const char * ZEXPORT gzerror OF((gzFile file, int *errnum)); 153717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 153817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Returns the error message for the last error which occurred on the given 153917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner compressed file. errnum is set to zlib error number. If an error occurred 154017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner in the file system and not in the compression library, errnum is set to 154117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Z_ERRNO and the application may consult errno to get the exact error code. 154217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 154317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner The application must not modify the returned string. Future calls to 154417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner this function may invalidate the previously returned string. If file is 154517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner closed, then the string previously returned by gzerror will no longer be 154617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner available. 154717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 154817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner gzerror() should be used to distinguish errors from end-of-file for those 154917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner functions above that do not distinguish those cases in their return values. 155017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 155117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 155217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN void ZEXPORT gzclearerr OF((gzFile file)); 155317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 155417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Clears the error and end-of-file flags for file. This is analogous to the 155517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner clearerr() function in stdio. This is useful for continuing to read a gzip 155617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner file that is being written concurrently. 155717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 155817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 155917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#endif /* !Z_SOLO */ 156017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 156117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner /* checksum functions */ 156217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 156317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 156417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner These functions are not related to compression but are exported 156517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner anyway because they might be useful in applications using the compression 156617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner library. 156717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 156817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 156917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN uLong ZEXPORT adler32 OF((uLong adler, const Bytef *buf, uInt len)); 157017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 157117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Update a running Adler-32 checksum with the bytes buf[0..len-1] and 157217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner return the updated checksum. If buf is Z_NULL, this function returns the 157317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner required initial value for the checksum. 157417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 157517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner An Adler-32 checksum is almost as reliable as a CRC32 but can be computed 157617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner much faster. 157717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 157817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Usage example: 157917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 158017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uLong adler = adler32(0L, Z_NULL, 0); 158117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 158217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner while (read_buffer(buffer, length) != EOF) { 158317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner adler = adler32(adler, buffer, length); 158417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner } 158517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner if (adler != original_adler) error(); 158617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 158717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 158817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 158917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN uLong ZEXPORT adler32_combine OF((uLong adler1, uLong adler2, 159017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner z_off_t len2)); 159117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 159217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Combine two Adler-32 checksums into one. For two sequences of bytes, seq1 159317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner and seq2 with lengths len1 and len2, Adler-32 checksums were calculated for 159417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner each, adler1 and adler2. adler32_combine() returns the Adler-32 checksum of 159517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner seq1 and seq2 concatenated, requiring only adler1, adler2, and len2. Note 159617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner that the z_off_t type (like off_t) is a signed integer. If len2 is 159717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner negative, the result has no meaning or utility. 159817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 159917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 160017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN uLong ZEXPORT crc32 OF((uLong crc, const Bytef *buf, uInt len)); 160117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 160217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Update a running CRC-32 with the bytes buf[0..len-1] and return the 160317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner updated CRC-32. If buf is Z_NULL, this function returns the required 160417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner initial value for the crc. Pre- and post-conditioning (one's complement) is 160517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner performed within this function so it shouldn't be done by the application. 160617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 160717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Usage example: 160817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 160917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner uLong crc = crc32(0L, Z_NULL, 0); 161017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 161117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner while (read_buffer(buffer, length) != EOF) { 161217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner crc = crc32(crc, buffer, length); 161317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner } 161417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner if (crc != original_crc) error(); 161517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 161617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 161717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* 161817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN uLong ZEXPORT crc32_combine OF((uLong crc1, uLong crc2, z_off_t len2)); 161917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 162017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner Combine two CRC-32 check values into one. For two sequences of bytes, 162117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner seq1 and seq2 with lengths len1 and len2, CRC-32 check values were 162217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner calculated for each, crc1 and crc2. crc32_combine() returns the CRC-32 162317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner check value of seq1 and seq2 concatenated, requiring only crc1, crc2, and 162417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner len2. 162517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner*/ 162617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 162717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 162817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner /* various hacks, don't look :) */ 162917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 163017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* deflateInit and inflateInit are macros to allow checking the zlib version 163117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner * and the compiler's view of z_stream: 163217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner */ 163317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT deflateInit_ OF((z_streamp strm, int level, 163417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner const char *version, int stream_size)); 163517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflateInit_ OF((z_streamp strm, 163617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner const char *version, int stream_size)); 163717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT deflateInit2_ OF((z_streamp strm, int level, int method, 163817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int windowBits, int memLevel, 163917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int strategy, const char *version, 164017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int stream_size)); 164117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflateInit2_ OF((z_streamp strm, int windowBits, 164217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner const char *version, int stream_size)); 164317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflateBackInit_ OF((z_streamp strm, int windowBits, 164417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner unsigned char FAR *window, 164517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner const char *version, 164617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner int stream_size)); 164717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define deflateInit(strm, level) \ 164817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateInit_((strm), (level), ZLIB_VERSION, (int)sizeof(z_stream)) 164917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define inflateInit(strm) \ 165017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateInit_((strm), ZLIB_VERSION, (int)sizeof(z_stream)) 165117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \ 165217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\ 165317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner (strategy), ZLIB_VERSION, (int)sizeof(z_stream)) 165417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define inflateInit2(strm, windowBits) \ 165517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateInit2_((strm), (windowBits), ZLIB_VERSION, \ 165617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner (int)sizeof(z_stream)) 165717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#define inflateBackInit(strm, windowBits, window) \ 165817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner inflateBackInit_((strm), (windowBits), (window), \ 165917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZLIB_VERSION, (int)sizeof(z_stream)) 166017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 166117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#ifndef Z_SOLO 166217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 166317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* gzgetc() macro and its supporting function and exposed data structure. Note 166417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner * that the real internal state is much larger than the exposed structure. 166517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner * This abbreviated structure exposes just enough for the gzgetc() macro. The 166617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner * user should not mess with these exposed elements, since their names or 166717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner * behavior could change in the future, perhaps even capriciously. They can 166817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner * only be used by the gzgetc() macro. You have been warned. 166917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner */ 167017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turnerstruct gzFile_s { 167117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner unsigned have; 167217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner unsigned char *next; 167317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner z_off64_t pos; 167417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner}; 167517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT gzgetc_ OF((gzFile file)); /* backward compatibility */ 167617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#ifdef Z_PREFIX_SET 167717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# undef z_gzgetc 167817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# define z_gzgetc(g) \ 167917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g)) 168017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#else 168117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# define gzgetc(g) \ 168217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g)) 168317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#endif 168417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 168517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* provide 64-bit offset functions if _LARGEFILE64_SOURCE defined, and/or 168617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner * change the regular functions to 64 bits if _FILE_OFFSET_BITS is 64 (if 168717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner * both are true, the application gets the *64 functions, and the regular 168817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner * functions are changed to 64 bits) -- in case these are set on systems 168917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner * without large file support, _LFS64_LARGEFILE must also be true 169017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner */ 169117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#ifdef Z_LARGE64 169217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN gzFile ZEXPORT gzopen64 OF((const char *, const char *)); 169317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN z_off64_t ZEXPORT gzseek64 OF((gzFile, z_off64_t, int)); 169417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN z_off64_t ZEXPORT gztell64 OF((gzFile)); 169517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN z_off64_t ZEXPORT gzoffset64 OF((gzFile)); 169617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, z_off64_t)); 169717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, z_off64_t)); 169817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#endif 169917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 170017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#if !defined(ZLIB_INTERNAL) && defined(Z_WANT64) 170117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# ifdef Z_PREFIX_SET 170217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# define z_gzopen z_gzopen64 170317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# define z_gzseek z_gzseek64 170417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# define z_gztell z_gztell64 170517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# define z_gzoffset z_gzoffset64 170617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# define z_adler32_combine z_adler32_combine64 170717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# define z_crc32_combine z_crc32_combine64 170817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# else 170917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# define gzopen gzopen64 171017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# define gzseek gzseek64 171117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# define gztell gztell64 171217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# define gzoffset gzoffset64 171317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# define adler32_combine adler32_combine64 171417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# define crc32_combine crc32_combine64 171517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# endif 171617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# ifndef Z_LARGE64 171717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN gzFile ZEXPORT gzopen64 OF((const char *, const char *)); 171817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN z_off_t ZEXPORT gzseek64 OF((gzFile, z_off_t, int)); 171917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN z_off_t ZEXPORT gztell64 OF((gzFile)); 172017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN z_off_t ZEXPORT gzoffset64 OF((gzFile)); 172117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, z_off_t)); 172217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, z_off_t)); 172317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# endif 172417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#else 172517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN gzFile ZEXPORT gzopen OF((const char *, const char *)); 172617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile, z_off_t, int)); 172717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN z_off_t ZEXPORT gztell OF((gzFile)); 172817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN z_off_t ZEXPORT gzoffset OF((gzFile)); 172917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN uLong ZEXPORT adler32_combine OF((uLong, uLong, z_off_t)); 173017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t)); 173117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#endif 173217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 173317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#else /* Z_SOLO */ 173417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 173517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN uLong ZEXPORT adler32_combine OF((uLong, uLong, z_off_t)); 173617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t)); 173717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 173817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#endif /* !Z_SOLO */ 173917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 174017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* hack for buggy compilers */ 174117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#if !defined(ZUTIL_H) && !defined(NO_DUMMY_DECL) 174217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner struct internal_state {int dummy;}; 174317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#endif 174417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 174517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner/* undocumented functions */ 174617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN const char * ZEXPORT zError OF((int)); 174717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflateSyncPoint OF((z_streamp)); 174817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN const z_crc_t FAR * ZEXPORT get_crc_table OF((void)); 174917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflateUndermine OF((z_streamp, int)); 175017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT inflateResetKeep OF((z_streamp)); 175117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORT deflateResetKeep OF((z_streamp)); 175217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#if defined(_WIN32) && !defined(Z_SOLO) 175317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN gzFile ZEXPORT gzopen_w OF((const wchar_t *path, 175417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner const char *mode)); 175517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#endif 175617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#if defined(STDC) || defined(Z_HAVE_STDARG_H) 175717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# ifndef Z_SOLO 175817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' TurnerZEXTERN int ZEXPORTVA gzvprintf Z_ARG((gzFile file, 175917b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner const char *format, 176017b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner va_list va)); 176117b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner# endif 176217b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#endif 176317b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 176417b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#ifdef __cplusplus 176517b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner} 176617b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#endif 176717b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner 176817b20e6f38ad2263e47a6884c4f68ce9773d8b29David 'Digit' Turner#endif /* ZLIB_H */ 1769