1.1 --- a/epoc32/include/ezlib.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/ezlib.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,924 @@
1.4 -ezlib.h
1.5 +/* zlib.h -- interface of the 'zlib' general purpose compression library
1.6 + version 1.1.3, July 9th, 1998
1.7 +
1.8 + Copyright (C) 1995-1998 Jean-loup Gailly and Mark Adler
1.9 +
1.10 + This software is provided 'as-is', without any express or implied
1.11 + warranty. In no event will the authors be held liable for any damages
1.12 + arising from the use of this software.
1.13 +
1.14 + Permission is granted to anyone to use this software for any purpose,
1.15 + including commercial applications, and to alter it and redistribute it
1.16 + freely, subject to the following restrictions:
1.17 +
1.18 + 1. The origin of this software must not be misrepresented; you must not
1.19 + claim that you wrote the original software. If you use this software
1.20 + in a product, an acknowledgment in the product documentation would be
1.21 + appreciated but is not required.
1.22 + 2. Altered source versions must be plainly marked as such, and must not be
1.23 + misrepresented as being the original software.
1.24 + 3. This notice may not be removed or altered from any source distribution.
1.25 +
1.26 + Jean-loup Gailly Mark Adler
1.27 + jloup@gzip.org madler@alumni.caltech.edu
1.28 +
1.29 +
1.30 + The data format used by the zlib library is described by RFCs (Request for
1.31 + Comments) 1950 to 1952 in the files ftp://ds.internic.net/rfc/rfc1950.txt
1.32 + (zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format).
1.33 +*/
1.34 +
1.35 +/*
1.36 +This is an altered version of the zlib library designed to run on EPOC
1.37 +Symbian Markr 5/11/99
1.38 +*/
1.39 +
1.40 +#ifndef _ZLIB_H
1.41 +#define _ZLIB_H
1.42 +
1.43 +#ifdef __cplusplus
1.44 +extern "C" {
1.45 +#endif
1.46 +
1.47 +#include <ezconf.h>
1.48 +
1.49 +#define ZLIB_VERSION "1.1.3"
1.50 +
1.51 +/*
1.52 + The 'zlib' compression library provides in-memory compression and
1.53 + decompression functions, including integrity checks of the uncompressed
1.54 + data. This version of the library supports only one compression method
1.55 + (deflation) but other algorithms will be added later and will have the same
1.56 + stream interface.
1.57 +
1.58 + Compression can be done in a single step if the buffers are large
1.59 + enough (for example if an input file is mmap'ed), or can be done by
1.60 + repeated calls of the compression function. In the latter case, the
1.61 + application must provide more input and/or consume the output
1.62 + (providing more output space) before each call.
1.63 +
1.64 + The library also supports reading and writing files in gzip (.gz) format
1.65 + with an interface similar to that of stdio.
1.66 +
1.67 + The library does not install any signal handler. The decoder checks
1.68 + the consistency of the compressed data, so the library should never
1.69 + crash even in case of corrupted input.
1.70 +*/
1.71 +
1.72 +typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size));
1.73 +typedef void (*free_func) OF((voidpf opaque, voidpf address));
1.74 +
1.75 +struct internal_state;
1.76 +
1.77 +/**
1.78 +Encapsulates a zip stream
1.79 +
1.80 +@publishedAll
1.81 +@released
1.82 +*/
1.83 +typedef struct z_stream_s {
1.84 + /** next input byte */
1.85 + Bytef *next_in;
1.86 + /** number of bytes available at next_in */
1.87 + uInt avail_in;
1.88 + /** total nb of input bytes read so far */
1.89 + uLong total_in;
1.90 +
1.91 + /** next output byte should be put there */
1.92 + Bytef *next_out;
1.93 + /** remaining free space at next_out */
1.94 + uInt avail_out;
1.95 + /** total nb of bytes output so far */
1.96 + uLong total_out;
1.97 +
1.98 + /** last error message, NULL if no error */
1.99 + char *msg;
1.100 + /* not visible by applications */
1.101 + struct internal_state FAR *state;
1.102 +
1.103 + /** used to allocate the internal state */
1.104 + alloc_func zalloc;
1.105 + /** used to free the internal state */
1.106 + free_func zfree;
1.107 + /** private data object passed to zalloc and zfree */
1.108 + voidpf opaque;
1.109 +
1.110 + /** best guess about the data type: ascii or binary */
1.111 + int data_type;
1.112 + /** adler32 value of the uncompressed data */
1.113 + uLong adler;
1.114 + /** reserved for future use */
1.115 + uLong reserved;
1.116 +} z_stream;
1.117 +
1.118 +typedef z_stream FAR *z_streamp;
1.119 +
1.120 +/*
1.121 + The application must update next_in and avail_in when avail_in has
1.122 + dropped to zero. It must update next_out and avail_out when avail_out
1.123 + has dropped to zero. The application must initialize zalloc, zfree and
1.124 + opaque before calling the init function. All other fields are set by the
1.125 + compression library and must not be updated by the application.
1.126 +
1.127 + The opaque value provided by the application will be passed as the first
1.128 + parameter for calls of zalloc and zfree. This can be useful for custom
1.129 + memory management. The compression library attaches no meaning to the
1.130 + opaque value.
1.131 +
1.132 + zalloc must return Z_NULL if there is not enough memory for the object.
1.133 + If zlib is used in a multi-threaded application, zalloc and zfree must be
1.134 + thread safe.
1.135 +
1.136 + On 16-bit systems, the functions zalloc and zfree must be able to allocate
1.137 + exactly 65536 bytes, but will not be required to allocate more than this
1.138 + if the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS,
1.139 + pointers returned by zalloc for objects of exactly 65536 bytes *must*
1.140 + have their offset normalized to zero. The default allocation function
1.141 + provided by this library ensures this (see zutil.c). To reduce memory
1.142 + requirements and avoid any allocation of 64K objects, at the expense of
1.143 + compression ratio, compile the library with -DMAX_WBITS=14 (see zconf.h).
1.144 +
1.145 + The fields total_in and total_out can be used for statistics or
1.146 + progress reports. After compression, total_in holds the total size of
1.147 + the uncompressed data and may be saved for use in the decompressor
1.148 + (particularly if the decompressor wants to decompress everything in
1.149 + a single step).
1.150 +*/
1.151 +
1.152 + /* constants */
1.153 +
1.154 +#define Z_NO_FLUSH 0
1.155 +#define Z_PARTIAL_FLUSH 1 /* will be removed, use Z_SYNC_FLUSH instead */
1.156 +#define Z_SYNC_FLUSH 2
1.157 +#define Z_FULL_FLUSH 3
1.158 +#define Z_FINISH 4
1.159 +/* Allowed flush values; see deflate() below for details */
1.160 +
1.161 +#define Z_OK 0
1.162 +#define Z_STREAM_END 1
1.163 +#define Z_NEED_DICT 2
1.164 +#define Z_ERRNO (-1)
1.165 +#define Z_STREAM_ERROR (-2)
1.166 +#define Z_DATA_ERROR (-3)
1.167 +#define Z_MEM_ERROR (-4)
1.168 +#define Z_BUF_ERROR (-5)
1.169 +#define Z_VERSION_ERROR (-6)
1.170 +/* Return codes for the compression/decompression functions. Negative
1.171 + * values are errors, positive values are used for special but normal events.
1.172 + */
1.173 +
1.174 +#define Z_NO_COMPRESSION 0
1.175 +#define Z_BEST_SPEED 1
1.176 +#define Z_BEST_COMPRESSION 9
1.177 +#define Z_DEFAULT_COMPRESSION (-1)
1.178 +/* compression levels */
1.179 +
1.180 +#define Z_FILTERED 1
1.181 +#define Z_HUFFMAN_ONLY 2
1.182 +#define Z_DEFAULT_STRATEGY 0
1.183 +/* compression strategy; see deflateInit2() below for details */
1.184 +
1.185 +#define Z_BINARY 0
1.186 +#define Z_ASCII 1
1.187 +#define Z_UNKNOWN 2
1.188 +/* Possible values of the data_type field */
1.189 +
1.190 +#define Z_DEFLATED 8
1.191 +/* The deflate compression method (the only one supported in this version) */
1.192 +
1.193 +#define Z_NULL 0 /* for initializing zalloc, zfree, opaque */
1.194 +
1.195 +#define zlib_version zlibVersion()
1.196 +/* for compatibility with versions < 1.0.2 */
1.197 +
1.198 + /* basic functions */
1.199 +
1.200 +ZEXTERN const char * ZEXPORT zlibVersion OF((void));
1.201 +/* The application can compare zlibVersion and ZLIB_VERSION for consistency.
1.202 + If the first character differs, the library code actually used is
1.203 + not compatible with the zlib.h header file used by the application.
1.204 + This check is automatically made by deflateInit and inflateInit.
1.205 + */
1.206 +
1.207 +/*
1.208 +ZEXTERN int ZEXPORT deflateInit OF((z_streamp strm, int level));
1.209 +
1.210 + Initializes the internal stream state for compression. The fields
1.211 + zalloc, zfree and opaque must be initialized before by the caller.
1.212 + If zalloc and zfree are set to Z_NULL, deflateInit updates them to
1.213 + use default allocation functions.
1.214 +
1.215 + The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9:
1.216 + 1 gives best speed, 9 gives best compression, 0 gives no compression at
1.217 + all (the input data is simply copied a block at a time).
1.218 + Z_DEFAULT_COMPRESSION requests a default compromise between speed and
1.219 + compression (currently equivalent to level 6).
1.220 +
1.221 + deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not
1.222 + enough memory, Z_STREAM_ERROR if level is not a valid compression level,
1.223 + Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible
1.224 + with the version assumed by the caller (ZLIB_VERSION).
1.225 + msg is set to null if there is no error message. deflateInit does not
1.226 + perform any compression: this will be done by deflate().
1.227 +*/
1.228 +
1.229 +
1.230 +ZEXTERN int ZEXPORT deflate OF((z_streamp strm, int flush));
1.231 +/*
1.232 + deflate compresses as much data as possible, and stops when the input
1.233 + buffer becomes empty or the output buffer becomes full. It may introduce some
1.234 + output latency (reading input without producing any output) except when
1.235 + forced to flush.
1.236 +
1.237 + The detailed semantics are as follows. deflate performs one or both of the
1.238 + following actions:
1.239 +
1.240 + - Compress more input starting at next_in and update next_in and avail_in
1.241 + accordingly. If not all input can be processed (because there is not
1.242 + enough room in the output buffer), next_in and avail_in are updated and
1.243 + processing will resume at this point for the next call of deflate().
1.244 +
1.245 + - Provide more output starting at next_out and update next_out and avail_out
1.246 + accordingly. This action is forced if the parameter flush is non zero.
1.247 + Forcing flush frequently degrades the compression ratio, so this parameter
1.248 + should be set only when necessary (in interactive applications).
1.249 + Some output may be provided even if flush is not set.
1.250 +
1.251 + Before the call of deflate(), the application should ensure that at least
1.252 + one of the actions is possible, by providing more input and/or consuming
1.253 + more output, and updating avail_in or avail_out accordingly; avail_out
1.254 + should never be zero before the call. The application can consume the
1.255 + compressed output when it wants, for example when the output buffer is full
1.256 + (avail_out == 0), or after each call of deflate(). If deflate returns Z_OK
1.257 + and with zero avail_out, it must be called again after making room in the
1.258 + output buffer because there might be more output pending.
1.259 +
1.260 + If the parameter flush is set to Z_SYNC_FLUSH, all pending output is
1.261 + flushed to the output buffer and the output is aligned on a byte boundary, so
1.262 + that the decompressor can get all input data available so far. (In particular
1.263 + avail_in is zero after the call if enough output space has been provided
1.264 + before the call.) Flushing may degrade compression for some compression
1.265 + algorithms and so it should be used only when necessary.
1.266 +
1.267 + If flush is set to Z_FULL_FLUSH, all output is flushed as with
1.268 + Z_SYNC_FLUSH, and the compression state is reset so that decompression can
1.269 + restart from this point if previous compressed data has been damaged or if
1.270 + random access is desired. Using Z_FULL_FLUSH too often can seriously degrade
1.271 + the compression.
1.272 +
1.273 + If deflate returns with avail_out == 0, this function must be called again
1.274 + with the same value of the flush parameter and more output space (updated
1.275 + avail_out), until the flush is complete (deflate returns with non-zero
1.276 + avail_out).
1.277 +
1.278 + If the parameter flush is set to Z_FINISH, pending input is processed,
1.279 + pending output is flushed and deflate returns with Z_STREAM_END if there
1.280 + was enough output space; if deflate returns with Z_OK, this function must be
1.281 + called again with Z_FINISH and more output space (updated avail_out) but no
1.282 + more input data, until it returns with Z_STREAM_END or an error. After
1.283 + deflate has returned Z_STREAM_END, the only possible operations on the
1.284 + stream are deflateReset or deflateEnd.
1.285 +
1.286 + Z_FINISH can be used immediately after deflateInit if all the compression
1.287 + is to be done in a single step. In this case, avail_out must be at least
1.288 + 0.1% larger than avail_in plus 12 bytes. If deflate does not return
1.289 + Z_STREAM_END, then it must be called again as described above.
1.290 +
1.291 + deflate() sets strm->adler to the adler32 checksum of all input read
1.292 + so far (that is, total_in bytes).
1.293 +
1.294 + deflate() may update data_type if it can make a good guess about
1.295 + the input data type (Z_ASCII or Z_BINARY). In doubt, the data is considered
1.296 + binary. This field is only for information purposes and does not affect
1.297 + the compression algorithm in any manner.
1.298 +
1.299 + deflate() returns Z_OK if some progress has been made (more input
1.300 + processed or more output produced), Z_STREAM_END if all input has been
1.301 + consumed and all output has been produced (only when flush is set to
1.302 + Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example
1.303 + if next_in or next_out was NULL), Z_BUF_ERROR if no progress is possible
1.304 + (for example avail_in or avail_out was zero).
1.305 +*/
1.306 +
1.307 +
1.308 +ZEXTERN int ZEXPORT deflateEnd OF((z_streamp strm));
1.309 +/*
1.310 + All dynamically allocated data structures for this stream are freed.
1.311 + This function discards any unprocessed input and does not flush any
1.312 + pending output.
1.313 +
1.314 + deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the
1.315 + stream state was inconsistent, Z_DATA_ERROR if the stream was freed
1.316 + prematurely (some input or output was discarded). In the error case,
1.317 + msg may be set but then points to a static string (which must not be
1.318 + deallocated).
1.319 +*/
1.320 +
1.321 +
1.322 +/*
1.323 +ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm));
1.324 +
1.325 + Initializes the internal stream state for decompression. The fields
1.326 + next_in, avail_in, zalloc, zfree and opaque must be initialized before by
1.327 + the caller. If next_in is not Z_NULL and avail_in is large enough (the exact
1.328 + value depends on the compression method), inflateInit determines the
1.329 + compression method from the zlib header and allocates all data structures
1.330 + accordingly; otherwise the allocation will be deferred to the first call of
1.331 + inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them to
1.332 + use default allocation functions.
1.333 +
1.334 + inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough
1.335 + memory, Z_VERSION_ERROR if the zlib library version is incompatible with the
1.336 + version assumed by the caller. msg is set to null if there is no error
1.337 + message. inflateInit does not perform any decompression apart from reading
1.338 + the zlib header if present: this will be done by inflate(). (So next_in and
1.339 + avail_in may be modified, but next_out and avail_out are unchanged.)
1.340 +*/
1.341 +
1.342 +
1.343 +ZEXTERN int ZEXPORT inflate OF((z_streamp strm, int flush));
1.344 +/*
1.345 + inflate decompresses as much data as possible, and stops when the input
1.346 + buffer becomes empty or the output buffer becomes full. It may some
1.347 + introduce some output latency (reading input without producing any output)
1.348 + except when forced to flush.
1.349 +
1.350 + The detailed semantics are as follows. inflate performs one or both of the
1.351 + following actions:
1.352 +
1.353 + - Decompress more input starting at next_in and update next_in and avail_in
1.354 + accordingly. If not all input can be processed (because there is not
1.355 + enough room in the output buffer), next_in is updated and processing
1.356 + will resume at this point for the next call of inflate().
1.357 +
1.358 + - Provide more output starting at next_out and update next_out and avail_out
1.359 + accordingly. inflate() provides as much output as possible, until there
1.360 + is no more input data or no more space in the output buffer (see below
1.361 + about the flush parameter).
1.362 +
1.363 + Before the call of inflate(), the application should ensure that at least
1.364 + one of the actions is possible, by providing more input and/or consuming
1.365 + more output, and updating the next_* and avail_* values accordingly.
1.366 + The application can consume the uncompressed output when it wants, for
1.367 + example when the output buffer is full (avail_out == 0), or after each
1.368 + call of inflate(). If inflate returns Z_OK and with zero avail_out, it
1.369 + must be called again after making room in the output buffer because there
1.370 + might be more output pending.
1.371 +
1.372 + If the parameter flush is set to Z_SYNC_FLUSH, inflate flushes as much
1.373 + output as possible to the output buffer. The flushing behavior of inflate is
1.374 + not specified for values of the flush parameter other than Z_SYNC_FLUSH
1.375 + and Z_FINISH, but the current implementation actually flushes as much output
1.376 + as possible anyway.
1.377 +
1.378 + inflate() should normally be called until it returns Z_STREAM_END or an
1.379 + error. However if all decompression is to be performed in a single step
1.380 + (a single call of inflate), the parameter flush should be set to
1.381 + Z_FINISH. In this case all pending input is processed and all pending
1.382 + output is flushed; avail_out must be large enough to hold all the
1.383 + uncompressed data. (The size of the uncompressed data may have been saved
1.384 + by the compressor for this purpose.) The next operation on this stream must
1.385 + be inflateEnd to deallocate the decompression state. The use of Z_FINISH
1.386 + is never required, but can be used to inform inflate that a faster routine
1.387 + may be used for the single inflate() call.
1.388 +
1.389 + If a preset dictionary is needed at this point (see inflateSetDictionary
1.390 + below), inflate sets strm-adler to the adler32 checksum of the
1.391 + dictionary chosen by the compressor and returns Z_NEED_DICT; otherwise
1.392 + it sets strm->adler to the adler32 checksum of all output produced
1.393 + so far (that is, total_out bytes) and returns Z_OK, Z_STREAM_END or
1.394 + an error code as described below. At the end of the stream, inflate()
1.395 + checks that its computed adler32 checksum is equal to that saved by the
1.396 + compressor and returns Z_STREAM_END only if the checksum is correct.
1.397 +
1.398 + inflate() returns Z_OK if some progress has been made (more input processed
1.399 + or more output produced), Z_STREAM_END if the end of the compressed data has
1.400 + been reached and all uncompressed output has been produced, Z_NEED_DICT if a
1.401 + preset dictionary is needed at this point, Z_DATA_ERROR if the input data was
1.402 + corrupted (input stream not conforming to the zlib format or incorrect
1.403 + adler32 checksum), Z_STREAM_ERROR if the stream structure was inconsistent
1.404 + (for example if next_in or next_out was NULL), Z_MEM_ERROR if there was not
1.405 + enough memory, Z_BUF_ERROR if no progress is possible or if there was not
1.406 + enough room in the output buffer when Z_FINISH is used. In the Z_DATA_ERROR
1.407 + case, the application may then call inflateSync to look for a good
1.408 + compression block.
1.409 +*/
1.410 +
1.411 +
1.412 +ZEXTERN int ZEXPORT inflateEnd OF((z_streamp strm));
1.413 +/*
1.414 + All dynamically allocated data structures for this stream are freed.
1.415 + This function discards any unprocessed input and does not flush any
1.416 + pending output.
1.417 +
1.418 + inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state
1.419 + was inconsistent. In the error case, msg may be set but then points to a
1.420 + static string (which must not be deallocated).
1.421 +*/
1.422 +
1.423 + /* Advanced functions */
1.424 +
1.425 +/*
1.426 + The following functions are needed only in some special applications.
1.427 +*/
1.428 +
1.429 +/*
1.430 +ZEXTERN int ZEXPORT deflateInit2 OF((z_streamp strm,
1.431 + int level,
1.432 + int method,
1.433 + int windowBits,
1.434 + int memLevel,
1.435 + int strategy));
1.436 +
1.437 + This is another version of deflateInit with more compression options. The
1.438 + fields next_in, zalloc, zfree and opaque must be initialized before by
1.439 + the caller.
1.440 +
1.441 + The method parameter is the compression method. It must be Z_DEFLATED in
1.442 + this version of the library.
1.443 +
1.444 + The windowBits parameter is the base two logarithm of the window size
1.445 + (the size of the history buffer). It should be in the range 8..15 for this
1.446 + version of the library. Larger values of this parameter result in better
1.447 + compression at the expense of memory usage. The default value is 15 if
1.448 + deflateInit is used instead.
1.449 +
1.450 + The memLevel parameter specifies how much memory should be allocated
1.451 + for the internal compression state. memLevel=1 uses minimum memory but
1.452 + is slow and reduces compression ratio; memLevel=9 uses maximum memory
1.453 + for optimal speed. The default value is 8. See zconf.h for total memory
1.454 + usage as a function of windowBits and memLevel.
1.455 +
1.456 + The strategy parameter is used to tune the compression algorithm. Use the
1.457 + value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a
1.458 + filter (or predictor), or Z_HUFFMAN_ONLY to force Huffman encoding only (no
1.459 + string match). Filtered data consists mostly of small values with a
1.460 + somewhat random distribution. In this case, the compression algorithm is
1.461 + tuned to compress them better. The effect of Z_FILTERED is to force more
1.462 + Huffman coding and less string matching; it is somewhat intermediate
1.463 + between Z_DEFAULT and Z_HUFFMAN_ONLY. The strategy parameter only affects
1.464 + the compression ratio but not the correctness of the compressed output even
1.465 + if it is not set appropriately.
1.466 +
1.467 + deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
1.468 + memory, Z_STREAM_ERROR if a parameter is invalid (such as an invalid
1.469 + method). msg is set to null if there is no error message. deflateInit2 does
1.470 + not perform any compression: this will be done by deflate().
1.471 +*/
1.472 +
1.473 +ZEXTERN int ZEXPORT deflateSetDictionary OF((z_streamp strm,
1.474 + const Bytef *dictionary,
1.475 + uInt dictLength));
1.476 +/*
1.477 + Initializes the compression dictionary from the given byte sequence
1.478 + without producing any compressed output. This function must be called
1.479 + immediately after deflateInit, deflateInit2 or deflateReset, before any
1.480 + call of deflate. The compressor and decompressor must use exactly the same
1.481 + dictionary (see inflateSetDictionary).
1.482 +
1.483 + The dictionary should consist of strings (byte sequences) that are likely
1.484 + to be encountered later in the data to be compressed, with the most commonly
1.485 + used strings preferably put towards the end of the dictionary. Using a
1.486 + dictionary is most useful when the data to be compressed is short and can be
1.487 + predicted with good accuracy; the data can then be compressed better than
1.488 + with the default empty dictionary.
1.489 +
1.490 + Depending on the size of the compression data structures selected by
1.491 + deflateInit or deflateInit2, a part of the dictionary may in effect be
1.492 + discarded, for example if the dictionary is larger than the window size in
1.493 + deflate or deflate2. Thus the strings most likely to be useful should be
1.494 + put at the end of the dictionary, not at the front.
1.495 +
1.496 + Upon return of this function, strm->adler is set to the Adler32 value
1.497 + of the dictionary; the decompressor may later use this value to determine
1.498 + which dictionary has been used by the compressor. (The Adler32 value
1.499 + applies to the whole dictionary even if only a subset of the dictionary is
1.500 + actually used by the compressor.)
1.501 +
1.502 + deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a
1.503 + parameter is invalid (such as NULL dictionary) or the stream state is
1.504 + inconsistent (for example if deflate has already been called for this stream
1.505 + or if the compression method is bsort). deflateSetDictionary does not
1.506 + perform any compression: this will be done by deflate().
1.507 +*/
1.508 +
1.509 +ZEXTERN int ZEXPORT deflateCopy OF((z_streamp dest,
1.510 + z_streamp source));
1.511 +/*
1.512 + Sets the destination stream as a complete copy of the source stream.
1.513 +
1.514 + This function can be useful when several compression strategies will be
1.515 + tried, for example when there are several ways of pre-processing the input
1.516 + data with a filter. The streams that will be discarded should then be freed
1.517 + by calling deflateEnd. Note that deflateCopy duplicates the internal
1.518 + compression state which can be quite large, so this strategy is slow and
1.519 + can consume lots of memory.
1.520 +
1.521 + deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not
1.522 + enough memory, Z_STREAM_ERROR if the source stream state was inconsistent
1.523 + (such as zalloc being NULL). msg is left unchanged in both source and
1.524 + destination.
1.525 +*/
1.526 +
1.527 +ZEXTERN int ZEXPORT deflateReset OF((z_streamp strm));
1.528 +/*
1.529 + This function is equivalent to deflateEnd followed by deflateInit,
1.530 + but does not free and reallocate all the internal compression state.
1.531 + The stream will keep the same compression level and any other attributes
1.532 + that may have been set by deflateInit2.
1.533 +
1.534 + deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
1.535 + stream state was inconsistent (such as zalloc or state being NULL).
1.536 +*/
1.537 +
1.538 +ZEXTERN int ZEXPORT deflateParams OF((z_streamp strm,
1.539 + int level,
1.540 + int strategy));
1.541 +/*
1.542 + Dynamically update the compression level and compression strategy. The
1.543 + interpretation of level and strategy is as in deflateInit2. This can be
1.544 + used to switch between compression and straight copy of the input data, or
1.545 + to switch to a different kind of input data requiring a different
1.546 + strategy. If the compression level is changed, the input available so far
1.547 + is compressed with the old level (and may be flushed); the new level will
1.548 + take effect only at the next call of deflate().
1.549 +
1.550 + Before the call of deflateParams, the stream state must be set as for
1.551 + a call of deflate(), since the currently available input may have to
1.552 + be compressed and flushed. In particular, strm->avail_out must be non-zero.
1.553 +
1.554 + deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source
1.555 + stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR
1.556 + if strm->avail_out was zero.
1.557 +*/
1.558 +
1.559 +/*
1.560 +ZEXTERN int ZEXPORT inflateInit2 OF((z_streamp strm,
1.561 + int windowBits));
1.562 +
1.563 + This is another version of inflateInit with an extra parameter. The
1.564 + fields next_in, avail_in, zalloc, zfree and opaque must be initialized
1.565 + before by the caller.
1.566 +
1.567 + The windowBits parameter is the base two logarithm of the maximum window
1.568 + size (the size of the history buffer). It should be in the range 8..15 for
1.569 + this version of the library. The default value is 15 if inflateInit is used
1.570 + instead. If a compressed stream with a larger window size is given as
1.571 + input, inflate() will return with the error code Z_DATA_ERROR instead of
1.572 + trying to allocate a larger window.
1.573 +
1.574 + inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
1.575 + memory, Z_STREAM_ERROR if a parameter is invalid (such as a negative
1.576 + memLevel). msg is set to null if there is no error message. inflateInit2
1.577 + does not perform any decompression apart from reading the zlib header if
1.578 + present: this will be done by inflate(). (So next_in and avail_in may be
1.579 + modified, but next_out and avail_out are unchanged.)
1.580 +*/
1.581 +
1.582 +ZEXTERN int ZEXPORT inflateSetDictionary OF((z_streamp strm,
1.583 + const Bytef *dictionary,
1.584 + uInt dictLength));
1.585 +/*
1.586 + Initializes the decompression dictionary from the given uncompressed byte
1.587 + sequence. This function must be called immediately after a call of inflate
1.588 + if this call returned Z_NEED_DICT. The dictionary chosen by the compressor
1.589 + can be determined from the Adler32 value returned by this call of
1.590 + inflate. The compressor and decompressor must use exactly the same
1.591 + dictionary (see deflateSetDictionary).
1.592 +
1.593 + inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a
1.594 + parameter is invalid (such as NULL dictionary) or the stream state is
1.595 + inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the
1.596 + expected one (incorrect Adler32 value). inflateSetDictionary does not
1.597 + perform any decompression: this will be done by subsequent calls of
1.598 + inflate().
1.599 +*/
1.600 +
1.601 +ZEXTERN int ZEXPORT inflateSync OF((z_streamp strm));
1.602 +/*
1.603 + Skips invalid compressed data until a full flush point (see above the
1.604 + description of deflate with Z_FULL_FLUSH) can be found, or until all
1.605 + available input is skipped. No output is provided.
1.606 +
1.607 + inflateSync returns Z_OK if a full flush point has been found, Z_BUF_ERROR
1.608 + if no more input was provided, Z_DATA_ERROR if no flush point has been found,
1.609 + or Z_STREAM_ERROR if the stream structure was inconsistent. In the success
1.610 + case, the application may save the current current value of total_in which
1.611 + indicates where valid compressed data was found. In the error case, the
1.612 + application may repeatedly call inflateSync, providing more input each time,
1.613 + until success or end of the input data.
1.614 +*/
1.615 +
1.616 +ZEXTERN int ZEXPORT inflateReset OF((z_streamp strm));
1.617 +/*
1.618 + This function is equivalent to inflateEnd followed by inflateInit,
1.619 + but does not free and reallocate all the internal decompression state.
1.620 + The stream will keep attributes that may have been set by inflateInit2.
1.621 +
1.622 + inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
1.623 + stream state was inconsistent (such as zalloc or state being NULL).
1.624 +*/
1.625 +
1.626 +
1.627 + /* utility functions */
1.628 +
1.629 +/*
1.630 + The following utility functions are implemented on top of the
1.631 + basic stream-oriented functions. To simplify the interface, some
1.632 + default options are assumed (compression level and memory usage,
1.633 + standard memory allocation functions). The source code of these
1.634 + utility functions can easily be modified if you need special options.
1.635 +*/
1.636 +
1.637 +ZEXTERN int ZEXPORT compress OF((Bytef *dest, uLongf *destLen,
1.638 + const Bytef *source, uLong sourceLen));
1.639 +/*
1.640 + Compresses the source buffer into the destination buffer. sourceLen is
1.641 + the byte length of the source buffer. Upon entry, destLen is the total
1.642 + size of the destination buffer, which must be at least 0.1% larger than
1.643 + sourceLen plus 12 bytes. Upon exit, destLen is the actual size of the
1.644 + compressed buffer.
1.645 + This function can be used to compress a whole file at once if the
1.646 + input file is mmap'ed.
1.647 + compress returns Z_OK if success, Z_MEM_ERROR if there was not
1.648 + enough memory, Z_BUF_ERROR if there was not enough room in the output
1.649 + buffer.
1.650 +*/
1.651 +
1.652 +ZEXTERN int ZEXPORT compress2 OF((Bytef *dest, uLongf *destLen,
1.653 + const Bytef *source, uLong sourceLen,
1.654 + int level));
1.655 +/*
1.656 + Compresses the source buffer into the destination buffer. The level
1.657 + parameter has the same meaning as in deflateInit. sourceLen is the byte
1.658 + length of the source buffer. Upon entry, destLen is the total size of the
1.659 + destination buffer, which must be at least 0.1% larger than sourceLen plus
1.660 + 12 bytes. Upon exit, destLen is the actual size of the compressed buffer.
1.661 +
1.662 + compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
1.663 + memory, Z_BUF_ERROR if there was not enough room in the output buffer,
1.664 + Z_STREAM_ERROR if the level parameter is invalid.
1.665 +*/
1.666 +
1.667 +ZEXTERN int ZEXPORT uncompress OF((Bytef *dest, uLongf *destLen,
1.668 + const Bytef *source, uLong sourceLen));
1.669 +/*
1.670 + Decompresses the source buffer into the destination buffer. sourceLen is
1.671 + the byte length of the source buffer. Upon entry, destLen is the total
1.672 + size of the destination buffer, which must be large enough to hold the
1.673 + entire uncompressed data. (The size of the uncompressed data must have
1.674 + been saved previously by the compressor and transmitted to the decompressor
1.675 + by some mechanism outside the scope of this compression library.)
1.676 + Upon exit, destLen is the actual size of the compressed buffer.
1.677 + This function can be used to decompress a whole file at once if the
1.678 + input file is mmap'ed.
1.679 +
1.680 + uncompress returns Z_OK if success, Z_MEM_ERROR if there was not
1.681 + enough memory, Z_BUF_ERROR if there was not enough room in the output
1.682 + buffer, or Z_DATA_ERROR if the input data was corrupted.
1.683 +*/
1.684 +
1.685 +/*
1.686 +typedef voidp gzFile;
1.687 +
1.688 +ZEXTERN gzFile ZEXPORT gzopen OF((const char *path, const char *mode));
1.689 +*/
1.690 +/*
1.691 + Opens a gzip (.gz) file for reading or writing. The mode parameter
1.692 + is as in fopen ("rb" or "wb") but can also include a compression level
1.693 + ("wb9") or a strategy: 'f' for filtered data as in "wb6f", 'h' for
1.694 + Huffman only compression as in "wb1h". (See the description
1.695 + of deflateInit2 for more information about the strategy parameter.)
1.696 +
1.697 + gzopen can be used to read a file which is not in gzip format; in this
1.698 + case gzread will directly read from the file without decompression.
1.699 +
1.700 + gzopen returns NULL if the file could not be opened or if there was
1.701 + insufficient memory to allocate the (de)compression state; errno
1.702 + can be checked to distinguish the two cases (if errno is zero, the
1.703 + zlib error is Z_MEM_ERROR). */
1.704 +
1.705 +//ZEXTERN gzFile ZEXPORT gzdopen OF((int fd, const char *mode));
1.706 +
1.707 +/*
1.708 + gzdopen() associates a gzFile with the file descriptor fd. File
1.709 + descriptors are obtained from calls like open, dup, creat, pipe or
1.710 + fileno (in the file has been previously opened with fopen).
1.711 + The mode parameter is as in gzopen.
1.712 + The next call of gzclose on the returned gzFile will also close the
1.713 + file descriptor fd, just like fclose(fdopen(fd), mode) closes the file
1.714 + descriptor fd. If you want to keep fd open, use gzdopen(dup(fd), mode).
1.715 + gzdopen returns NULL if there was insufficient memory to allocate
1.716 + the (de)compression state.
1.717 +*/
1.718 +
1.719 +//ZEXTERN int ZEXPORT gzsetparams OF((gzFile file, int level, int strategy));
1.720 +/*
1.721 + Dynamically update the compression level or strategy. See the description
1.722 + of deflateInit2 for the meaning of these parameters.
1.723 + gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not
1.724 + opened for writing.
1.725 +*/
1.726 +
1.727 +//ZEXTERN int ZEXPORT gzread OF((gzFile file, voidp buf, unsigned len));
1.728 +/*
1.729 + Reads the given number of uncompressed bytes from the compressed file.
1.730 + If the input file was not in gzip format, gzread copies the given number
1.731 + of bytes into the buffer.
1.732 + gzread returns the number of uncompressed bytes actually read (0 for
1.733 + end of file, -1 for error). */
1.734 +
1.735 +//ZEXTERN int ZEXPORT gzwrite OF((gzFile file,
1.736 +// const voidp buf, unsigned len));
1.737 +/*
1.738 + Writes the given number of uncompressed bytes into the compressed file.
1.739 + gzwrite returns the number of uncompressed bytes actually written
1.740 + (0 in case of error).
1.741 +*/
1.742 +
1.743 +//ZEXTERN int ZEXPORTVA gzprintf OF((gzFile file, const char *format, ...));
1.744 +/*
1.745 + Converts, formats, and writes the args to the compressed file under
1.746 + control of the format string, as in fprintf. gzprintf returns the number of
1.747 + uncompressed bytes actually written (0 in case of error).
1.748 +*/
1.749 +
1.750 +//ZEXTERN int ZEXPORT gzputs OF((gzFile file, const char *s));
1.751 +/*
1.752 + Writes the given null-terminated string to the compressed file, excluding
1.753 + the terminating null character.
1.754 + gzputs returns the number of characters written, or -1 in case of error.
1.755 +*/
1.756 +
1.757 +//ZEXTERN char * ZEXPORT gzgets OF((gzFile file, char *buf, int len));
1.758 +/*
1.759 + Reads bytes from the compressed file until len-1 characters are read, or
1.760 + a newline character is read and transferred to buf, or an end-of-file
1.761 + condition is encountered. The string is then terminated with a null
1.762 + character.
1.763 + gzgets returns buf, or Z_NULL in case of error.
1.764 +*/
1.765 +
1.766 +//ZEXTERN int ZEXPORT gzputc OF((gzFile file, int c));
1.767 +/*
1.768 + Writes c, converted to an unsigned char, into the compressed file.
1.769 + gzputc returns the value that was written, or -1 in case of error.
1.770 +*/
1.771 +
1.772 +//ZEXTERN int ZEXPORT gzgetc OF((gzFile file));
1.773 +/*
1.774 + Reads one byte from the compressed file. gzgetc returns this byte
1.775 + or -1 in case of end of file or error.
1.776 +*/
1.777 +
1.778 +//ZEXTERN int ZEXPORT gzflush OF((gzFile file, int flush));
1.779 +/*
1.780 + Flushes all pending output into the compressed file. The parameter
1.781 + flush is as in the deflate() function. The return value is the zlib
1.782 + error number (see function gzerror below). gzflush returns Z_OK if
1.783 + the flush parameter is Z_FINISH and all output could be flushed.
1.784 + gzflush should be called only when strictly necessary because it can
1.785 + degrade compression.
1.786 +*/
1.787 +
1.788 +//ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile file,
1.789 +// z_off_t offset, int whence));
1.790 +/*
1.791 + Sets the starting position for the next gzread or gzwrite on the
1.792 + given compressed file. The offset represents a number of bytes in the
1.793 + uncompressed data stream. The whence parameter is defined as in lseek(2);
1.794 + the value SEEK_END is not supported.
1.795 + If the file is opened for reading, this function is emulated but can be
1.796 + extremely slow. If the file is opened for writing, only forward seeks are
1.797 + supported; gzseek then compresses a sequence of zeroes up to the new
1.798 + starting position.
1.799 +
1.800 + gzseek returns the resulting offset location as measured in bytes from
1.801 + the beginning of the uncompressed stream, or -1 in case of error, in
1.802 + particular if the file is opened for writing and the new starting position
1.803 + would be before the current position.
1.804 +*/
1.805 +
1.806 +//ZEXTERN int ZEXPORT gzrewind OF((gzFile file));
1.807 +/*
1.808 + Rewinds the given file. This function is supported only for reading.
1.809 +
1.810 + gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET)
1.811 +*/
1.812 +
1.813 +//ZEXTERN z_off_t ZEXPORT gztell OF((gzFile file));
1.814 +/*
1.815 + Returns the starting position for the next gzread or gzwrite on the
1.816 + given compressed file. This position represents a number of bytes in the
1.817 + uncompressed data stream.
1.818 +
1.819 + gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR)
1.820 +*/
1.821 +
1.822 +//ZEXTERN int ZEXPORT gzeof OF((gzFile file));
1.823 +/*
1.824 + Returns 1 when EOF has previously been detected reading the given
1.825 + input stream, otherwise zero.
1.826 +*/
1.827 +
1.828 +//ZEXTERN int ZEXPORT gzclose OF((gzFile file));
1.829 +/*
1.830 + Flushes all pending output if necessary, closes the compressed file
1.831 + and deallocates all the (de)compression state. The return value is the zlib
1.832 + error number (see function gzerror below).
1.833 +*/
1.834 +
1.835 +//ZEXTERN const char * ZEXPORT gzerror OF((gzFile file, int *errnum));
1.836 +/*
1.837 + Returns the error message for the last error which occurred on the
1.838 + given compressed file. errnum is set to zlib error number. If an
1.839 + error occurred in the file system and not in the compression library,
1.840 + errnum is set to Z_ERRNO and the application may consult errno
1.841 + to get the exact error code.
1.842 +*/
1.843 +
1.844 + /* checksum functions */
1.845 +
1.846 +/*
1.847 + These functions are not related to compression but are exported
1.848 + anyway because they might be useful in applications using the
1.849 + compression library.
1.850 +*/
1.851 +
1.852 +ZEXTERN uLong ZEXPORT adler32 OF((uLong adler, const Bytef *buf, uInt len));
1.853 +
1.854 +/*
1.855 + Update a running Adler-32 checksum with the bytes buf[0..len-1] and
1.856 + return the updated checksum. If buf is NULL, this function returns
1.857 + the required initial value for the checksum.
1.858 + An Adler-32 checksum is almost as reliable as a CRC32 but can be computed
1.859 + much faster. Usage example:
1.860 +
1.861 + uLong adler = adler32(0L, Z_NULL, 0);
1.862 +
1.863 + while (read_buffer(buffer, length) != EOF) {
1.864 + adler = adler32(adler, buffer, length);
1.865 + }
1.866 + if (adler != original_adler) error();
1.867 +*/
1.868 +
1.869 +ZEXTERN uLong ZEXPORT crc32 OF((uLong crc, const Bytef *buf, uInt len));
1.870 +/*
1.871 + Update a running crc with the bytes buf[0..len-1] and return the updated
1.872 + crc. If buf is NULL, this function returns the required initial value
1.873 + for the crc. Pre- and post-conditioning (one's complement) is performed
1.874 + within this function so it shouldn't be done by the application.
1.875 + Usage example:
1.876 +
1.877 + uLong crc = crc32(0L, Z_NULL, 0);
1.878 +
1.879 + while (read_buffer(buffer, length) != EOF) {
1.880 + crc = crc32(crc, buffer, length);
1.881 + }
1.882 + if (crc != original_crc) error();
1.883 +*/
1.884 +
1.885 +
1.886 + /* various hacks, don't look :) */
1.887 +
1.888 +/* deflateInit and inflateInit are macros to allow checking the zlib version
1.889 + * and the compiler's view of z_stream:
1.890 + */
1.891 +ZEXTERN int ZEXPORT deflateInit_ OF((z_streamp strm, int level,
1.892 + const char *version, int stream_size));
1.893 +ZEXTERN int ZEXPORT inflateInit_ OF((z_streamp strm,
1.894 + const char *version, int stream_size));
1.895 +ZEXTERN int ZEXPORT deflateInit2_ OF((z_streamp strm, int level, int method,
1.896 + int windowBits, int memLevel,
1.897 + int strategy, const char *version,
1.898 + int stream_size));
1.899 +ZEXTERN int ZEXPORT inflateInit2_ OF((z_streamp strm, int windowBits,
1.900 + const char *version, int stream_size));
1.901 +#define deflateInit(strm, level) \
1.902 + deflateInit_((strm), (level), ZLIB_VERSION, sizeof(z_stream))
1.903 +#define inflateInit(strm) \
1.904 + inflateInit_((strm), ZLIB_VERSION, sizeof(z_stream))
1.905 +#define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \
1.906 + deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\
1.907 + (strategy), ZLIB_VERSION, sizeof(z_stream))
1.908 +#define inflateInit2(strm, windowBits) \
1.909 + inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))
1.910 +
1.911 +
1.912 +#if !defined(_Z_UTIL_H) && !defined(NO_DUMMY_DECL)
1.913 + /**
1.914 + * @publishedAll
1.915 + * @released
1.916 + */
1.917 + struct internal_state {int dummy;}; /* hack for buggy compilers */
1.918 +#endif
1.919 +
1.920 +ZEXTERN const char * ZEXPORT zError OF((int err));
1.921 +ZEXTERN int ZEXPORT inflateSyncPoint OF((z_streamp z));
1.922 +ZEXTERN const uLongf * ZEXPORT get_crc_table OF((void));
1.923 +
1.924 +#ifdef __cplusplus
1.925 +}
1.926 +#endif
1.927 +
1.928 +#endif /* _ZLIB_H */