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