lemon-project-template-glpk
diff deps/glpk/src/zlib/zlib.h @ 9:33de93886c88
Import GLPK 4.47
author | Alpar Juttner <alpar@cs.elte.hu> |
---|---|
date | Sun, 06 Nov 2011 20:59:10 +0100 |
parents | |
children |
line diff
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/deps/glpk/src/zlib/zlib.h Sun Nov 06 20:59:10 2011 +0100 1.3 @@ -0,0 +1,1613 @@ 1.4 +/* zlib.h -- interface of the 'zlib' general purpose compression library 1.5 + version 1.2.5, April 19th, 2010 1.6 + 1.7 + Copyright (C) 1995-2010 Jean-loup Gailly and Mark Adler 1.8 + 1.9 + This software is provided 'as-is', without any express or implied 1.10 + warranty. In no event will the authors be held liable for any damages 1.11 + arising from the use of this software. 1.12 + 1.13 + Permission is granted to anyone to use this software for any purpose, 1.14 + including commercial applications, and to alter it and redistribute it 1.15 + freely, subject to the following restrictions: 1.16 + 1.17 + 1. The origin of this software must not be misrepresented; you must not 1.18 + claim that you wrote the original software. If you use this software 1.19 + in a product, an acknowledgment in the product documentation would be 1.20 + appreciated but is not required. 1.21 + 2. Altered source versions must be plainly marked as such, and must not be 1.22 + misrepresented as being the original software. 1.23 + 3. This notice may not be removed or altered from any source distribution. 1.24 + 1.25 + Jean-loup Gailly Mark Adler 1.26 + jloup@gzip.org madler@alumni.caltech.edu 1.27 + 1.28 + 1.29 + The data format used by the zlib library is described by RFCs (Request for 1.30 + Comments) 1950 to 1952 in the files http://www.ietf.org/rfc/rfc1950.txt 1.31 + (zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format). 1.32 +*/ 1.33 + 1.34 +#ifndef ZLIB_H 1.35 +#define ZLIB_H 1.36 + 1.37 +#include "zconf.h" 1.38 + 1.39 +#ifdef __cplusplus 1.40 +extern "C" { 1.41 +#endif 1.42 + 1.43 +#define ZLIB_VERSION "1.2.5" 1.44 +#define ZLIB_VERNUM 0x1250 1.45 +#define ZLIB_VER_MAJOR 1 1.46 +#define ZLIB_VER_MINOR 2 1.47 +#define ZLIB_VER_REVISION 5 1.48 +#define ZLIB_VER_SUBREVISION 0 1.49 + 1.50 +/* 1.51 + The 'zlib' compression library provides in-memory compression and 1.52 + decompression functions, including integrity checks of the uncompressed data. 1.53 + This version of the library supports only one compression method (deflation) 1.54 + but other algorithms will be added later and will have the same stream 1.55 + interface. 1.56 + 1.57 + Compression can be done in a single step if the buffers are large enough, 1.58 + or can be done by repeated calls of the compression function. In the latter 1.59 + case, the application must provide more input and/or consume the output 1.60 + (providing more output space) before each call. 1.61 + 1.62 + The compressed data format used by default by the in-memory functions is 1.63 + the zlib format, which is a zlib wrapper documented in RFC 1950, wrapped 1.64 + around a deflate stream, which is itself documented in RFC 1951. 1.65 + 1.66 + The library also supports reading and writing files in gzip (.gz) format 1.67 + with an interface similar to that of stdio using the functions that start 1.68 + with "gz". The gzip format is different from the zlib format. gzip is a 1.69 + gzip wrapper, documented in RFC 1952, wrapped around a deflate stream. 1.70 + 1.71 + This library can optionally read and write gzip streams in memory as well. 1.72 + 1.73 + The zlib format was designed to be compact and fast for use in memory 1.74 + and on communications channels. The gzip format was designed for single- 1.75 + file compression on file systems, has a larger header than zlib to maintain 1.76 + directory information, and uses a different, slower check method than zlib. 1.77 + 1.78 + The library does not install any signal handler. The decoder checks 1.79 + the consistency of the compressed data, so the library should never crash 1.80 + even in case of corrupted input. 1.81 +*/ 1.82 + 1.83 +typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size)); 1.84 +typedef void (*free_func) OF((voidpf opaque, voidpf address)); 1.85 + 1.86 +struct internal_state; 1.87 + 1.88 +typedef struct z_stream_s { 1.89 + Bytef *next_in; /* next input byte */ 1.90 + uInt avail_in; /* number of bytes available at next_in */ 1.91 + uLong total_in; /* total nb of input bytes read so far */ 1.92 + 1.93 + Bytef *next_out; /* next output byte should be put there */ 1.94 + uInt avail_out; /* remaining free space at next_out */ 1.95 + uLong total_out; /* total nb of bytes output so far */ 1.96 + 1.97 + char *msg; /* last error message, NULL if no error */ 1.98 + struct internal_state FAR *state; /* not visible by applications */ 1.99 + 1.100 + alloc_func zalloc; /* used to allocate the internal state */ 1.101 + free_func zfree; /* used to free the internal state */ 1.102 + voidpf opaque; /* private data object passed to zalloc and zfree */ 1.103 + 1.104 + int data_type; /* best guess about the data type: binary or text */ 1.105 + uLong adler; /* adler32 value of the uncompressed data */ 1.106 + uLong reserved; /* reserved for future use */ 1.107 +} z_stream; 1.108 + 1.109 +typedef z_stream FAR *z_streamp; 1.110 + 1.111 +/* 1.112 + gzip header information passed to and from zlib routines. See RFC 1952 1.113 + for more details on the meanings of these fields. 1.114 +*/ 1.115 +typedef struct gz_header_s { 1.116 + int text; /* true if compressed data believed to be text */ 1.117 + uLong time; /* modification time */ 1.118 + int xflags; /* extra flags (not used when writing a gzip file) */ 1.119 + int os; /* operating system */ 1.120 + Bytef *extra; /* pointer to extra field or Z_NULL if none */ 1.121 + uInt extra_len; /* extra field length (valid if extra != Z_NULL) */ 1.122 + uInt extra_max; /* space at extra (only when reading header) */ 1.123 + Bytef *name; /* pointer to zero-terminated file name or Z_NULL */ 1.124 + uInt name_max; /* space at name (only when reading header) */ 1.125 + Bytef *comment; /* pointer to zero-terminated comment or Z_NULL */ 1.126 + uInt comm_max; /* space at comment (only when reading header) */ 1.127 + int hcrc; /* true if there was or will be a header crc */ 1.128 + int done; /* true when done reading gzip header (not used 1.129 + when writing a gzip file) */ 1.130 +} gz_header; 1.131 + 1.132 +typedef gz_header FAR *gz_headerp; 1.133 + 1.134 +/* 1.135 + The application must update next_in and avail_in when avail_in has dropped 1.136 + to zero. It must update next_out and avail_out when avail_out has dropped 1.137 + to zero. The application must initialize zalloc, zfree and opaque before 1.138 + calling the init function. All other fields are set by the compression 1.139 + library and must not be updated by the application. 1.140 + 1.141 + The opaque value provided by the application will be passed as the first 1.142 + parameter for calls of zalloc and zfree. This can be useful for custom 1.143 + memory management. The compression library attaches no meaning to the 1.144 + opaque value. 1.145 + 1.146 + zalloc must return Z_NULL if there is not enough memory for the object. 1.147 + If zlib is used in a multi-threaded application, zalloc and zfree must be 1.148 + thread safe. 1.149 + 1.150 + On 16-bit systems, the functions zalloc and zfree must be able to allocate 1.151 + exactly 65536 bytes, but will not be required to allocate more than this if 1.152 + the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS, pointers 1.153 + returned by zalloc for objects of exactly 65536 bytes *must* have their 1.154 + offset normalized to zero. The default allocation function provided by this 1.155 + library ensures this (see zutil.c). To reduce memory requirements and avoid 1.156 + any allocation of 64K objects, at the expense of compression ratio, compile 1.157 + the library with -DMAX_WBITS=14 (see zconf.h). 1.158 + 1.159 + The fields total_in and total_out can be used for statistics or progress 1.160 + reports. After compression, total_in holds the total size of the 1.161 + uncompressed data and may be saved for use in the decompressor (particularly 1.162 + if the decompressor wants to decompress everything in a single step). 1.163 +*/ 1.164 + 1.165 + /* constants */ 1.166 + 1.167 +#define Z_NO_FLUSH 0 1.168 +#define Z_PARTIAL_FLUSH 1 1.169 +#define Z_SYNC_FLUSH 2 1.170 +#define Z_FULL_FLUSH 3 1.171 +#define Z_FINISH 4 1.172 +#define Z_BLOCK 5 1.173 +#define Z_TREES 6 1.174 +/* Allowed flush values; see deflate() and inflate() below for details */ 1.175 + 1.176 +#define Z_OK 0 1.177 +#define Z_STREAM_END 1 1.178 +#define Z_NEED_DICT 2 1.179 +#define Z_ERRNO (-1) 1.180 +#define Z_STREAM_ERROR (-2) 1.181 +#define Z_DATA_ERROR (-3) 1.182 +#define Z_MEM_ERROR (-4) 1.183 +#define Z_BUF_ERROR (-5) 1.184 +#define Z_VERSION_ERROR (-6) 1.185 +/* Return codes for the compression/decompression functions. Negative values 1.186 + * are errors, positive values are used for special but normal events. 1.187 + */ 1.188 + 1.189 +#define Z_NO_COMPRESSION 0 1.190 +#define Z_BEST_SPEED 1 1.191 +#define Z_BEST_COMPRESSION 9 1.192 +#define Z_DEFAULT_COMPRESSION (-1) 1.193 +/* compression levels */ 1.194 + 1.195 +#define Z_FILTERED 1 1.196 +#define Z_HUFFMAN_ONLY 2 1.197 +#define Z_RLE 3 1.198 +#define Z_FIXED 4 1.199 +#define Z_DEFAULT_STRATEGY 0 1.200 +/* compression strategy; see deflateInit2() below for details */ 1.201 + 1.202 +#define Z_BINARY 0 1.203 +#define Z_TEXT 1 1.204 +#define Z_ASCII Z_TEXT /* for compatibility with 1.2.2 and earlier */ 1.205 +#define Z_UNKNOWN 2 1.206 +/* Possible values of the data_type field (though see inflate()) */ 1.207 + 1.208 +#define Z_DEFLATED 8 1.209 +/* The deflate compression method (the only one supported in this version) */ 1.210 + 1.211 +#define Z_NULL 0 /* for initializing zalloc, zfree, opaque */ 1.212 + 1.213 +#define zlib_version zlibVersion() 1.214 +/* for compatibility with versions < 1.0.2 */ 1.215 + 1.216 + 1.217 + /* basic functions */ 1.218 + 1.219 +ZEXTERN const char * ZEXPORT zlibVersion OF((void)); 1.220 +/* The application can compare zlibVersion and ZLIB_VERSION for consistency. 1.221 + If the first character differs, the library code actually used is not 1.222 + compatible with the zlib.h header file used by the application. This check 1.223 + is automatically made by deflateInit and inflateInit. 1.224 + */ 1.225 + 1.226 +/* 1.227 +ZEXTERN int ZEXPORT deflateInit OF((z_streamp strm, int level)); 1.228 + 1.229 + Initializes the internal stream state for compression. The fields 1.230 + zalloc, zfree and opaque must be initialized before by the caller. If 1.231 + zalloc and zfree are set to Z_NULL, deflateInit updates them to use default 1.232 + allocation functions. 1.233 + 1.234 + The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9: 1.235 + 1 gives best speed, 9 gives best compression, 0 gives no compression at all 1.236 + (the input data is simply copied a block at a time). Z_DEFAULT_COMPRESSION 1.237 + requests a default compromise between speed and compression (currently 1.238 + equivalent to level 6). 1.239 + 1.240 + deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough 1.241 + memory, Z_STREAM_ERROR if level is not a valid compression level, or 1.242 + Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible 1.243 + with the version assumed by the caller (ZLIB_VERSION). msg is set to null 1.244 + if there is no error message. deflateInit does not perform any compression: 1.245 + this will be done by deflate(). 1.246 +*/ 1.247 + 1.248 + 1.249 +ZEXTERN int ZEXPORT deflate OF((z_streamp strm, int flush)); 1.250 +/* 1.251 + deflate compresses as much data as possible, and stops when the input 1.252 + buffer becomes empty or the output buffer becomes full. It may introduce 1.253 + some output latency (reading input without producing any output) except when 1.254 + forced to flush. 1.255 + 1.256 + The detailed semantics are as follows. deflate performs one or both of the 1.257 + following actions: 1.258 + 1.259 + - Compress more input starting at next_in and update next_in and avail_in 1.260 + accordingly. If not all input can be processed (because there is not 1.261 + enough room in the output buffer), next_in and avail_in are updated and 1.262 + processing will resume at this point for the next call of deflate(). 1.263 + 1.264 + - Provide more output starting at next_out and update next_out and avail_out 1.265 + accordingly. This action is forced if the parameter flush is non zero. 1.266 + Forcing flush frequently degrades the compression ratio, so this parameter 1.267 + should be set only when necessary (in interactive applications). Some 1.268 + output may be provided even if flush is not set. 1.269 + 1.270 + Before the call of deflate(), the application should ensure that at least 1.271 + one of the actions is possible, by providing more input and/or consuming more 1.272 + output, and updating avail_in or avail_out accordingly; avail_out should 1.273 + never be zero before the call. The application can consume the compressed 1.274 + output when it wants, for example when the output buffer is full (avail_out 1.275 + == 0), or after each call of deflate(). If deflate returns Z_OK and with 1.276 + zero avail_out, it must be called again after making room in the output 1.277 + buffer because there might be more output pending. 1.278 + 1.279 + Normally the parameter flush is set to Z_NO_FLUSH, which allows deflate to 1.280 + decide how much data to accumulate before producing output, in order to 1.281 + maximize compression. 1.282 + 1.283 + If the parameter flush is set to Z_SYNC_FLUSH, all pending output is 1.284 + flushed to the output buffer and the output is aligned on a byte boundary, so 1.285 + that the decompressor can get all input data available so far. (In 1.286 + particular avail_in is zero after the call if enough output space has been 1.287 + provided before the call.) Flushing may degrade compression for some 1.288 + compression algorithms and so it should be used only when necessary. This 1.289 + completes the current deflate block and follows it with an empty stored block 1.290 + that is three bits plus filler bits to the next byte, followed by four bytes 1.291 + (00 00 ff ff). 1.292 + 1.293 + If flush is set to Z_PARTIAL_FLUSH, all pending output is flushed to the 1.294 + output buffer, but the output is not aligned to a byte boundary. All of the 1.295 + input data so far will be available to the decompressor, as for Z_SYNC_FLUSH. 1.296 + This completes the current deflate block and follows it with an empty fixed 1.297 + codes block that is 10 bits long. This assures that enough bytes are output 1.298 + in order for the decompressor to finish the block before the empty fixed code 1.299 + block. 1.300 + 1.301 + If flush is set to Z_BLOCK, a deflate block is completed and emitted, as 1.302 + for Z_SYNC_FLUSH, but the output is not aligned on a byte boundary, and up to 1.303 + seven bits of the current block are held to be written as the next byte after 1.304 + the next deflate block is completed. In this case, the decompressor may not 1.305 + be provided enough bits at this point in order to complete decompression of 1.306 + the data provided so far to the compressor. It may need to wait for the next 1.307 + block to be emitted. This is for advanced applications that need to control 1.308 + the emission of deflate blocks. 1.309 + 1.310 + If flush is set to Z_FULL_FLUSH, all output is flushed as with 1.311 + Z_SYNC_FLUSH, and the compression state is reset so that decompression can 1.312 + restart from this point if previous compressed data has been damaged or if 1.313 + random access is desired. Using Z_FULL_FLUSH too often can seriously degrade 1.314 + compression. 1.315 + 1.316 + If deflate returns with avail_out == 0, this function must be called again 1.317 + with the same value of the flush parameter and more output space (updated 1.318 + avail_out), until the flush is complete (deflate returns with non-zero 1.319 + avail_out). In the case of a Z_FULL_FLUSH or Z_SYNC_FLUSH, make sure that 1.320 + avail_out is greater than six to avoid repeated flush markers due to 1.321 + avail_out == 0 on return. 1.322 + 1.323 + If the parameter flush is set to Z_FINISH, pending input is processed, 1.324 + pending output is flushed and deflate returns with Z_STREAM_END if there was 1.325 + enough output space; if deflate returns with Z_OK, this function must be 1.326 + called again with Z_FINISH and more output space (updated avail_out) but no 1.327 + more input data, until it returns with Z_STREAM_END or an error. After 1.328 + deflate has returned Z_STREAM_END, the only possible operations on the stream 1.329 + are deflateReset or deflateEnd. 1.330 + 1.331 + Z_FINISH can be used immediately after deflateInit if all the compression 1.332 + is to be done in a single step. In this case, avail_out must be at least the 1.333 + value returned by deflateBound (see below). If deflate does not return 1.334 + Z_STREAM_END, then it must be called again as described above. 1.335 + 1.336 + deflate() sets strm->adler to the adler32 checksum of all input read 1.337 + so far (that is, total_in bytes). 1.338 + 1.339 + deflate() may update strm->data_type if it can make a good guess about 1.340 + the input data type (Z_BINARY or Z_TEXT). In doubt, the data is considered 1.341 + binary. This field is only for information purposes and does not affect the 1.342 + compression algorithm in any manner. 1.343 + 1.344 + deflate() returns Z_OK if some progress has been made (more input 1.345 + processed or more output produced), Z_STREAM_END if all input has been 1.346 + consumed and all output has been produced (only when flush is set to 1.347 + Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example 1.348 + if next_in or next_out was Z_NULL), Z_BUF_ERROR if no progress is possible 1.349 + (for example avail_in or avail_out was zero). Note that Z_BUF_ERROR is not 1.350 + fatal, and deflate() can be called again with more input and more output 1.351 + space to continue compressing. 1.352 +*/ 1.353 + 1.354 + 1.355 +ZEXTERN int ZEXPORT deflateEnd OF((z_streamp strm)); 1.356 +/* 1.357 + All dynamically allocated data structures for this stream are freed. 1.358 + This function discards any unprocessed input and does not flush any pending 1.359 + output. 1.360 + 1.361 + deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the 1.362 + stream state was inconsistent, Z_DATA_ERROR if the stream was freed 1.363 + prematurely (some input or output was discarded). In the error case, msg 1.364 + may be set but then points to a static string (which must not be 1.365 + deallocated). 1.366 +*/ 1.367 + 1.368 + 1.369 +/* 1.370 +ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm)); 1.371 + 1.372 + Initializes the internal stream state for decompression. The fields 1.373 + next_in, avail_in, zalloc, zfree and opaque must be initialized before by 1.374 + the caller. If next_in is not Z_NULL and avail_in is large enough (the 1.375 + exact value depends on the compression method), inflateInit determines the 1.376 + compression method from the zlib header and allocates all data structures 1.377 + accordingly; otherwise the allocation will be deferred to the first call of 1.378 + inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them to 1.379 + use default allocation functions. 1.380 + 1.381 + inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough 1.382 + memory, Z_VERSION_ERROR if the zlib library version is incompatible with the 1.383 + version assumed by the caller, or Z_STREAM_ERROR if the parameters are 1.384 + invalid, such as a null pointer to the structure. msg is set to null if 1.385 + there is no error message. inflateInit does not perform any decompression 1.386 + apart from possibly reading the zlib header if present: actual decompression 1.387 + will be done by inflate(). (So next_in and avail_in may be modified, but 1.388 + next_out and avail_out are unused and unchanged.) The current implementation 1.389 + of inflateInit() does not process any header information -- that is deferred 1.390 + until inflate() is called. 1.391 +*/ 1.392 + 1.393 + 1.394 +ZEXTERN int ZEXPORT inflate OF((z_streamp strm, int flush)); 1.395 +/* 1.396 + inflate decompresses as much data as possible, and stops when the input 1.397 + buffer becomes empty or the output buffer becomes full. It may introduce 1.398 + some output latency (reading input without producing any output) except when 1.399 + forced to flush. 1.400 + 1.401 + The detailed semantics are as follows. inflate performs one or both of the 1.402 + following actions: 1.403 + 1.404 + - Decompress more input starting at next_in and update next_in and avail_in 1.405 + accordingly. If not all input can be processed (because there is not 1.406 + enough room in the output buffer), next_in is updated and processing will 1.407 + resume at this point for the next call of inflate(). 1.408 + 1.409 + - Provide more output starting at next_out and update next_out and avail_out 1.410 + accordingly. inflate() provides as much output as possible, until there is 1.411 + no more input data or no more space in the output buffer (see below about 1.412 + the flush parameter). 1.413 + 1.414 + Before the call of inflate(), the application should ensure that at least 1.415 + one of the actions is possible, by providing more input and/or consuming more 1.416 + output, and updating the next_* and avail_* values accordingly. The 1.417 + application can consume the uncompressed output when it wants, for example 1.418 + when the output buffer is full (avail_out == 0), or after each call of 1.419 + inflate(). If inflate returns Z_OK and with zero avail_out, it must be 1.420 + called again after making room in the output buffer because there might be 1.421 + more output pending. 1.422 + 1.423 + The flush parameter of inflate() can be Z_NO_FLUSH, Z_SYNC_FLUSH, Z_FINISH, 1.424 + Z_BLOCK, or Z_TREES. Z_SYNC_FLUSH requests that inflate() flush as much 1.425 + output as possible to the output buffer. Z_BLOCK requests that inflate() 1.426 + stop if and when it gets to the next deflate block boundary. When decoding 1.427 + the zlib or gzip format, this will cause inflate() to return immediately 1.428 + after the header and before the first block. When doing a raw inflate, 1.429 + inflate() will go ahead and process the first block, and will return when it 1.430 + gets to the end of that block, or when it runs out of data. 1.431 + 1.432 + The Z_BLOCK option assists in appending to or combining deflate streams. 1.433 + Also to assist in this, on return inflate() will set strm->data_type to the 1.434 + number of unused bits in the last byte taken from strm->next_in, plus 64 if 1.435 + inflate() is currently decoding the last block in the deflate stream, plus 1.436 + 128 if inflate() returned immediately after decoding an end-of-block code or 1.437 + decoding the complete header up to just before the first byte of the deflate 1.438 + stream. The end-of-block will not be indicated until all of the uncompressed 1.439 + data from that block has been written to strm->next_out. The number of 1.440 + unused bits may in general be greater than seven, except when bit 7 of 1.441 + data_type is set, in which case the number of unused bits will be less than 1.442 + eight. data_type is set as noted here every time inflate() returns for all 1.443 + flush options, and so can be used to determine the amount of currently 1.444 + consumed input in bits. 1.445 + 1.446 + The Z_TREES option behaves as Z_BLOCK does, but it also returns when the 1.447 + end of each deflate block header is reached, before any actual data in that 1.448 + block is decoded. This allows the caller to determine the length of the 1.449 + deflate block header for later use in random access within a deflate block. 1.450 + 256 is added to the value of strm->data_type when inflate() returns 1.451 + immediately after reaching the end of the deflate block header. 1.452 + 1.453 + inflate() should normally be called until it returns Z_STREAM_END or an 1.454 + error. However if all decompression is to be performed in a single step (a 1.455 + single call of inflate), the parameter flush should be set to Z_FINISH. In 1.456 + this case all pending input is processed and all pending output is flushed; 1.457 + avail_out must be large enough to hold all the uncompressed data. (The size 1.458 + of the uncompressed data may have been saved by the compressor for this 1.459 + purpose.) The next operation on this stream must be inflateEnd to deallocate 1.460 + the decompression state. The use of Z_FINISH is never required, but can be 1.461 + used to inform inflate that a faster approach may be used for the single 1.462 + inflate() call. 1.463 + 1.464 + In this implementation, inflate() always flushes as much output as 1.465 + possible to the output buffer, and always uses the faster approach on the 1.466 + first call. So the only effect of the flush parameter in this implementation 1.467 + is on the return value of inflate(), as noted below, or when it returns early 1.468 + because Z_BLOCK or Z_TREES is used. 1.469 + 1.470 + If a preset dictionary is needed after this call (see inflateSetDictionary 1.471 + below), inflate sets strm->adler to the adler32 checksum of the dictionary 1.472 + chosen by the compressor and returns Z_NEED_DICT; otherwise it sets 1.473 + strm->adler to the adler32 checksum of all output produced so far (that is, 1.474 + total_out bytes) and returns Z_OK, Z_STREAM_END or an error code as described 1.475 + below. At the end of the stream, inflate() checks that its computed adler32 1.476 + checksum is equal to that saved by the compressor and returns Z_STREAM_END 1.477 + only if the checksum is correct. 1.478 + 1.479 + inflate() can decompress and check either zlib-wrapped or gzip-wrapped 1.480 + deflate data. The header type is detected automatically, if requested when 1.481 + initializing with inflateInit2(). Any information contained in the gzip 1.482 + header is not retained, so applications that need that information should 1.483 + instead use raw inflate, see inflateInit2() below, or inflateBack() and 1.484 + perform their own processing of the gzip header and trailer. 1.485 + 1.486 + inflate() returns Z_OK if some progress has been made (more input processed 1.487 + or more output produced), Z_STREAM_END if the end of the compressed data has 1.488 + been reached and all uncompressed output has been produced, Z_NEED_DICT if a 1.489 + preset dictionary is needed at this point, Z_DATA_ERROR if the input data was 1.490 + corrupted (input stream not conforming to the zlib format or incorrect check 1.491 + value), Z_STREAM_ERROR if the stream structure was inconsistent (for example 1.492 + next_in or next_out was Z_NULL), Z_MEM_ERROR if there was not enough memory, 1.493 + Z_BUF_ERROR if no progress is possible or if there was not enough room in the 1.494 + output buffer when Z_FINISH is used. Note that Z_BUF_ERROR is not fatal, and 1.495 + inflate() can be called again with more input and more output space to 1.496 + continue decompressing. If Z_DATA_ERROR is returned, the application may 1.497 + then call inflateSync() to look for a good compression block if a partial 1.498 + recovery of the data is desired. 1.499 +*/ 1.500 + 1.501 + 1.502 +ZEXTERN int ZEXPORT inflateEnd OF((z_streamp strm)); 1.503 +/* 1.504 + All dynamically allocated data structures for this stream are freed. 1.505 + This function discards any unprocessed input and does not flush any pending 1.506 + output. 1.507 + 1.508 + inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state 1.509 + was inconsistent. In the error case, msg may be set but then points to a 1.510 + static string (which must not be deallocated). 1.511 +*/ 1.512 + 1.513 + 1.514 + /* Advanced functions */ 1.515 + 1.516 +/* 1.517 + The following functions are needed only in some special applications. 1.518 +*/ 1.519 + 1.520 +/* 1.521 +ZEXTERN int ZEXPORT deflateInit2 OF((z_streamp strm, 1.522 + int level, 1.523 + int method, 1.524 + int windowBits, 1.525 + int memLevel, 1.526 + int strategy)); 1.527 + 1.528 + This is another version of deflateInit with more compression options. The 1.529 + fields next_in, zalloc, zfree and opaque must be initialized before by the 1.530 + caller. 1.531 + 1.532 + The method parameter is the compression method. It must be Z_DEFLATED in 1.533 + this version of the library. 1.534 + 1.535 + The windowBits parameter is the base two logarithm of the window size 1.536 + (the size of the history buffer). It should be in the range 8..15 for this 1.537 + version of the library. Larger values of this parameter result in better 1.538 + compression at the expense of memory usage. The default value is 15 if 1.539 + deflateInit is used instead. 1.540 + 1.541 + windowBits can also be -8..-15 for raw deflate. In this case, -windowBits 1.542 + determines the window size. deflate() will then generate raw deflate data 1.543 + with no zlib header or trailer, and will not compute an adler32 check value. 1.544 + 1.545 + windowBits can also be greater than 15 for optional gzip encoding. Add 1.546 + 16 to windowBits to write a simple gzip header and trailer around the 1.547 + compressed data instead of a zlib wrapper. The gzip header will have no 1.548 + file name, no extra data, no comment, no modification time (set to zero), no 1.549 + header crc, and the operating system will be set to 255 (unknown). If a 1.550 + gzip stream is being written, strm->adler is a crc32 instead of an adler32. 1.551 + 1.552 + The memLevel parameter specifies how much memory should be allocated 1.553 + for the internal compression state. memLevel=1 uses minimum memory but is 1.554 + slow and reduces compression ratio; memLevel=9 uses maximum memory for 1.555 + optimal speed. The default value is 8. See zconf.h for total memory usage 1.556 + as a function of windowBits and memLevel. 1.557 + 1.558 + The strategy parameter is used to tune the compression algorithm. Use the 1.559 + value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a 1.560 + filter (or predictor), Z_HUFFMAN_ONLY to force Huffman encoding only (no 1.561 + string match), or Z_RLE to limit match distances to one (run-length 1.562 + encoding). Filtered data consists mostly of small values with a somewhat 1.563 + random distribution. In this case, the compression algorithm is tuned to 1.564 + compress them better. The effect of Z_FILTERED is to force more Huffman 1.565 + coding and less string matching; it is somewhat intermediate between 1.566 + Z_DEFAULT_STRATEGY and Z_HUFFMAN_ONLY. Z_RLE is designed to be almost as 1.567 + fast as Z_HUFFMAN_ONLY, but give better compression for PNG image data. The 1.568 + strategy parameter only affects the compression ratio but not the 1.569 + correctness of the compressed output even if it is not set appropriately. 1.570 + Z_FIXED prevents the use of dynamic Huffman codes, allowing for a simpler 1.571 + decoder for special applications. 1.572 + 1.573 + deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough 1.574 + memory, Z_STREAM_ERROR if any parameter is invalid (such as an invalid 1.575 + method), or Z_VERSION_ERROR if the zlib library version (zlib_version) is 1.576 + incompatible with the version assumed by the caller (ZLIB_VERSION). msg is 1.577 + set to null if there is no error message. deflateInit2 does not perform any 1.578 + compression: this will be done by deflate(). 1.579 +*/ 1.580 + 1.581 +ZEXTERN int ZEXPORT deflateSetDictionary OF((z_streamp strm, 1.582 + const Bytef *dictionary, 1.583 + uInt dictLength)); 1.584 +/* 1.585 + Initializes the compression dictionary from the given byte sequence 1.586 + without producing any compressed output. This function must be called 1.587 + immediately after deflateInit, deflateInit2 or deflateReset, before any call 1.588 + of deflate. The compressor and decompressor must use exactly the same 1.589 + dictionary (see inflateSetDictionary). 1.590 + 1.591 + The dictionary should consist of strings (byte sequences) that are likely 1.592 + to be encountered later in the data to be compressed, with the most commonly 1.593 + used strings preferably put towards the end of the dictionary. Using a 1.594 + dictionary is most useful when the data to be compressed is short and can be 1.595 + predicted with good accuracy; the data can then be compressed better than 1.596 + with the default empty dictionary. 1.597 + 1.598 + Depending on the size of the compression data structures selected by 1.599 + deflateInit or deflateInit2, a part of the dictionary may in effect be 1.600 + discarded, for example if the dictionary is larger than the window size 1.601 + provided in deflateInit or deflateInit2. Thus the strings most likely to be 1.602 + useful should be put at the end of the dictionary, not at the front. In 1.603 + addition, the current implementation of deflate will use at most the window 1.604 + size minus 262 bytes of the provided dictionary. 1.605 + 1.606 + Upon return of this function, strm->adler is set to the adler32 value 1.607 + of the dictionary; the decompressor may later use this value to determine 1.608 + which dictionary has been used by the compressor. (The adler32 value 1.609 + applies to the whole dictionary even if only a subset of the dictionary is 1.610 + actually used by the compressor.) If a raw deflate was requested, then the 1.611 + adler32 value is not computed and strm->adler is not set. 1.612 + 1.613 + deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a 1.614 + parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is 1.615 + inconsistent (for example if deflate has already been called for this stream 1.616 + or if the compression method is bsort). deflateSetDictionary does not 1.617 + perform any compression: this will be done by deflate(). 1.618 +*/ 1.619 + 1.620 +ZEXTERN int ZEXPORT deflateCopy OF((z_streamp dest, 1.621 + z_streamp source)); 1.622 +/* 1.623 + Sets the destination stream as a complete copy of the source stream. 1.624 + 1.625 + This function can be useful when several compression strategies will be 1.626 + tried, for example when there are several ways of pre-processing the input 1.627 + data with a filter. The streams that will be discarded should then be freed 1.628 + by calling deflateEnd. Note that deflateCopy duplicates the internal 1.629 + compression state which can be quite large, so this strategy is slow and can 1.630 + consume lots of memory. 1.631 + 1.632 + deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not 1.633 + enough memory, Z_STREAM_ERROR if the source stream state was inconsistent 1.634 + (such as zalloc being Z_NULL). msg is left unchanged in both source and 1.635 + destination. 1.636 +*/ 1.637 + 1.638 +ZEXTERN int ZEXPORT deflateReset OF((z_streamp strm)); 1.639 +/* 1.640 + This function is equivalent to deflateEnd followed by deflateInit, 1.641 + but does not free and reallocate all the internal compression state. The 1.642 + stream will keep the same compression level and any other attributes that 1.643 + may have been set by deflateInit2. 1.644 + 1.645 + deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source 1.646 + stream state was inconsistent (such as zalloc or state being Z_NULL). 1.647 +*/ 1.648 + 1.649 +ZEXTERN int ZEXPORT deflateParams OF((z_streamp strm, 1.650 + int level, 1.651 + int strategy)); 1.652 +/* 1.653 + Dynamically update the compression level and compression strategy. The 1.654 + interpretation of level and strategy is as in deflateInit2. This can be 1.655 + used to switch between compression and straight copy of the input data, or 1.656 + to switch to a different kind of input data requiring a different strategy. 1.657 + If the compression level is changed, the input available so far is 1.658 + compressed with the old level (and may be flushed); the new level will take 1.659 + effect only at the next call of deflate(). 1.660 + 1.661 + Before the call of deflateParams, the stream state must be set as for 1.662 + a call of deflate(), since the currently available input may have to be 1.663 + compressed and flushed. In particular, strm->avail_out must be non-zero. 1.664 + 1.665 + deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source 1.666 + stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR if 1.667 + strm->avail_out was zero. 1.668 +*/ 1.669 + 1.670 +ZEXTERN int ZEXPORT deflateTune OF((z_streamp strm, 1.671 + int good_length, 1.672 + int max_lazy, 1.673 + int nice_length, 1.674 + int max_chain)); 1.675 +/* 1.676 + Fine tune deflate's internal compression parameters. This should only be 1.677 + used by someone who understands the algorithm used by zlib's deflate for 1.678 + searching for the best matching string, and even then only by the most 1.679 + fanatic optimizer trying to squeeze out the last compressed bit for their 1.680 + specific input data. Read the deflate.c source code for the meaning of the 1.681 + max_lazy, good_length, nice_length, and max_chain parameters. 1.682 + 1.683 + deflateTune() can be called after deflateInit() or deflateInit2(), and 1.684 + returns Z_OK on success, or Z_STREAM_ERROR for an invalid deflate stream. 1.685 + */ 1.686 + 1.687 +ZEXTERN uLong ZEXPORT deflateBound OF((z_streamp strm, 1.688 + uLong sourceLen)); 1.689 +/* 1.690 + deflateBound() returns an upper bound on the compressed size after 1.691 + deflation of sourceLen bytes. It must be called after deflateInit() or 1.692 + deflateInit2(), and after deflateSetHeader(), if used. This would be used 1.693 + to allocate an output buffer for deflation in a single pass, and so would be 1.694 + called before deflate(). 1.695 +*/ 1.696 + 1.697 +ZEXTERN int ZEXPORT deflatePrime OF((z_streamp strm, 1.698 + int bits, 1.699 + int value)); 1.700 +/* 1.701 + deflatePrime() inserts bits in the deflate output stream. The intent 1.702 + is that this function is used to start off the deflate output with the bits 1.703 + leftover from a previous deflate stream when appending to it. As such, this 1.704 + function can only be used for raw deflate, and must be used before the first 1.705 + deflate() call after a deflateInit2() or deflateReset(). bits must be less 1.706 + than or equal to 16, and that many of the least significant bits of value 1.707 + will be inserted in the output. 1.708 + 1.709 + deflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source 1.710 + stream state was inconsistent. 1.711 +*/ 1.712 + 1.713 +ZEXTERN int ZEXPORT deflateSetHeader OF((z_streamp strm, 1.714 + gz_headerp head)); 1.715 +/* 1.716 + deflateSetHeader() provides gzip header information for when a gzip 1.717 + stream is requested by deflateInit2(). deflateSetHeader() may be called 1.718 + after deflateInit2() or deflateReset() and before the first call of 1.719 + deflate(). The text, time, os, extra field, name, and comment information 1.720 + in the provided gz_header structure are written to the gzip header (xflag is 1.721 + ignored -- the extra flags are set according to the compression level). The 1.722 + caller must assure that, if not Z_NULL, name and comment are terminated with 1.723 + a zero byte, and that if extra is not Z_NULL, that extra_len bytes are 1.724 + available there. If hcrc is true, a gzip header crc is included. Note that 1.725 + the current versions of the command-line version of gzip (up through version 1.726 + 1.3.x) do not support header crc's, and will report that it is a "multi-part 1.727 + gzip file" and give up. 1.728 + 1.729 + If deflateSetHeader is not used, the default gzip header has text false, 1.730 + the time set to zero, and os set to 255, with no extra, name, or comment 1.731 + fields. The gzip header is returned to the default state by deflateReset(). 1.732 + 1.733 + deflateSetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source 1.734 + stream state was inconsistent. 1.735 +*/ 1.736 + 1.737 +/* 1.738 +ZEXTERN int ZEXPORT inflateInit2 OF((z_streamp strm, 1.739 + int windowBits)); 1.740 + 1.741 + This is another version of inflateInit with an extra parameter. The 1.742 + fields next_in, avail_in, zalloc, zfree and opaque must be initialized 1.743 + before by the caller. 1.744 + 1.745 + The windowBits parameter is the base two logarithm of the maximum window 1.746 + size (the size of the history buffer). It should be in the range 8..15 for 1.747 + this version of the library. The default value is 15 if inflateInit is used 1.748 + instead. windowBits must be greater than or equal to the windowBits value 1.749 + provided to deflateInit2() while compressing, or it must be equal to 15 if 1.750 + deflateInit2() was not used. If a compressed stream with a larger window 1.751 + size is given as input, inflate() will return with the error code 1.752 + Z_DATA_ERROR instead of trying to allocate a larger window. 1.753 + 1.754 + windowBits can also be zero to request that inflate use the window size in 1.755 + the zlib header of the compressed stream. 1.756 + 1.757 + windowBits can also be -8..-15 for raw inflate. In this case, -windowBits 1.758 + determines the window size. inflate() will then process raw deflate data, 1.759 + not looking for a zlib or gzip header, not generating a check value, and not 1.760 + looking for any check values for comparison at the end of the stream. This 1.761 + is for use with other formats that use the deflate compressed data format 1.762 + such as zip. Those formats provide their own check values. If a custom 1.763 + format is developed using the raw deflate format for compressed data, it is 1.764 + recommended that a check value such as an adler32 or a crc32 be applied to 1.765 + the uncompressed data as is done in the zlib, gzip, and zip formats. For 1.766 + most applications, the zlib format should be used as is. Note that comments 1.767 + above on the use in deflateInit2() applies to the magnitude of windowBits. 1.768 + 1.769 + windowBits can also be greater than 15 for optional gzip decoding. Add 1.770 + 32 to windowBits to enable zlib and gzip decoding with automatic header 1.771 + detection, or add 16 to decode only the gzip format (the zlib format will 1.772 + return a Z_DATA_ERROR). If a gzip stream is being decoded, strm->adler is a 1.773 + crc32 instead of an adler32. 1.774 + 1.775 + inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough 1.776 + memory, Z_VERSION_ERROR if the zlib library version is incompatible with the 1.777 + version assumed by the caller, or Z_STREAM_ERROR if the parameters are 1.778 + invalid, such as a null pointer to the structure. msg is set to null if 1.779 + there is no error message. inflateInit2 does not perform any decompression 1.780 + apart from possibly reading the zlib header if present: actual decompression 1.781 + will be done by inflate(). (So next_in and avail_in may be modified, but 1.782 + next_out and avail_out are unused and unchanged.) The current implementation 1.783 + of inflateInit2() does not process any header information -- that is 1.784 + deferred until inflate() is called. 1.785 +*/ 1.786 + 1.787 +ZEXTERN int ZEXPORT inflateSetDictionary OF((z_streamp strm, 1.788 + const Bytef *dictionary, 1.789 + uInt dictLength)); 1.790 +/* 1.791 + Initializes the decompression dictionary from the given uncompressed byte 1.792 + sequence. This function must be called immediately after a call of inflate, 1.793 + if that call returned Z_NEED_DICT. The dictionary chosen by the compressor 1.794 + can be determined from the adler32 value returned by that call of inflate. 1.795 + The compressor and decompressor must use exactly the same dictionary (see 1.796 + deflateSetDictionary). For raw inflate, this function can be called 1.797 + immediately after inflateInit2() or inflateReset() and before any call of 1.798 + inflate() to set the dictionary. The application must insure that the 1.799 + dictionary that was used for compression is provided. 1.800 + 1.801 + inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a 1.802 + parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is 1.803 + inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the 1.804 + expected one (incorrect adler32 value). inflateSetDictionary does not 1.805 + perform any decompression: this will be done by subsequent calls of 1.806 + inflate(). 1.807 +*/ 1.808 + 1.809 +ZEXTERN int ZEXPORT inflateSync OF((z_streamp strm)); 1.810 +/* 1.811 + Skips invalid compressed data until a full flush point (see above the 1.812 + description of deflate with Z_FULL_FLUSH) can be found, or until all 1.813 + available input is skipped. No output is provided. 1.814 + 1.815 + inflateSync returns Z_OK if a full flush point has been found, Z_BUF_ERROR 1.816 + if no more input was provided, Z_DATA_ERROR if no flush point has been 1.817 + found, or Z_STREAM_ERROR if the stream structure was inconsistent. In the 1.818 + success case, the application may save the current current value of total_in 1.819 + which indicates where valid compressed data was found. In the error case, 1.820 + the application may repeatedly call inflateSync, providing more input each 1.821 + time, until success or end of the input data. 1.822 +*/ 1.823 + 1.824 +ZEXTERN int ZEXPORT inflateCopy OF((z_streamp dest, 1.825 + z_streamp source)); 1.826 +/* 1.827 + Sets the destination stream as a complete copy of the source stream. 1.828 + 1.829 + This function can be useful when randomly accessing a large stream. The 1.830 + first pass through the stream can periodically record the inflate state, 1.831 + allowing restarting inflate at those points when randomly accessing the 1.832 + stream. 1.833 + 1.834 + inflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not 1.835 + enough memory, Z_STREAM_ERROR if the source stream state was inconsistent 1.836 + (such as zalloc being Z_NULL). msg is left unchanged in both source and 1.837 + destination. 1.838 +*/ 1.839 + 1.840 +ZEXTERN int ZEXPORT inflateReset OF((z_streamp strm)); 1.841 +/* 1.842 + This function is equivalent to inflateEnd followed by inflateInit, 1.843 + but does not free and reallocate all the internal decompression state. The 1.844 + stream will keep attributes that may have been set by inflateInit2. 1.845 + 1.846 + inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source 1.847 + stream state was inconsistent (such as zalloc or state being Z_NULL). 1.848 +*/ 1.849 + 1.850 +ZEXTERN int ZEXPORT inflateReset2 OF((z_streamp strm, 1.851 + int windowBits)); 1.852 +/* 1.853 + This function is the same as inflateReset, but it also permits changing 1.854 + the wrap and window size requests. The windowBits parameter is interpreted 1.855 + the same as it is for inflateInit2. 1.856 + 1.857 + inflateReset2 returns Z_OK if success, or Z_STREAM_ERROR if the source 1.858 + stream state was inconsistent (such as zalloc or state being Z_NULL), or if 1.859 + the windowBits parameter is invalid. 1.860 +*/ 1.861 + 1.862 +ZEXTERN int ZEXPORT inflatePrime OF((z_streamp strm, 1.863 + int bits, 1.864 + int value)); 1.865 +/* 1.866 + This function inserts bits in the inflate input stream. The intent is 1.867 + that this function is used to start inflating at a bit position in the 1.868 + middle of a byte. The provided bits will be used before any bytes are used 1.869 + from next_in. This function should only be used with raw inflate, and 1.870 + should be used before the first inflate() call after inflateInit2() or 1.871 + inflateReset(). bits must be less than or equal to 16, and that many of the 1.872 + least significant bits of value will be inserted in the input. 1.873 + 1.874 + If bits is negative, then the input stream bit buffer is emptied. Then 1.875 + inflatePrime() can be called again to put bits in the buffer. This is used 1.876 + to clear out bits leftover after feeding inflate a block description prior 1.877 + to feeding inflate codes. 1.878 + 1.879 + inflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source 1.880 + stream state was inconsistent. 1.881 +*/ 1.882 + 1.883 +ZEXTERN long ZEXPORT inflateMark OF((z_streamp strm)); 1.884 +/* 1.885 + This function returns two values, one in the lower 16 bits of the return 1.886 + value, and the other in the remaining upper bits, obtained by shifting the 1.887 + return value down 16 bits. If the upper value is -1 and the lower value is 1.888 + zero, then inflate() is currently decoding information outside of a block. 1.889 + If the upper value is -1 and the lower value is non-zero, then inflate is in 1.890 + the middle of a stored block, with the lower value equaling the number of 1.891 + bytes from the input remaining to copy. If the upper value is not -1, then 1.892 + it is the number of bits back from the current bit position in the input of 1.893 + the code (literal or length/distance pair) currently being processed. In 1.894 + that case the lower value is the number of bytes already emitted for that 1.895 + code. 1.896 + 1.897 + A code is being processed if inflate is waiting for more input to complete 1.898 + decoding of the code, or if it has completed decoding but is waiting for 1.899 + more output space to write the literal or match data. 1.900 + 1.901 + inflateMark() is used to mark locations in the input data for random 1.902 + access, which may be at bit positions, and to note those cases where the 1.903 + output of a code may span boundaries of random access blocks. The current 1.904 + location in the input stream can be determined from avail_in and data_type 1.905 + as noted in the description for the Z_BLOCK flush parameter for inflate. 1.906 + 1.907 + inflateMark returns the value noted above or -1 << 16 if the provided 1.908 + source stream state was inconsistent. 1.909 +*/ 1.910 + 1.911 +ZEXTERN int ZEXPORT inflateGetHeader OF((z_streamp strm, 1.912 + gz_headerp head)); 1.913 +/* 1.914 + inflateGetHeader() requests that gzip header information be stored in the 1.915 + provided gz_header structure. inflateGetHeader() may be called after 1.916 + inflateInit2() or inflateReset(), and before the first call of inflate(). 1.917 + As inflate() processes the gzip stream, head->done is zero until the header 1.918 + is completed, at which time head->done is set to one. If a zlib stream is 1.919 + being decoded, then head->done is set to -1 to indicate that there will be 1.920 + no gzip header information forthcoming. Note that Z_BLOCK or Z_TREES can be 1.921 + used to force inflate() to return immediately after header processing is 1.922 + complete and before any actual data is decompressed. 1.923 + 1.924 + The text, time, xflags, and os fields are filled in with the gzip header 1.925 + contents. hcrc is set to true if there is a header CRC. (The header CRC 1.926 + was valid if done is set to one.) If extra is not Z_NULL, then extra_max 1.927 + contains the maximum number of bytes to write to extra. Once done is true, 1.928 + extra_len contains the actual extra field length, and extra contains the 1.929 + extra field, or that field truncated if extra_max is less than extra_len. 1.930 + If name is not Z_NULL, then up to name_max characters are written there, 1.931 + terminated with a zero unless the length is greater than name_max. If 1.932 + comment is not Z_NULL, then up to comm_max characters are written there, 1.933 + terminated with a zero unless the length is greater than comm_max. When any 1.934 + of extra, name, or comment are not Z_NULL and the respective field is not 1.935 + present in the header, then that field is set to Z_NULL to signal its 1.936 + absence. This allows the use of deflateSetHeader() with the returned 1.937 + structure to duplicate the header. However if those fields are set to 1.938 + allocated memory, then the application will need to save those pointers 1.939 + elsewhere so that they can be eventually freed. 1.940 + 1.941 + If inflateGetHeader is not used, then the header information is simply 1.942 + discarded. The header is always checked for validity, including the header 1.943 + CRC if present. inflateReset() will reset the process to discard the header 1.944 + information. The application would need to call inflateGetHeader() again to 1.945 + retrieve the header from the next gzip stream. 1.946 + 1.947 + inflateGetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source 1.948 + stream state was inconsistent. 1.949 +*/ 1.950 + 1.951 +/* 1.952 +ZEXTERN int ZEXPORT inflateBackInit OF((z_streamp strm, int windowBits, 1.953 + unsigned char FAR *window)); 1.954 + 1.955 + Initialize the internal stream state for decompression using inflateBack() 1.956 + calls. The fields zalloc, zfree and opaque in strm must be initialized 1.957 + before the call. If zalloc and zfree are Z_NULL, then the default library- 1.958 + derived memory allocation routines are used. windowBits is the base two 1.959 + logarithm of the window size, in the range 8..15. window is a caller 1.960 + supplied buffer of that size. Except for special applications where it is 1.961 + assured that deflate was used with small window sizes, windowBits must be 15 1.962 + and a 32K byte window must be supplied to be able to decompress general 1.963 + deflate streams. 1.964 + 1.965 + See inflateBack() for the usage of these routines. 1.966 + 1.967 + inflateBackInit will return Z_OK on success, Z_STREAM_ERROR if any of 1.968 + the paramaters are invalid, Z_MEM_ERROR if the internal state could not be 1.969 + allocated, or Z_VERSION_ERROR if the version of the library does not match 1.970 + the version of the header file. 1.971 +*/ 1.972 + 1.973 +typedef unsigned (*in_func) OF((void FAR *, unsigned char FAR * FAR *)); 1.974 +typedef int (*out_func) OF((void FAR *, unsigned char FAR *, unsigned)); 1.975 + 1.976 +ZEXTERN int ZEXPORT inflateBack OF((z_streamp strm, 1.977 + in_func in, void FAR *in_desc, 1.978 + out_func out, void FAR *out_desc)); 1.979 +/* 1.980 + inflateBack() does a raw inflate with a single call using a call-back 1.981 + interface for input and output. This is more efficient than inflate() for 1.982 + file i/o applications in that it avoids copying between the output and the 1.983 + sliding window by simply making the window itself the output buffer. This 1.984 + function trusts the application to not change the output buffer passed by 1.985 + the output function, at least until inflateBack() returns. 1.986 + 1.987 + inflateBackInit() must be called first to allocate the internal state 1.988 + and to initialize the state with the user-provided window buffer. 1.989 + inflateBack() may then be used multiple times to inflate a complete, raw 1.990 + deflate stream with each call. inflateBackEnd() is then called to free the 1.991 + allocated state. 1.992 + 1.993 + A raw deflate stream is one with no zlib or gzip header or trailer. 1.994 + This routine would normally be used in a utility that reads zip or gzip 1.995 + files and writes out uncompressed files. The utility would decode the 1.996 + header and process the trailer on its own, hence this routine expects only 1.997 + the raw deflate stream to decompress. This is different from the normal 1.998 + behavior of inflate(), which expects either a zlib or gzip header and 1.999 + trailer around the deflate stream. 1.1000 + 1.1001 + inflateBack() uses two subroutines supplied by the caller that are then 1.1002 + called by inflateBack() for input and output. inflateBack() calls those 1.1003 + routines until it reads a complete deflate stream and writes out all of the 1.1004 + uncompressed data, or until it encounters an error. The function's 1.1005 + parameters and return types are defined above in the in_func and out_func 1.1006 + typedefs. inflateBack() will call in(in_desc, &buf) which should return the 1.1007 + number of bytes of provided input, and a pointer to that input in buf. If 1.1008 + there is no input available, in() must return zero--buf is ignored in that 1.1009 + case--and inflateBack() will return a buffer error. inflateBack() will call 1.1010 + out(out_desc, buf, len) to write the uncompressed data buf[0..len-1]. out() 1.1011 + should return zero on success, or non-zero on failure. If out() returns 1.1012 + non-zero, inflateBack() will return with an error. Neither in() nor out() 1.1013 + are permitted to change the contents of the window provided to 1.1014 + inflateBackInit(), which is also the buffer that out() uses to write from. 1.1015 + The length written by out() will be at most the window size. Any non-zero 1.1016 + amount of input may be provided by in(). 1.1017 + 1.1018 + For convenience, inflateBack() can be provided input on the first call by 1.1019 + setting strm->next_in and strm->avail_in. If that input is exhausted, then 1.1020 + in() will be called. Therefore strm->next_in must be initialized before 1.1021 + calling inflateBack(). If strm->next_in is Z_NULL, then in() will be called 1.1022 + immediately for input. If strm->next_in is not Z_NULL, then strm->avail_in 1.1023 + must also be initialized, and then if strm->avail_in is not zero, input will 1.1024 + initially be taken from strm->next_in[0 .. strm->avail_in - 1]. 1.1025 + 1.1026 + The in_desc and out_desc parameters of inflateBack() is passed as the 1.1027 + first parameter of in() and out() respectively when they are called. These 1.1028 + descriptors can be optionally used to pass any information that the caller- 1.1029 + supplied in() and out() functions need to do their job. 1.1030 + 1.1031 + On return, inflateBack() will set strm->next_in and strm->avail_in to 1.1032 + pass back any unused input that was provided by the last in() call. The 1.1033 + return values of inflateBack() can be Z_STREAM_END on success, Z_BUF_ERROR 1.1034 + if in() or out() returned an error, Z_DATA_ERROR if there was a format error 1.1035 + in the deflate stream (in which case strm->msg is set to indicate the nature 1.1036 + of the error), or Z_STREAM_ERROR if the stream was not properly initialized. 1.1037 + In the case of Z_BUF_ERROR, an input or output error can be distinguished 1.1038 + using strm->next_in which will be Z_NULL only if in() returned an error. If 1.1039 + strm->next_in is not Z_NULL, then the Z_BUF_ERROR was due to out() returning 1.1040 + non-zero. (in() will always be called before out(), so strm->next_in is 1.1041 + assured to be defined if out() returns non-zero.) Note that inflateBack() 1.1042 + cannot return Z_OK. 1.1043 +*/ 1.1044 + 1.1045 +ZEXTERN int ZEXPORT inflateBackEnd OF((z_streamp strm)); 1.1046 +/* 1.1047 + All memory allocated by inflateBackInit() is freed. 1.1048 + 1.1049 + inflateBackEnd() returns Z_OK on success, or Z_STREAM_ERROR if the stream 1.1050 + state was inconsistent. 1.1051 +*/ 1.1052 + 1.1053 +ZEXTERN uLong ZEXPORT zlibCompileFlags OF((void)); 1.1054 +/* Return flags indicating compile-time options. 1.1055 + 1.1056 + Type sizes, two bits each, 00 = 16 bits, 01 = 32, 10 = 64, 11 = other: 1.1057 + 1.0: size of uInt 1.1058 + 3.2: size of uLong 1.1059 + 5.4: size of voidpf (pointer) 1.1060 + 7.6: size of z_off_t 1.1061 + 1.1062 + Compiler, assembler, and debug options: 1.1063 + 8: DEBUG 1.1064 + 9: ASMV or ASMINF -- use ASM code 1.1065 + 10: ZLIB_WINAPI -- exported functions use the WINAPI calling convention 1.1066 + 11: 0 (reserved) 1.1067 + 1.1068 + One-time table building (smaller code, but not thread-safe if true): 1.1069 + 12: BUILDFIXED -- build static block decoding tables when needed 1.1070 + 13: DYNAMIC_CRC_TABLE -- build CRC calculation tables when needed 1.1071 + 14,15: 0 (reserved) 1.1072 + 1.1073 + Library content (indicates missing functionality): 1.1074 + 16: NO_GZCOMPRESS -- gz* functions cannot compress (to avoid linking 1.1075 + deflate code when not needed) 1.1076 + 17: NO_GZIP -- deflate can't write gzip streams, and inflate can't detect 1.1077 + and decode gzip streams (to avoid linking crc code) 1.1078 + 18-19: 0 (reserved) 1.1079 + 1.1080 + Operation variations (changes in library functionality): 1.1081 + 20: PKZIP_BUG_WORKAROUND -- slightly more permissive inflate 1.1082 + 21: FASTEST -- deflate algorithm with only one, lowest compression level 1.1083 + 22,23: 0 (reserved) 1.1084 + 1.1085 + The sprintf variant used by gzprintf (zero is best): 1.1086 + 24: 0 = vs*, 1 = s* -- 1 means limited to 20 arguments after the format 1.1087 + 25: 0 = *nprintf, 1 = *printf -- 1 means gzprintf() not secure! 1.1088 + 26: 0 = returns value, 1 = void -- 1 means inferred string length returned 1.1089 + 1.1090 + Remainder: 1.1091 + 27-31: 0 (reserved) 1.1092 + */ 1.1093 + 1.1094 + 1.1095 + /* utility functions */ 1.1096 + 1.1097 +/* 1.1098 + The following utility functions are implemented on top of the basic 1.1099 + stream-oriented functions. To simplify the interface, some default options 1.1100 + are assumed (compression level and memory usage, standard memory allocation 1.1101 + functions). The source code of these utility functions can be modified if 1.1102 + you need special options. 1.1103 +*/ 1.1104 + 1.1105 +ZEXTERN int ZEXPORT compress OF((Bytef *dest, uLongf *destLen, 1.1106 + const Bytef *source, uLong sourceLen)); 1.1107 +/* 1.1108 + Compresses the source buffer into the destination buffer. sourceLen is 1.1109 + the byte length of the source buffer. Upon entry, destLen is the total size 1.1110 + of the destination buffer, which must be at least the value returned by 1.1111 + compressBound(sourceLen). Upon exit, destLen is the actual size of the 1.1112 + compressed buffer. 1.1113 + 1.1114 + compress returns Z_OK if success, Z_MEM_ERROR if there was not 1.1115 + enough memory, Z_BUF_ERROR if there was not enough room in the output 1.1116 + buffer. 1.1117 +*/ 1.1118 + 1.1119 +ZEXTERN int ZEXPORT compress2 OF((Bytef *dest, uLongf *destLen, 1.1120 + const Bytef *source, uLong sourceLen, 1.1121 + int level)); 1.1122 +/* 1.1123 + Compresses the source buffer into the destination buffer. The level 1.1124 + parameter has the same meaning as in deflateInit. sourceLen is the byte 1.1125 + length of the source buffer. Upon entry, destLen is the total size of the 1.1126 + destination buffer, which must be at least the value returned by 1.1127 + compressBound(sourceLen). Upon exit, destLen is the actual size of the 1.1128 + compressed buffer. 1.1129 + 1.1130 + compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough 1.1131 + memory, Z_BUF_ERROR if there was not enough room in the output buffer, 1.1132 + Z_STREAM_ERROR if the level parameter is invalid. 1.1133 +*/ 1.1134 + 1.1135 +ZEXTERN uLong ZEXPORT compressBound OF((uLong sourceLen)); 1.1136 +/* 1.1137 + compressBound() returns an upper bound on the compressed size after 1.1138 + compress() or compress2() on sourceLen bytes. It would be used before a 1.1139 + compress() or compress2() call to allocate the destination buffer. 1.1140 +*/ 1.1141 + 1.1142 +ZEXTERN int ZEXPORT uncompress OF((Bytef *dest, uLongf *destLen, 1.1143 + const Bytef *source, uLong sourceLen)); 1.1144 +/* 1.1145 + Decompresses the source buffer into the destination buffer. sourceLen is 1.1146 + the byte length of the source buffer. Upon entry, destLen is the total size 1.1147 + of the destination buffer, which must be large enough to hold the entire 1.1148 + uncompressed data. (The size of the uncompressed data must have been saved 1.1149 + previously by the compressor and transmitted to the decompressor by some 1.1150 + mechanism outside the scope of this compression library.) Upon exit, destLen 1.1151 + is the actual size of the uncompressed buffer. 1.1152 + 1.1153 + uncompress returns Z_OK if success, Z_MEM_ERROR if there was not 1.1154 + enough memory, Z_BUF_ERROR if there was not enough room in the output 1.1155 + buffer, or Z_DATA_ERROR if the input data was corrupted or incomplete. 1.1156 +*/ 1.1157 + 1.1158 + 1.1159 + /* gzip file access functions */ 1.1160 + 1.1161 +/* 1.1162 + This library supports reading and writing files in gzip (.gz) format with 1.1163 + an interface similar to that of stdio, using the functions that start with 1.1164 + "gz". The gzip format is different from the zlib format. gzip is a gzip 1.1165 + wrapper, documented in RFC 1952, wrapped around a deflate stream. 1.1166 +*/ 1.1167 + 1.1168 +typedef voidp gzFile; /* opaque gzip file descriptor */ 1.1169 + 1.1170 +/* 1.1171 +ZEXTERN gzFile ZEXPORT gzopen OF((const char *path, const char *mode)); 1.1172 + 1.1173 + Opens a gzip (.gz) file for reading or writing. The mode parameter is as 1.1174 + in fopen ("rb" or "wb") but can also include a compression level ("wb9") or 1.1175 + a strategy: 'f' for filtered data as in "wb6f", 'h' for Huffman-only 1.1176 + compression as in "wb1h", 'R' for run-length encoding as in "wb1R", or 'F' 1.1177 + for fixed code compression as in "wb9F". (See the description of 1.1178 + deflateInit2 for more information about the strategy parameter.) Also "a" 1.1179 + can be used instead of "w" to request that the gzip stream that will be 1.1180 + written be appended to the file. "+" will result in an error, since reading 1.1181 + and writing to the same gzip file is not supported. 1.1182 + 1.1183 + gzopen can be used to read a file which is not in gzip format; in this 1.1184 + case gzread will directly read from the file without decompression. 1.1185 + 1.1186 + gzopen returns NULL if the file could not be opened, if there was 1.1187 + insufficient memory to allocate the gzFile state, or if an invalid mode was 1.1188 + specified (an 'r', 'w', or 'a' was not provided, or '+' was provided). 1.1189 + errno can be checked to determine if the reason gzopen failed was that the 1.1190 + file could not be opened. 1.1191 +*/ 1.1192 + 1.1193 +ZEXTERN gzFile ZEXPORT gzdopen OF((int fd, const char *mode)); 1.1194 +/* 1.1195 + gzdopen associates a gzFile with the file descriptor fd. File descriptors 1.1196 + are obtained from calls like open, dup, creat, pipe or fileno (if the file 1.1197 + has been previously opened with fopen). The mode parameter is as in gzopen. 1.1198 + 1.1199 + The next call of gzclose on the returned gzFile will also close the file 1.1200 + descriptor fd, just like fclose(fdopen(fd, mode)) closes the file descriptor 1.1201 + fd. If you want to keep fd open, use fd = dup(fd_keep); gz = gzdopen(fd, 1.1202 + mode);. The duplicated descriptor should be saved to avoid a leak, since 1.1203 + gzdopen does not close fd if it fails. 1.1204 + 1.1205 + gzdopen returns NULL if there was insufficient memory to allocate the 1.1206 + gzFile state, if an invalid mode was specified (an 'r', 'w', or 'a' was not 1.1207 + provided, or '+' was provided), or if fd is -1. The file descriptor is not 1.1208 + used until the next gz* read, write, seek, or close operation, so gzdopen 1.1209 + will not detect if fd is invalid (unless fd is -1). 1.1210 +*/ 1.1211 + 1.1212 +ZEXTERN int ZEXPORT gzbuffer OF((gzFile file, unsigned size)); 1.1213 +/* 1.1214 + Set the internal buffer size used by this library's functions. The 1.1215 + default buffer size is 8192 bytes. This function must be called after 1.1216 + gzopen() or gzdopen(), and before any other calls that read or write the 1.1217 + file. The buffer memory allocation is always deferred to the first read or 1.1218 + write. Two buffers are allocated, either both of the specified size when 1.1219 + writing, or one of the specified size and the other twice that size when 1.1220 + reading. A larger buffer size of, for example, 64K or 128K bytes will 1.1221 + noticeably increase the speed of decompression (reading). 1.1222 + 1.1223 + The new buffer size also affects the maximum length for gzprintf(). 1.1224 + 1.1225 + gzbuffer() returns 0 on success, or -1 on failure, such as being called 1.1226 + too late. 1.1227 +*/ 1.1228 + 1.1229 +ZEXTERN int ZEXPORT gzsetparams OF((gzFile file, int level, int strategy)); 1.1230 +/* 1.1231 + Dynamically update the compression level or strategy. See the description 1.1232 + of deflateInit2 for the meaning of these parameters. 1.1233 + 1.1234 + gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not 1.1235 + opened for writing. 1.1236 +*/ 1.1237 + 1.1238 +ZEXTERN int ZEXPORT gzread OF((gzFile file, voidp buf, unsigned len)); 1.1239 +/* 1.1240 + Reads the given number of uncompressed bytes from the compressed file. If 1.1241 + the input file was not in gzip format, gzread copies the given number of 1.1242 + bytes into the buffer. 1.1243 + 1.1244 + After reaching the end of a gzip stream in the input, gzread will continue 1.1245 + to read, looking for another gzip stream, or failing that, reading the rest 1.1246 + of the input file directly without decompression. The entire input file 1.1247 + will be read if gzread is called until it returns less than the requested 1.1248 + len. 1.1249 + 1.1250 + gzread returns the number of uncompressed bytes actually read, less than 1.1251 + len for end of file, or -1 for error. 1.1252 +*/ 1.1253 + 1.1254 +ZEXTERN int ZEXPORT gzwrite OF((gzFile file, 1.1255 + voidpc buf, unsigned len)); 1.1256 +/* 1.1257 + Writes the given number of uncompressed bytes into the compressed file. 1.1258 + gzwrite returns the number of uncompressed bytes written or 0 in case of 1.1259 + error. 1.1260 +*/ 1.1261 + 1.1262 +ZEXTERN int ZEXPORTVA gzprintf OF((gzFile file, const char *format, ...)); 1.1263 +/* 1.1264 + Converts, formats, and writes the arguments to the compressed file under 1.1265 + control of the format string, as in fprintf. gzprintf returns the number of 1.1266 + uncompressed bytes actually written, or 0 in case of error. The number of 1.1267 + uncompressed bytes written is limited to 8191, or one less than the buffer 1.1268 + size given to gzbuffer(). The caller should assure that this limit is not 1.1269 + exceeded. If it is exceeded, then gzprintf() will return an error (0) with 1.1270 + nothing written. In this case, there may also be a buffer overflow with 1.1271 + unpredictable consequences, which is possible only if zlib was compiled with 1.1272 + the insecure functions sprintf() or vsprintf() because the secure snprintf() 1.1273 + or vsnprintf() functions were not available. This can be determined using 1.1274 + zlibCompileFlags(). 1.1275 +*/ 1.1276 + 1.1277 +ZEXTERN int ZEXPORT gzputs OF((gzFile file, const char *s)); 1.1278 +/* 1.1279 + Writes the given null-terminated string to the compressed file, excluding 1.1280 + the terminating null character. 1.1281 + 1.1282 + gzputs returns the number of characters written, or -1 in case of error. 1.1283 +*/ 1.1284 + 1.1285 +ZEXTERN char * ZEXPORT gzgets OF((gzFile file, char *buf, int len)); 1.1286 +/* 1.1287 + Reads bytes from the compressed file until len-1 characters are read, or a 1.1288 + newline character is read and transferred to buf, or an end-of-file 1.1289 + condition is encountered. If any characters are read or if len == 1, the 1.1290 + string is terminated with a null character. If no characters are read due 1.1291 + to an end-of-file or len < 1, then the buffer is left untouched. 1.1292 + 1.1293 + gzgets returns buf which is a null-terminated string, or it returns NULL 1.1294 + for end-of-file or in case of error. If there was an error, the contents at 1.1295 + buf are indeterminate. 1.1296 +*/ 1.1297 + 1.1298 +ZEXTERN int ZEXPORT gzputc OF((gzFile file, int c)); 1.1299 +/* 1.1300 + Writes c, converted to an unsigned char, into the compressed file. gzputc 1.1301 + returns the value that was written, or -1 in case of error. 1.1302 +*/ 1.1303 + 1.1304 +ZEXTERN int ZEXPORT gzgetc OF((gzFile file)); 1.1305 +/* 1.1306 + Reads one byte from the compressed file. gzgetc returns this byte or -1 1.1307 + in case of end of file or error. 1.1308 +*/ 1.1309 + 1.1310 +ZEXTERN int ZEXPORT gzungetc OF((int c, gzFile file)); 1.1311 +/* 1.1312 + Push one character back onto the stream to be read as the first character 1.1313 + on the next read. At least one character of push-back is allowed. 1.1314 + gzungetc() returns the character pushed, or -1 on failure. gzungetc() will 1.1315 + fail if c is -1, and may fail if a character has been pushed but not read 1.1316 + yet. If gzungetc is used immediately after gzopen or gzdopen, at least the 1.1317 + output buffer size of pushed characters is allowed. (See gzbuffer above.) 1.1318 + The pushed character will be discarded if the stream is repositioned with 1.1319 + gzseek() or gzrewind(). 1.1320 +*/ 1.1321 + 1.1322 +ZEXTERN int ZEXPORT gzflush OF((gzFile file, int flush)); 1.1323 +/* 1.1324 + Flushes all pending output into the compressed file. The parameter flush 1.1325 + is as in the deflate() function. The return value is the zlib error number 1.1326 + (see function gzerror below). gzflush is only permitted when writing. 1.1327 + 1.1328 + If the flush parameter is Z_FINISH, the remaining data is written and the 1.1329 + gzip stream is completed in the output. If gzwrite() is called again, a new 1.1330 + gzip stream will be started in the output. gzread() is able to read such 1.1331 + concatented gzip streams. 1.1332 + 1.1333 + gzflush should be called only when strictly necessary because it will 1.1334 + degrade compression if called too often. 1.1335 +*/ 1.1336 + 1.1337 +/* 1.1338 +ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile file, 1.1339 + z_off_t offset, int whence)); 1.1340 + 1.1341 + Sets the starting position for the next gzread or gzwrite on the given 1.1342 + compressed file. The offset represents a number of bytes in the 1.1343 + uncompressed data stream. The whence parameter is defined as in lseek(2); 1.1344 + the value SEEK_END is not supported. 1.1345 + 1.1346 + If the file is opened for reading, this function is emulated but can be 1.1347 + extremely slow. If the file is opened for writing, only forward seeks are 1.1348 + supported; gzseek then compresses a sequence of zeroes up to the new 1.1349 + starting position. 1.1350 + 1.1351 + gzseek returns the resulting offset location as measured in bytes from 1.1352 + the beginning of the uncompressed stream, or -1 in case of error, in 1.1353 + particular if the file is opened for writing and the new starting position 1.1354 + would be before the current position. 1.1355 +*/ 1.1356 + 1.1357 +ZEXTERN int ZEXPORT gzrewind OF((gzFile file)); 1.1358 +/* 1.1359 + Rewinds the given file. This function is supported only for reading. 1.1360 + 1.1361 + gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET) 1.1362 +*/ 1.1363 + 1.1364 +/* 1.1365 +ZEXTERN z_off_t ZEXPORT gztell OF((gzFile file)); 1.1366 + 1.1367 + Returns the starting position for the next gzread or gzwrite on the given 1.1368 + compressed file. This position represents a number of bytes in the 1.1369 + uncompressed data stream, and is zero when starting, even if appending or 1.1370 + reading a gzip stream from the middle of a file using gzdopen(). 1.1371 + 1.1372 + gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR) 1.1373 +*/ 1.1374 + 1.1375 +/* 1.1376 +ZEXTERN z_off_t ZEXPORT gzoffset OF((gzFile file)); 1.1377 + 1.1378 + Returns the current offset in the file being read or written. This offset 1.1379 + includes the count of bytes that precede the gzip stream, for example when 1.1380 + appending or when using gzdopen() for reading. When reading, the offset 1.1381 + does not include as yet unused buffered input. This information can be used 1.1382 + for a progress indicator. On error, gzoffset() returns -1. 1.1383 +*/ 1.1384 + 1.1385 +ZEXTERN int ZEXPORT gzeof OF((gzFile file)); 1.1386 +/* 1.1387 + Returns true (1) if the end-of-file indicator has been set while reading, 1.1388 + false (0) otherwise. Note that the end-of-file indicator is set only if the 1.1389 + read tried to go past the end of the input, but came up short. Therefore, 1.1390 + just like feof(), gzeof() may return false even if there is no more data to 1.1391 + read, in the event that the last read request was for the exact number of 1.1392 + bytes remaining in the input file. This will happen if the input file size 1.1393 + is an exact multiple of the buffer size. 1.1394 + 1.1395 + If gzeof() returns true, then the read functions will return no more data, 1.1396 + unless the end-of-file indicator is reset by gzclearerr() and the input file 1.1397 + has grown since the previous end of file was detected. 1.1398 +*/ 1.1399 + 1.1400 +ZEXTERN int ZEXPORT gzdirect OF((gzFile file)); 1.1401 +/* 1.1402 + Returns true (1) if file is being copied directly while reading, or false 1.1403 + (0) if file is a gzip stream being decompressed. This state can change from 1.1404 + false to true while reading the input file if the end of a gzip stream is 1.1405 + reached, but is followed by data that is not another gzip stream. 1.1406 + 1.1407 + If the input file is empty, gzdirect() will return true, since the input 1.1408 + does not contain a gzip stream. 1.1409 + 1.1410 + If gzdirect() is used immediately after gzopen() or gzdopen() it will 1.1411 + cause buffers to be allocated to allow reading the file to determine if it 1.1412 + is a gzip file. Therefore if gzbuffer() is used, it should be called before 1.1413 + gzdirect(). 1.1414 +*/ 1.1415 + 1.1416 +ZEXTERN int ZEXPORT gzclose OF((gzFile file)); 1.1417 +/* 1.1418 + Flushes all pending output if necessary, closes the compressed file and 1.1419 + deallocates the (de)compression state. Note that once file is closed, you 1.1420 + cannot call gzerror with file, since its structures have been deallocated. 1.1421 + gzclose must not be called more than once on the same file, just as free 1.1422 + must not be called more than once on the same allocation. 1.1423 + 1.1424 + gzclose will return Z_STREAM_ERROR if file is not valid, Z_ERRNO on a 1.1425 + file operation error, or Z_OK on success. 1.1426 +*/ 1.1427 + 1.1428 +ZEXTERN int ZEXPORT gzclose_r OF((gzFile file)); 1.1429 +ZEXTERN int ZEXPORT gzclose_w OF((gzFile file)); 1.1430 +/* 1.1431 + Same as gzclose(), but gzclose_r() is only for use when reading, and 1.1432 + gzclose_w() is only for use when writing or appending. The advantage to 1.1433 + using these instead of gzclose() is that they avoid linking in zlib 1.1434 + compression or decompression code that is not used when only reading or only 1.1435 + writing respectively. If gzclose() is used, then both compression and 1.1436 + decompression code will be included the application when linking to a static 1.1437 + zlib library. 1.1438 +*/ 1.1439 + 1.1440 +ZEXTERN const char * ZEXPORT gzerror OF((gzFile file, int *errnum)); 1.1441 +/* 1.1442 + Returns the error message for the last error which occurred on the given 1.1443 + compressed file. errnum is set to zlib error number. If an error occurred 1.1444 + in the file system and not in the compression library, errnum is set to 1.1445 + Z_ERRNO and the application may consult errno to get the exact error code. 1.1446 + 1.1447 + The application must not modify the returned string. Future calls to 1.1448 + this function may invalidate the previously returned string. If file is 1.1449 + closed, then the string previously returned by gzerror will no longer be 1.1450 + available. 1.1451 + 1.1452 + gzerror() should be used to distinguish errors from end-of-file for those 1.1453 + functions above that do not distinguish those cases in their return values. 1.1454 +*/ 1.1455 + 1.1456 +ZEXTERN void ZEXPORT gzclearerr OF((gzFile file)); 1.1457 +/* 1.1458 + Clears the error and end-of-file flags for file. This is analogous to the 1.1459 + clearerr() function in stdio. This is useful for continuing to read a gzip 1.1460 + file that is being written concurrently. 1.1461 +*/ 1.1462 + 1.1463 + 1.1464 + /* checksum functions */ 1.1465 + 1.1466 +/* 1.1467 + These functions are not related to compression but are exported 1.1468 + anyway because they might be useful in applications using the compression 1.1469 + library. 1.1470 +*/ 1.1471 + 1.1472 +ZEXTERN uLong ZEXPORT adler32 OF((uLong adler, const Bytef *buf, uInt len)); 1.1473 +/* 1.1474 + Update a running Adler-32 checksum with the bytes buf[0..len-1] and 1.1475 + return the updated checksum. If buf is Z_NULL, this function returns the 1.1476 + required initial value for the checksum. 1.1477 + 1.1478 + An Adler-32 checksum is almost as reliable as a CRC32 but can be computed 1.1479 + much faster. 1.1480 + 1.1481 + Usage example: 1.1482 + 1.1483 + uLong adler = adler32(0L, Z_NULL, 0); 1.1484 + 1.1485 + while (read_buffer(buffer, length) != EOF) { 1.1486 + adler = adler32(adler, buffer, length); 1.1487 + } 1.1488 + if (adler != original_adler) error(); 1.1489 +*/ 1.1490 + 1.1491 +/* 1.1492 +ZEXTERN uLong ZEXPORT adler32_combine OF((uLong adler1, uLong adler2, 1.1493 + z_off_t len2)); 1.1494 + 1.1495 + Combine two Adler-32 checksums into one. For two sequences of bytes, seq1 1.1496 + and seq2 with lengths len1 and len2, Adler-32 checksums were calculated for 1.1497 + each, adler1 and adler2. adler32_combine() returns the Adler-32 checksum of 1.1498 + seq1 and seq2 concatenated, requiring only adler1, adler2, and len2. 1.1499 +*/ 1.1500 + 1.1501 +ZEXTERN uLong ZEXPORT crc32 OF((uLong crc, const Bytef *buf, uInt len)); 1.1502 +/* 1.1503 + Update a running CRC-32 with the bytes buf[0..len-1] and return the 1.1504 + updated CRC-32. If buf is Z_NULL, this function returns the required 1.1505 + initial value for the for the crc. Pre- and post-conditioning (one's 1.1506 + complement) is performed within this function so it shouldn't be done by the 1.1507 + application. 1.1508 + 1.1509 + Usage example: 1.1510 + 1.1511 + uLong crc = crc32(0L, Z_NULL, 0); 1.1512 + 1.1513 + while (read_buffer(buffer, length) != EOF) { 1.1514 + crc = crc32(crc, buffer, length); 1.1515 + } 1.1516 + if (crc != original_crc) error(); 1.1517 +*/ 1.1518 + 1.1519 +/* 1.1520 +ZEXTERN uLong ZEXPORT crc32_combine OF((uLong crc1, uLong crc2, z_off_t len2)); 1.1521 + 1.1522 + Combine two CRC-32 check values into one. For two sequences of bytes, 1.1523 + seq1 and seq2 with lengths len1 and len2, CRC-32 check values were 1.1524 + calculated for each, crc1 and crc2. crc32_combine() returns the CRC-32 1.1525 + check value of seq1 and seq2 concatenated, requiring only crc1, crc2, and 1.1526 + len2. 1.1527 +*/ 1.1528 + 1.1529 + 1.1530 + /* various hacks, don't look :) */ 1.1531 + 1.1532 +/* deflateInit and inflateInit are macros to allow checking the zlib version 1.1533 + * and the compiler's view of z_stream: 1.1534 + */ 1.1535 +ZEXTERN int ZEXPORT deflateInit_ OF((z_streamp strm, int level, 1.1536 + const char *version, int stream_size)); 1.1537 +ZEXTERN int ZEXPORT inflateInit_ OF((z_streamp strm, 1.1538 + const char *version, int stream_size)); 1.1539 +ZEXTERN int ZEXPORT deflateInit2_ OF((z_streamp strm, int level, int method, 1.1540 + int windowBits, int memLevel, 1.1541 + int strategy, const char *version, 1.1542 + int stream_size)); 1.1543 +ZEXTERN int ZEXPORT inflateInit2_ OF((z_streamp strm, int windowBits, 1.1544 + const char *version, int stream_size)); 1.1545 +ZEXTERN int ZEXPORT inflateBackInit_ OF((z_streamp strm, int windowBits, 1.1546 + unsigned char FAR *window, 1.1547 + const char *version, 1.1548 + int stream_size)); 1.1549 +#define deflateInit(strm, level) \ 1.1550 + deflateInit_((strm), (level), ZLIB_VERSION, sizeof(z_stream)) 1.1551 +#define inflateInit(strm) \ 1.1552 + inflateInit_((strm), ZLIB_VERSION, sizeof(z_stream)) 1.1553 +#define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \ 1.1554 + deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\ 1.1555 + (strategy), ZLIB_VERSION, sizeof(z_stream)) 1.1556 +#define inflateInit2(strm, windowBits) \ 1.1557 + inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream)) 1.1558 +#define inflateBackInit(strm, windowBits, window) \ 1.1559 + inflateBackInit_((strm), (windowBits), (window), \ 1.1560 + ZLIB_VERSION, sizeof(z_stream)) 1.1561 + 1.1562 +/* provide 64-bit offset functions if _LARGEFILE64_SOURCE defined, and/or 1.1563 + * change the regular functions to 64 bits if _FILE_OFFSET_BITS is 64 (if 1.1564 + * both are true, the application gets the *64 functions, and the regular 1.1565 + * functions are changed to 64 bits) -- in case these are set on systems 1.1566 + * without large file support, _LFS64_LARGEFILE must also be true 1.1567 + */ 1.1568 +#if defined(_LARGEFILE64_SOURCE) && _LFS64_LARGEFILE-0 1.1569 + ZEXTERN gzFile ZEXPORT gzopen64 OF((const char *, const char *)); 1.1570 + ZEXTERN z_off64_t ZEXPORT gzseek64 OF((gzFile, z_off64_t, int)); 1.1571 + ZEXTERN z_off64_t ZEXPORT gztell64 OF((gzFile)); 1.1572 + ZEXTERN z_off64_t ZEXPORT gzoffset64 OF((gzFile)); 1.1573 + ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, z_off64_t)); 1.1574 + ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, z_off64_t)); 1.1575 +#endif 1.1576 + 1.1577 +#if !defined(ZLIB_INTERNAL) && _FILE_OFFSET_BITS-0 == 64 && _LFS64_LARGEFILE-0 1.1578 +# define gzopen gzopen64 1.1579 +# define gzseek gzseek64 1.1580 +# define gztell gztell64 1.1581 +# define gzoffset gzoffset64 1.1582 +# define adler32_combine adler32_combine64 1.1583 +# define crc32_combine crc32_combine64 1.1584 +# ifdef _LARGEFILE64_SOURCE 1.1585 + ZEXTERN gzFile ZEXPORT gzopen64 OF((const char *, const char *)); 1.1586 + ZEXTERN z_off_t ZEXPORT gzseek64 OF((gzFile, z_off_t, int)); 1.1587 + ZEXTERN z_off_t ZEXPORT gztell64 OF((gzFile)); 1.1588 + ZEXTERN z_off_t ZEXPORT gzoffset64 OF((gzFile)); 1.1589 + ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, z_off_t)); 1.1590 + ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, z_off_t)); 1.1591 +# endif 1.1592 +#else 1.1593 + ZEXTERN gzFile ZEXPORT gzopen OF((const char *, const char *)); 1.1594 + ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile, z_off_t, int)); 1.1595 + ZEXTERN z_off_t ZEXPORT gztell OF((gzFile)); 1.1596 + ZEXTERN z_off_t ZEXPORT gzoffset OF((gzFile)); 1.1597 + ZEXTERN uLong ZEXPORT adler32_combine OF((uLong, uLong, z_off_t)); 1.1598 + ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t)); 1.1599 +#endif 1.1600 + 1.1601 +/* hack for buggy compilers */ 1.1602 +#if !defined(ZUTIL_H) && !defined(NO_DUMMY_DECL) 1.1603 + struct internal_state {int dummy;}; 1.1604 +#endif 1.1605 + 1.1606 +/* undocumented functions */ 1.1607 +ZEXTERN const char * ZEXPORT zError OF((int)); 1.1608 +ZEXTERN int ZEXPORT inflateSyncPoint OF((z_streamp)); 1.1609 +ZEXTERN const uLongf * ZEXPORT get_crc_table OF((void)); 1.1610 +ZEXTERN int ZEXPORT inflateUndermine OF((z_streamp, int)); 1.1611 + 1.1612 +#ifdef __cplusplus 1.1613 +} 1.1614 +#endif 1.1615 + 1.1616 +#endif /* ZLIB_H */