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