annotate win32-mingw/include/zlib.h @ 6:35e00f62c407

Further builds
author Chris Cannam
date Wed, 20 Mar 2013 14:58:12 +0000
parents
children
rev   line source
Chris@6 1 /* zlib.h -- interface of the 'zlib' general purpose compression library
Chris@6 2 version 1.2.7, May 2nd, 2012
Chris@6 3
Chris@6 4 Copyright (C) 1995-2012 Jean-loup Gailly and Mark Adler
Chris@6 5
Chris@6 6 This software is provided 'as-is', without any express or implied
Chris@6 7 warranty. In no event will the authors be held liable for any damages
Chris@6 8 arising from the use of this software.
Chris@6 9
Chris@6 10 Permission is granted to anyone to use this software for any purpose,
Chris@6 11 including commercial applications, and to alter it and redistribute it
Chris@6 12 freely, subject to the following restrictions:
Chris@6 13
Chris@6 14 1. The origin of this software must not be misrepresented; you must not
Chris@6 15 claim that you wrote the original software. If you use this software
Chris@6 16 in a product, an acknowledgment in the product documentation would be
Chris@6 17 appreciated but is not required.
Chris@6 18 2. Altered source versions must be plainly marked as such, and must not be
Chris@6 19 misrepresented as being the original software.
Chris@6 20 3. This notice may not be removed or altered from any source distribution.
Chris@6 21
Chris@6 22 Jean-loup Gailly Mark Adler
Chris@6 23 jloup@gzip.org madler@alumni.caltech.edu
Chris@6 24
Chris@6 25
Chris@6 26 The data format used by the zlib library is described by RFCs (Request for
Chris@6 27 Comments) 1950 to 1952 in the files http://tools.ietf.org/html/rfc1950
Chris@6 28 (zlib format), rfc1951 (deflate format) and rfc1952 (gzip format).
Chris@6 29 */
Chris@6 30
Chris@6 31 #ifndef ZLIB_H
Chris@6 32 #define ZLIB_H
Chris@6 33
Chris@6 34 #include "zconf.h"
Chris@6 35
Chris@6 36 #ifdef __cplusplus
Chris@6 37 extern "C" {
Chris@6 38 #endif
Chris@6 39
Chris@6 40 #define ZLIB_VERSION "1.2.7"
Chris@6 41 #define ZLIB_VERNUM 0x1270
Chris@6 42 #define ZLIB_VER_MAJOR 1
Chris@6 43 #define ZLIB_VER_MINOR 2
Chris@6 44 #define ZLIB_VER_REVISION 7
Chris@6 45 #define ZLIB_VER_SUBREVISION 0
Chris@6 46
Chris@6 47 /*
Chris@6 48 The 'zlib' compression library provides in-memory compression and
Chris@6 49 decompression functions, including integrity checks of the uncompressed data.
Chris@6 50 This version of the library supports only one compression method (deflation)
Chris@6 51 but other algorithms will be added later and will have the same stream
Chris@6 52 interface.
Chris@6 53
Chris@6 54 Compression can be done in a single step if the buffers are large enough,
Chris@6 55 or can be done by repeated calls of the compression function. In the latter
Chris@6 56 case, the application must provide more input and/or consume the output
Chris@6 57 (providing more output space) before each call.
Chris@6 58
Chris@6 59 The compressed data format used by default by the in-memory functions is
Chris@6 60 the zlib format, which is a zlib wrapper documented in RFC 1950, wrapped
Chris@6 61 around a deflate stream, which is itself documented in RFC 1951.
Chris@6 62
Chris@6 63 The library also supports reading and writing files in gzip (.gz) format
Chris@6 64 with an interface similar to that of stdio using the functions that start
Chris@6 65 with "gz". The gzip format is different from the zlib format. gzip is a
Chris@6 66 gzip wrapper, documented in RFC 1952, wrapped around a deflate stream.
Chris@6 67
Chris@6 68 This library can optionally read and write gzip streams in memory as well.
Chris@6 69
Chris@6 70 The zlib format was designed to be compact and fast for use in memory
Chris@6 71 and on communications channels. The gzip format was designed for single-
Chris@6 72 file compression on file systems, has a larger header than zlib to maintain
Chris@6 73 directory information, and uses a different, slower check method than zlib.
Chris@6 74
Chris@6 75 The library does not install any signal handler. The decoder checks
Chris@6 76 the consistency of the compressed data, so the library should never crash
Chris@6 77 even in case of corrupted input.
Chris@6 78 */
Chris@6 79
Chris@6 80 typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size));
Chris@6 81 typedef void (*free_func) OF((voidpf opaque, voidpf address));
Chris@6 82
Chris@6 83 struct internal_state;
Chris@6 84
Chris@6 85 typedef struct z_stream_s {
Chris@6 86 z_const Bytef *next_in; /* next input byte */
Chris@6 87 uInt avail_in; /* number of bytes available at next_in */
Chris@6 88 uLong total_in; /* total number of input bytes read so far */
Chris@6 89
Chris@6 90 Bytef *next_out; /* next output byte should be put there */
Chris@6 91 uInt avail_out; /* remaining free space at next_out */
Chris@6 92 uLong total_out; /* total number of bytes output so far */
Chris@6 93
Chris@6 94 z_const char *msg; /* last error message, NULL if no error */
Chris@6 95 struct internal_state FAR *state; /* not visible by applications */
Chris@6 96
Chris@6 97 alloc_func zalloc; /* used to allocate the internal state */
Chris@6 98 free_func zfree; /* used to free the internal state */
Chris@6 99 voidpf opaque; /* private data object passed to zalloc and zfree */
Chris@6 100
Chris@6 101 int data_type; /* best guess about the data type: binary or text */
Chris@6 102 uLong adler; /* adler32 value of the uncompressed data */
Chris@6 103 uLong reserved; /* reserved for future use */
Chris@6 104 } z_stream;
Chris@6 105
Chris@6 106 typedef z_stream FAR *z_streamp;
Chris@6 107
Chris@6 108 /*
Chris@6 109 gzip header information passed to and from zlib routines. See RFC 1952
Chris@6 110 for more details on the meanings of these fields.
Chris@6 111 */
Chris@6 112 typedef struct gz_header_s {
Chris@6 113 int text; /* true if compressed data believed to be text */
Chris@6 114 uLong time; /* modification time */
Chris@6 115 int xflags; /* extra flags (not used when writing a gzip file) */
Chris@6 116 int os; /* operating system */
Chris@6 117 Bytef *extra; /* pointer to extra field or Z_NULL if none */
Chris@6 118 uInt extra_len; /* extra field length (valid if extra != Z_NULL) */
Chris@6 119 uInt extra_max; /* space at extra (only when reading header) */
Chris@6 120 Bytef *name; /* pointer to zero-terminated file name or Z_NULL */
Chris@6 121 uInt name_max; /* space at name (only when reading header) */
Chris@6 122 Bytef *comment; /* pointer to zero-terminated comment or Z_NULL */
Chris@6 123 uInt comm_max; /* space at comment (only when reading header) */
Chris@6 124 int hcrc; /* true if there was or will be a header crc */
Chris@6 125 int done; /* true when done reading gzip header (not used
Chris@6 126 when writing a gzip file) */
Chris@6 127 } gz_header;
Chris@6 128
Chris@6 129 typedef gz_header FAR *gz_headerp;
Chris@6 130
Chris@6 131 /*
Chris@6 132 The application must update next_in and avail_in when avail_in has dropped
Chris@6 133 to zero. It must update next_out and avail_out when avail_out has dropped
Chris@6 134 to zero. The application must initialize zalloc, zfree and opaque before
Chris@6 135 calling the init function. All other fields are set by the compression
Chris@6 136 library and must not be updated by the application.
Chris@6 137
Chris@6 138 The opaque value provided by the application will be passed as the first
Chris@6 139 parameter for calls of zalloc and zfree. This can be useful for custom
Chris@6 140 memory management. The compression library attaches no meaning to the
Chris@6 141 opaque value.
Chris@6 142
Chris@6 143 zalloc must return Z_NULL if there is not enough memory for the object.
Chris@6 144 If zlib is used in a multi-threaded application, zalloc and zfree must be
Chris@6 145 thread safe.
Chris@6 146
Chris@6 147 On 16-bit systems, the functions zalloc and zfree must be able to allocate
Chris@6 148 exactly 65536 bytes, but will not be required to allocate more than this if
Chris@6 149 the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS, pointers
Chris@6 150 returned by zalloc for objects of exactly 65536 bytes *must* have their
Chris@6 151 offset normalized to zero. The default allocation function provided by this
Chris@6 152 library ensures this (see zutil.c). To reduce memory requirements and avoid
Chris@6 153 any allocation of 64K objects, at the expense of compression ratio, compile
Chris@6 154 the library with -DMAX_WBITS=14 (see zconf.h).
Chris@6 155
Chris@6 156 The fields total_in and total_out can be used for statistics or progress
Chris@6 157 reports. After compression, total_in holds the total size of the
Chris@6 158 uncompressed data and may be saved for use in the decompressor (particularly
Chris@6 159 if the decompressor wants to decompress everything in a single step).
Chris@6 160 */
Chris@6 161
Chris@6 162 /* constants */
Chris@6 163
Chris@6 164 #define Z_NO_FLUSH 0
Chris@6 165 #define Z_PARTIAL_FLUSH 1
Chris@6 166 #define Z_SYNC_FLUSH 2
Chris@6 167 #define Z_FULL_FLUSH 3
Chris@6 168 #define Z_FINISH 4
Chris@6 169 #define Z_BLOCK 5
Chris@6 170 #define Z_TREES 6
Chris@6 171 /* Allowed flush values; see deflate() and inflate() below for details */
Chris@6 172
Chris@6 173 #define Z_OK 0
Chris@6 174 #define Z_STREAM_END 1
Chris@6 175 #define Z_NEED_DICT 2
Chris@6 176 #define Z_ERRNO (-1)
Chris@6 177 #define Z_STREAM_ERROR (-2)
Chris@6 178 #define Z_DATA_ERROR (-3)
Chris@6 179 #define Z_MEM_ERROR (-4)
Chris@6 180 #define Z_BUF_ERROR (-5)
Chris@6 181 #define Z_VERSION_ERROR (-6)
Chris@6 182 /* Return codes for the compression/decompression functions. Negative values
Chris@6 183 * are errors, positive values are used for special but normal events.
Chris@6 184 */
Chris@6 185
Chris@6 186 #define Z_NO_COMPRESSION 0
Chris@6 187 #define Z_BEST_SPEED 1
Chris@6 188 #define Z_BEST_COMPRESSION 9
Chris@6 189 #define Z_DEFAULT_COMPRESSION (-1)
Chris@6 190 /* compression levels */
Chris@6 191
Chris@6 192 #define Z_FILTERED 1
Chris@6 193 #define Z_HUFFMAN_ONLY 2
Chris@6 194 #define Z_RLE 3
Chris@6 195 #define Z_FIXED 4
Chris@6 196 #define Z_DEFAULT_STRATEGY 0
Chris@6 197 /* compression strategy; see deflateInit2() below for details */
Chris@6 198
Chris@6 199 #define Z_BINARY 0
Chris@6 200 #define Z_TEXT 1
Chris@6 201 #define Z_ASCII Z_TEXT /* for compatibility with 1.2.2 and earlier */
Chris@6 202 #define Z_UNKNOWN 2
Chris@6 203 /* Possible values of the data_type field (though see inflate()) */
Chris@6 204
Chris@6 205 #define Z_DEFLATED 8
Chris@6 206 /* The deflate compression method (the only one supported in this version) */
Chris@6 207
Chris@6 208 #define Z_NULL 0 /* for initializing zalloc, zfree, opaque */
Chris@6 209
Chris@6 210 #define zlib_version zlibVersion()
Chris@6 211 /* for compatibility with versions < 1.0.2 */
Chris@6 212
Chris@6 213
Chris@6 214 /* basic functions */
Chris@6 215
Chris@6 216 ZEXTERN const char * ZEXPORT zlibVersion OF((void));
Chris@6 217 /* The application can compare zlibVersion and ZLIB_VERSION for consistency.
Chris@6 218 If the first character differs, the library code actually used is not
Chris@6 219 compatible with the zlib.h header file used by the application. This check
Chris@6 220 is automatically made by deflateInit and inflateInit.
Chris@6 221 */
Chris@6 222
Chris@6 223 /*
Chris@6 224 ZEXTERN int ZEXPORT deflateInit OF((z_streamp strm, int level));
Chris@6 225
Chris@6 226 Initializes the internal stream state for compression. The fields
Chris@6 227 zalloc, zfree and opaque must be initialized before by the caller. If
Chris@6 228 zalloc and zfree are set to Z_NULL, deflateInit updates them to use default
Chris@6 229 allocation functions.
Chris@6 230
Chris@6 231 The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9:
Chris@6 232 1 gives best speed, 9 gives best compression, 0 gives no compression at all
Chris@6 233 (the input data is simply copied a block at a time). Z_DEFAULT_COMPRESSION
Chris@6 234 requests a default compromise between speed and compression (currently
Chris@6 235 equivalent to level 6).
Chris@6 236
Chris@6 237 deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough
Chris@6 238 memory, Z_STREAM_ERROR if level is not a valid compression level, or
Chris@6 239 Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible
Chris@6 240 with the version assumed by the caller (ZLIB_VERSION). msg is set to null
Chris@6 241 if there is no error message. deflateInit does not perform any compression:
Chris@6 242 this will be done by deflate().
Chris@6 243 */
Chris@6 244
Chris@6 245
Chris@6 246 ZEXTERN int ZEXPORT deflate OF((z_streamp strm, int flush));
Chris@6 247 /*
Chris@6 248 deflate compresses as much data as possible, and stops when the input
Chris@6 249 buffer becomes empty or the output buffer becomes full. It may introduce
Chris@6 250 some output latency (reading input without producing any output) except when
Chris@6 251 forced to flush.
Chris@6 252
Chris@6 253 The detailed semantics are as follows. deflate performs one or both of the
Chris@6 254 following actions:
Chris@6 255
Chris@6 256 - Compress more input starting at next_in and update next_in and avail_in
Chris@6 257 accordingly. If not all input can be processed (because there is not
Chris@6 258 enough room in the output buffer), next_in and avail_in are updated and
Chris@6 259 processing will resume at this point for the next call of deflate().
Chris@6 260
Chris@6 261 - Provide more output starting at next_out and update next_out and avail_out
Chris@6 262 accordingly. This action is forced if the parameter flush is non zero.
Chris@6 263 Forcing flush frequently degrades the compression ratio, so this parameter
Chris@6 264 should be set only when necessary (in interactive applications). Some
Chris@6 265 output may be provided even if flush is not set.
Chris@6 266
Chris@6 267 Before the call of deflate(), the application should ensure that at least
Chris@6 268 one of the actions is possible, by providing more input and/or consuming more
Chris@6 269 output, and updating avail_in or avail_out accordingly; avail_out should
Chris@6 270 never be zero before the call. The application can consume the compressed
Chris@6 271 output when it wants, for example when the output buffer is full (avail_out
Chris@6 272 == 0), or after each call of deflate(). If deflate returns Z_OK and with
Chris@6 273 zero avail_out, it must be called again after making room in the output
Chris@6 274 buffer because there might be more output pending.
Chris@6 275
Chris@6 276 Normally the parameter flush is set to Z_NO_FLUSH, which allows deflate to
Chris@6 277 decide how much data to accumulate before producing output, in order to
Chris@6 278 maximize compression.
Chris@6 279
Chris@6 280 If the parameter flush is set to Z_SYNC_FLUSH, all pending output is
Chris@6 281 flushed to the output buffer and the output is aligned on a byte boundary, so
Chris@6 282 that the decompressor can get all input data available so far. (In
Chris@6 283 particular avail_in is zero after the call if enough output space has been
Chris@6 284 provided before the call.) Flushing may degrade compression for some
Chris@6 285 compression algorithms and so it should be used only when necessary. This
Chris@6 286 completes the current deflate block and follows it with an empty stored block
Chris@6 287 that is three bits plus filler bits to the next byte, followed by four bytes
Chris@6 288 (00 00 ff ff).
Chris@6 289
Chris@6 290 If flush is set to Z_PARTIAL_FLUSH, all pending output is flushed to the
Chris@6 291 output buffer, but the output is not aligned to a byte boundary. All of the
Chris@6 292 input data so far will be available to the decompressor, as for Z_SYNC_FLUSH.
Chris@6 293 This completes the current deflate block and follows it with an empty fixed
Chris@6 294 codes block that is 10 bits long. This assures that enough bytes are output
Chris@6 295 in order for the decompressor to finish the block before the empty fixed code
Chris@6 296 block.
Chris@6 297
Chris@6 298 If flush is set to Z_BLOCK, a deflate block is completed and emitted, as
Chris@6 299 for Z_SYNC_FLUSH, but the output is not aligned on a byte boundary, and up to
Chris@6 300 seven bits of the current block are held to be written as the next byte after
Chris@6 301 the next deflate block is completed. In this case, the decompressor may not
Chris@6 302 be provided enough bits at this point in order to complete decompression of
Chris@6 303 the data provided so far to the compressor. It may need to wait for the next
Chris@6 304 block to be emitted. This is for advanced applications that need to control
Chris@6 305 the emission of deflate blocks.
Chris@6 306
Chris@6 307 If flush is set to Z_FULL_FLUSH, all output is flushed as with
Chris@6 308 Z_SYNC_FLUSH, and the compression state is reset so that decompression can
Chris@6 309 restart from this point if previous compressed data has been damaged or if
Chris@6 310 random access is desired. Using Z_FULL_FLUSH too often can seriously degrade
Chris@6 311 compression.
Chris@6 312
Chris@6 313 If deflate returns with avail_out == 0, this function must be called again
Chris@6 314 with the same value of the flush parameter and more output space (updated
Chris@6 315 avail_out), until the flush is complete (deflate returns with non-zero
Chris@6 316 avail_out). In the case of a Z_FULL_FLUSH or Z_SYNC_FLUSH, make sure that
Chris@6 317 avail_out is greater than six to avoid repeated flush markers due to
Chris@6 318 avail_out == 0 on return.
Chris@6 319
Chris@6 320 If the parameter flush is set to Z_FINISH, pending input is processed,
Chris@6 321 pending output is flushed and deflate returns with Z_STREAM_END if there was
Chris@6 322 enough output space; if deflate returns with Z_OK, this function must be
Chris@6 323 called again with Z_FINISH and more output space (updated avail_out) but no
Chris@6 324 more input data, until it returns with Z_STREAM_END or an error. After
Chris@6 325 deflate has returned Z_STREAM_END, the only possible operations on the stream
Chris@6 326 are deflateReset or deflateEnd.
Chris@6 327
Chris@6 328 Z_FINISH can be used immediately after deflateInit if all the compression
Chris@6 329 is to be done in a single step. In this case, avail_out must be at least the
Chris@6 330 value returned by deflateBound (see below). Then deflate is guaranteed to
Chris@6 331 return Z_STREAM_END. If not enough output space is provided, deflate will
Chris@6 332 not return Z_STREAM_END, and it must be called again as described above.
Chris@6 333
Chris@6 334 deflate() sets strm->adler to the adler32 checksum of all input read
Chris@6 335 so far (that is, total_in bytes).
Chris@6 336
Chris@6 337 deflate() may update strm->data_type if it can make a good guess about
Chris@6 338 the input data type (Z_BINARY or Z_TEXT). In doubt, the data is considered
Chris@6 339 binary. This field is only for information purposes and does not affect the
Chris@6 340 compression algorithm in any manner.
Chris@6 341
Chris@6 342 deflate() returns Z_OK if some progress has been made (more input
Chris@6 343 processed or more output produced), Z_STREAM_END if all input has been
Chris@6 344 consumed and all output has been produced (only when flush is set to
Chris@6 345 Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example
Chris@6 346 if next_in or next_out was Z_NULL), Z_BUF_ERROR if no progress is possible
Chris@6 347 (for example avail_in or avail_out was zero). Note that Z_BUF_ERROR is not
Chris@6 348 fatal, and deflate() can be called again with more input and more output
Chris@6 349 space to continue compressing.
Chris@6 350 */
Chris@6 351
Chris@6 352
Chris@6 353 ZEXTERN int ZEXPORT deflateEnd OF((z_streamp strm));
Chris@6 354 /*
Chris@6 355 All dynamically allocated data structures for this stream are freed.
Chris@6 356 This function discards any unprocessed input and does not flush any pending
Chris@6 357 output.
Chris@6 358
Chris@6 359 deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the
Chris@6 360 stream state was inconsistent, Z_DATA_ERROR if the stream was freed
Chris@6 361 prematurely (some input or output was discarded). In the error case, msg
Chris@6 362 may be set but then points to a static string (which must not be
Chris@6 363 deallocated).
Chris@6 364 */
Chris@6 365
Chris@6 366
Chris@6 367 /*
Chris@6 368 ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm));
Chris@6 369
Chris@6 370 Initializes the internal stream state for decompression. The fields
Chris@6 371 next_in, avail_in, zalloc, zfree and opaque must be initialized before by
Chris@6 372 the caller. If next_in is not Z_NULL and avail_in is large enough (the
Chris@6 373 exact value depends on the compression method), inflateInit determines the
Chris@6 374 compression method from the zlib header and allocates all data structures
Chris@6 375 accordingly; otherwise the allocation will be deferred to the first call of
Chris@6 376 inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them to
Chris@6 377 use default allocation functions.
Chris@6 378
Chris@6 379 inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough
Chris@6 380 memory, Z_VERSION_ERROR if the zlib library version is incompatible with the
Chris@6 381 version assumed by the caller, or Z_STREAM_ERROR if the parameters are
Chris@6 382 invalid, such as a null pointer to the structure. msg is set to null if
Chris@6 383 there is no error message. inflateInit does not perform any decompression
Chris@6 384 apart from possibly reading the zlib header if present: actual decompression
Chris@6 385 will be done by inflate(). (So next_in and avail_in may be modified, but
Chris@6 386 next_out and avail_out are unused and unchanged.) The current implementation
Chris@6 387 of inflateInit() does not process any header information -- that is deferred
Chris@6 388 until inflate() is called.
Chris@6 389 */
Chris@6 390
Chris@6 391
Chris@6 392 ZEXTERN int ZEXPORT inflate OF((z_streamp strm, int flush));
Chris@6 393 /*
Chris@6 394 inflate decompresses as much data as possible, and stops when the input
Chris@6 395 buffer becomes empty or the output buffer becomes full. It may introduce
Chris@6 396 some output latency (reading input without producing any output) except when
Chris@6 397 forced to flush.
Chris@6 398
Chris@6 399 The detailed semantics are as follows. inflate performs one or both of the
Chris@6 400 following actions:
Chris@6 401
Chris@6 402 - Decompress more input starting at next_in and update next_in and avail_in
Chris@6 403 accordingly. If not all input can be processed (because there is not
Chris@6 404 enough room in the output buffer), next_in is updated and processing will
Chris@6 405 resume at this point for the next call of inflate().
Chris@6 406
Chris@6 407 - Provide more output starting at next_out and update next_out and avail_out
Chris@6 408 accordingly. inflate() provides as much output as possible, until there is
Chris@6 409 no more input data or no more space in the output buffer (see below about
Chris@6 410 the flush parameter).
Chris@6 411
Chris@6 412 Before the call of inflate(), the application should ensure that at least
Chris@6 413 one of the actions is possible, by providing more input and/or consuming more
Chris@6 414 output, and updating the next_* and avail_* values accordingly. The
Chris@6 415 application can consume the uncompressed output when it wants, for example
Chris@6 416 when the output buffer is full (avail_out == 0), or after each call of
Chris@6 417 inflate(). If inflate returns Z_OK and with zero avail_out, it must be
Chris@6 418 called again after making room in the output buffer because there might be
Chris@6 419 more output pending.
Chris@6 420
Chris@6 421 The flush parameter of inflate() can be Z_NO_FLUSH, Z_SYNC_FLUSH, Z_FINISH,
Chris@6 422 Z_BLOCK, or Z_TREES. Z_SYNC_FLUSH requests that inflate() flush as much
Chris@6 423 output as possible to the output buffer. Z_BLOCK requests that inflate()
Chris@6 424 stop if and when it gets to the next deflate block boundary. When decoding
Chris@6 425 the zlib or gzip format, this will cause inflate() to return immediately
Chris@6 426 after the header and before the first block. When doing a raw inflate,
Chris@6 427 inflate() will go ahead and process the first block, and will return when it
Chris@6 428 gets to the end of that block, or when it runs out of data.
Chris@6 429
Chris@6 430 The Z_BLOCK option assists in appending to or combining deflate streams.
Chris@6 431 Also to assist in this, on return inflate() will set strm->data_type to the
Chris@6 432 number of unused bits in the last byte taken from strm->next_in, plus 64 if
Chris@6 433 inflate() is currently decoding the last block in the deflate stream, plus
Chris@6 434 128 if inflate() returned immediately after decoding an end-of-block code or
Chris@6 435 decoding the complete header up to just before the first byte of the deflate
Chris@6 436 stream. The end-of-block will not be indicated until all of the uncompressed
Chris@6 437 data from that block has been written to strm->next_out. The number of
Chris@6 438 unused bits may in general be greater than seven, except when bit 7 of
Chris@6 439 data_type is set, in which case the number of unused bits will be less than
Chris@6 440 eight. data_type is set as noted here every time inflate() returns for all
Chris@6 441 flush options, and so can be used to determine the amount of currently
Chris@6 442 consumed input in bits.
Chris@6 443
Chris@6 444 The Z_TREES option behaves as Z_BLOCK does, but it also returns when the
Chris@6 445 end of each deflate block header is reached, before any actual data in that
Chris@6 446 block is decoded. This allows the caller to determine the length of the
Chris@6 447 deflate block header for later use in random access within a deflate block.
Chris@6 448 256 is added to the value of strm->data_type when inflate() returns
Chris@6 449 immediately after reaching the end of the deflate block header.
Chris@6 450
Chris@6 451 inflate() should normally be called until it returns Z_STREAM_END or an
Chris@6 452 error. However if all decompression is to be performed in a single step (a
Chris@6 453 single call of inflate), the parameter flush should be set to Z_FINISH. In
Chris@6 454 this case all pending input is processed and all pending output is flushed;
Chris@6 455 avail_out must be large enough to hold all of the uncompressed data for the
Chris@6 456 operation to complete. (The size of the uncompressed data may have been
Chris@6 457 saved by the compressor for this purpose.) The use of Z_FINISH is not
Chris@6 458 required to perform an inflation in one step. However it may be used to
Chris@6 459 inform inflate that a faster approach can be used for the single inflate()
Chris@6 460 call. Z_FINISH also informs inflate to not maintain a sliding window if the
Chris@6 461 stream completes, which reduces inflate's memory footprint. If the stream
Chris@6 462 does not complete, either because not all of the stream is provided or not
Chris@6 463 enough output space is provided, then a sliding window will be allocated and
Chris@6 464 inflate() can be called again to continue the operation as if Z_NO_FLUSH had
Chris@6 465 been used.
Chris@6 466
Chris@6 467 In this implementation, inflate() always flushes as much output as
Chris@6 468 possible to the output buffer, and always uses the faster approach on the
Chris@6 469 first call. So the effects of the flush parameter in this implementation are
Chris@6 470 on the return value of inflate() as noted below, when inflate() returns early
Chris@6 471 when Z_BLOCK or Z_TREES is used, and when inflate() avoids the allocation of
Chris@6 472 memory for a sliding window when Z_FINISH is used.
Chris@6 473
Chris@6 474 If a preset dictionary is needed after this call (see inflateSetDictionary
Chris@6 475 below), inflate sets strm->adler to the Adler-32 checksum of the dictionary
Chris@6 476 chosen by the compressor and returns Z_NEED_DICT; otherwise it sets
Chris@6 477 strm->adler to the Adler-32 checksum of all output produced so far (that is,
Chris@6 478 total_out bytes) and returns Z_OK, Z_STREAM_END or an error code as described
Chris@6 479 below. At the end of the stream, inflate() checks that its computed adler32
Chris@6 480 checksum is equal to that saved by the compressor and returns Z_STREAM_END
Chris@6 481 only if the checksum is correct.
Chris@6 482
Chris@6 483 inflate() can decompress and check either zlib-wrapped or gzip-wrapped
Chris@6 484 deflate data. The header type is detected automatically, if requested when
Chris@6 485 initializing with inflateInit2(). Any information contained in the gzip
Chris@6 486 header is not retained, so applications that need that information should
Chris@6 487 instead use raw inflate, see inflateInit2() below, or inflateBack() and
Chris@6 488 perform their own processing of the gzip header and trailer. When processing
Chris@6 489 gzip-wrapped deflate data, strm->adler32 is set to the CRC-32 of the output
Chris@6 490 producted so far. The CRC-32 is checked against the gzip trailer.
Chris@6 491
Chris@6 492 inflate() returns Z_OK if some progress has been made (more input processed
Chris@6 493 or more output produced), Z_STREAM_END if the end of the compressed data has
Chris@6 494 been reached and all uncompressed output has been produced, Z_NEED_DICT if a
Chris@6 495 preset dictionary is needed at this point, Z_DATA_ERROR if the input data was
Chris@6 496 corrupted (input stream not conforming to the zlib format or incorrect check
Chris@6 497 value), Z_STREAM_ERROR if the stream structure was inconsistent (for example
Chris@6 498 next_in or next_out was Z_NULL), Z_MEM_ERROR if there was not enough memory,
Chris@6 499 Z_BUF_ERROR if no progress is possible or if there was not enough room in the
Chris@6 500 output buffer when Z_FINISH is used. Note that Z_BUF_ERROR is not fatal, and
Chris@6 501 inflate() can be called again with more input and more output space to
Chris@6 502 continue decompressing. If Z_DATA_ERROR is returned, the application may
Chris@6 503 then call inflateSync() to look for a good compression block if a partial
Chris@6 504 recovery of the data is desired.
Chris@6 505 */
Chris@6 506
Chris@6 507
Chris@6 508 ZEXTERN int ZEXPORT inflateEnd OF((z_streamp strm));
Chris@6 509 /*
Chris@6 510 All dynamically allocated data structures for this stream are freed.
Chris@6 511 This function discards any unprocessed input and does not flush any pending
Chris@6 512 output.
Chris@6 513
Chris@6 514 inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state
Chris@6 515 was inconsistent. In the error case, msg may be set but then points to a
Chris@6 516 static string (which must not be deallocated).
Chris@6 517 */
Chris@6 518
Chris@6 519
Chris@6 520 /* Advanced functions */
Chris@6 521
Chris@6 522 /*
Chris@6 523 The following functions are needed only in some special applications.
Chris@6 524 */
Chris@6 525
Chris@6 526 /*
Chris@6 527 ZEXTERN int ZEXPORT deflateInit2 OF((z_streamp strm,
Chris@6 528 int level,
Chris@6 529 int method,
Chris@6 530 int windowBits,
Chris@6 531 int memLevel,
Chris@6 532 int strategy));
Chris@6 533
Chris@6 534 This is another version of deflateInit with more compression options. The
Chris@6 535 fields next_in, zalloc, zfree and opaque must be initialized before by the
Chris@6 536 caller.
Chris@6 537
Chris@6 538 The method parameter is the compression method. It must be Z_DEFLATED in
Chris@6 539 this version of the library.
Chris@6 540
Chris@6 541 The windowBits parameter is the base two logarithm of the window size
Chris@6 542 (the size of the history buffer). It should be in the range 8..15 for this
Chris@6 543 version of the library. Larger values of this parameter result in better
Chris@6 544 compression at the expense of memory usage. The default value is 15 if
Chris@6 545 deflateInit is used instead.
Chris@6 546
Chris@6 547 windowBits can also be -8..-15 for raw deflate. In this case, -windowBits
Chris@6 548 determines the window size. deflate() will then generate raw deflate data
Chris@6 549 with no zlib header or trailer, and will not compute an adler32 check value.
Chris@6 550
Chris@6 551 windowBits can also be greater than 15 for optional gzip encoding. Add
Chris@6 552 16 to windowBits to write a simple gzip header and trailer around the
Chris@6 553 compressed data instead of a zlib wrapper. The gzip header will have no
Chris@6 554 file name, no extra data, no comment, no modification time (set to zero), no
Chris@6 555 header crc, and the operating system will be set to 255 (unknown). If a
Chris@6 556 gzip stream is being written, strm->adler is a crc32 instead of an adler32.
Chris@6 557
Chris@6 558 The memLevel parameter specifies how much memory should be allocated
Chris@6 559 for the internal compression state. memLevel=1 uses minimum memory but is
Chris@6 560 slow and reduces compression ratio; memLevel=9 uses maximum memory for
Chris@6 561 optimal speed. The default value is 8. See zconf.h for total memory usage
Chris@6 562 as a function of windowBits and memLevel.
Chris@6 563
Chris@6 564 The strategy parameter is used to tune the compression algorithm. Use the
Chris@6 565 value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a
Chris@6 566 filter (or predictor), Z_HUFFMAN_ONLY to force Huffman encoding only (no
Chris@6 567 string match), or Z_RLE to limit match distances to one (run-length
Chris@6 568 encoding). Filtered data consists mostly of small values with a somewhat
Chris@6 569 random distribution. In this case, the compression algorithm is tuned to
Chris@6 570 compress them better. The effect of Z_FILTERED is to force more Huffman
Chris@6 571 coding and less string matching; it is somewhat intermediate between
Chris@6 572 Z_DEFAULT_STRATEGY and Z_HUFFMAN_ONLY. Z_RLE is designed to be almost as
Chris@6 573 fast as Z_HUFFMAN_ONLY, but give better compression for PNG image data. The
Chris@6 574 strategy parameter only affects the compression ratio but not the
Chris@6 575 correctness of the compressed output even if it is not set appropriately.
Chris@6 576 Z_FIXED prevents the use of dynamic Huffman codes, allowing for a simpler
Chris@6 577 decoder for special applications.
Chris@6 578
Chris@6 579 deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
Chris@6 580 memory, Z_STREAM_ERROR if any parameter is invalid (such as an invalid
Chris@6 581 method), or Z_VERSION_ERROR if the zlib library version (zlib_version) is
Chris@6 582 incompatible with the version assumed by the caller (ZLIB_VERSION). msg is
Chris@6 583 set to null if there is no error message. deflateInit2 does not perform any
Chris@6 584 compression: this will be done by deflate().
Chris@6 585 */
Chris@6 586
Chris@6 587 ZEXTERN int ZEXPORT deflateSetDictionary OF((z_streamp strm,
Chris@6 588 const Bytef *dictionary,
Chris@6 589 uInt dictLength));
Chris@6 590 /*
Chris@6 591 Initializes the compression dictionary from the given byte sequence
Chris@6 592 without producing any compressed output. When using the zlib format, this
Chris@6 593 function must be called immediately after deflateInit, deflateInit2 or
Chris@6 594 deflateReset, and before any call of deflate. When doing raw deflate, this
Chris@6 595 function must be called either before any call of deflate, or immediately
Chris@6 596 after the completion of a deflate block, i.e. after all input has been
Chris@6 597 consumed and all output has been delivered when using any of the flush
Chris@6 598 options Z_BLOCK, Z_PARTIAL_FLUSH, Z_SYNC_FLUSH, or Z_FULL_FLUSH. The
Chris@6 599 compressor and decompressor must use exactly the same dictionary (see
Chris@6 600 inflateSetDictionary).
Chris@6 601
Chris@6 602 The dictionary should consist of strings (byte sequences) that are likely
Chris@6 603 to be encountered later in the data to be compressed, with the most commonly
Chris@6 604 used strings preferably put towards the end of the dictionary. Using a
Chris@6 605 dictionary is most useful when the data to be compressed is short and can be
Chris@6 606 predicted with good accuracy; the data can then be compressed better than
Chris@6 607 with the default empty dictionary.
Chris@6 608
Chris@6 609 Depending on the size of the compression data structures selected by
Chris@6 610 deflateInit or deflateInit2, a part of the dictionary may in effect be
Chris@6 611 discarded, for example if the dictionary is larger than the window size
Chris@6 612 provided in deflateInit or deflateInit2. Thus the strings most likely to be
Chris@6 613 useful should be put at the end of the dictionary, not at the front. In
Chris@6 614 addition, the current implementation of deflate will use at most the window
Chris@6 615 size minus 262 bytes of the provided dictionary.
Chris@6 616
Chris@6 617 Upon return of this function, strm->adler is set to the adler32 value
Chris@6 618 of the dictionary; the decompressor may later use this value to determine
Chris@6 619 which dictionary has been used by the compressor. (The adler32 value
Chris@6 620 applies to the whole dictionary even if only a subset of the dictionary is
Chris@6 621 actually used by the compressor.) If a raw deflate was requested, then the
Chris@6 622 adler32 value is not computed and strm->adler is not set.
Chris@6 623
Chris@6 624 deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a
Chris@6 625 parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is
Chris@6 626 inconsistent (for example if deflate has already been called for this stream
Chris@6 627 or if not at a block boundary for raw deflate). deflateSetDictionary does
Chris@6 628 not perform any compression: this will be done by deflate().
Chris@6 629 */
Chris@6 630
Chris@6 631 ZEXTERN int ZEXPORT deflateCopy OF((z_streamp dest,
Chris@6 632 z_streamp source));
Chris@6 633 /*
Chris@6 634 Sets the destination stream as a complete copy of the source stream.
Chris@6 635
Chris@6 636 This function can be useful when several compression strategies will be
Chris@6 637 tried, for example when there are several ways of pre-processing the input
Chris@6 638 data with a filter. The streams that will be discarded should then be freed
Chris@6 639 by calling deflateEnd. Note that deflateCopy duplicates the internal
Chris@6 640 compression state which can be quite large, so this strategy is slow and can
Chris@6 641 consume lots of memory.
Chris@6 642
Chris@6 643 deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not
Chris@6 644 enough memory, Z_STREAM_ERROR if the source stream state was inconsistent
Chris@6 645 (such as zalloc being Z_NULL). msg is left unchanged in both source and
Chris@6 646 destination.
Chris@6 647 */
Chris@6 648
Chris@6 649 ZEXTERN int ZEXPORT deflateReset OF((z_streamp strm));
Chris@6 650 /*
Chris@6 651 This function is equivalent to deflateEnd followed by deflateInit,
Chris@6 652 but does not free and reallocate all the internal compression state. The
Chris@6 653 stream will keep the same compression level and any other attributes that
Chris@6 654 may have been set by deflateInit2.
Chris@6 655
Chris@6 656 deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
Chris@6 657 stream state was inconsistent (such as zalloc or state being Z_NULL).
Chris@6 658 */
Chris@6 659
Chris@6 660 ZEXTERN int ZEXPORT deflateParams OF((z_streamp strm,
Chris@6 661 int level,
Chris@6 662 int strategy));
Chris@6 663 /*
Chris@6 664 Dynamically update the compression level and compression strategy. The
Chris@6 665 interpretation of level and strategy is as in deflateInit2. This can be
Chris@6 666 used to switch between compression and straight copy of the input data, or
Chris@6 667 to switch to a different kind of input data requiring a different strategy.
Chris@6 668 If the compression level is changed, the input available so far is
Chris@6 669 compressed with the old level (and may be flushed); the new level will take
Chris@6 670 effect only at the next call of deflate().
Chris@6 671
Chris@6 672 Before the call of deflateParams, the stream state must be set as for
Chris@6 673 a call of deflate(), since the currently available input may have to be
Chris@6 674 compressed and flushed. In particular, strm->avail_out must be non-zero.
Chris@6 675
Chris@6 676 deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source
Chris@6 677 stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR if
Chris@6 678 strm->avail_out was zero.
Chris@6 679 */
Chris@6 680
Chris@6 681 ZEXTERN int ZEXPORT deflateTune OF((z_streamp strm,
Chris@6 682 int good_length,
Chris@6 683 int max_lazy,
Chris@6 684 int nice_length,
Chris@6 685 int max_chain));
Chris@6 686 /*
Chris@6 687 Fine tune deflate's internal compression parameters. This should only be
Chris@6 688 used by someone who understands the algorithm used by zlib's deflate for
Chris@6 689 searching for the best matching string, and even then only by the most
Chris@6 690 fanatic optimizer trying to squeeze out the last compressed bit for their
Chris@6 691 specific input data. Read the deflate.c source code for the meaning of the
Chris@6 692 max_lazy, good_length, nice_length, and max_chain parameters.
Chris@6 693
Chris@6 694 deflateTune() can be called after deflateInit() or deflateInit2(), and
Chris@6 695 returns Z_OK on success, or Z_STREAM_ERROR for an invalid deflate stream.
Chris@6 696 */
Chris@6 697
Chris@6 698 ZEXTERN uLong ZEXPORT deflateBound OF((z_streamp strm,
Chris@6 699 uLong sourceLen));
Chris@6 700 /*
Chris@6 701 deflateBound() returns an upper bound on the compressed size after
Chris@6 702 deflation of sourceLen bytes. It must be called after deflateInit() or
Chris@6 703 deflateInit2(), and after deflateSetHeader(), if used. This would be used
Chris@6 704 to allocate an output buffer for deflation in a single pass, and so would be
Chris@6 705 called before deflate(). If that first deflate() call is provided the
Chris@6 706 sourceLen input bytes, an output buffer allocated to the size returned by
Chris@6 707 deflateBound(), and the flush value Z_FINISH, then deflate() is guaranteed
Chris@6 708 to return Z_STREAM_END. Note that it is possible for the compressed size to
Chris@6 709 be larger than the value returned by deflateBound() if flush options other
Chris@6 710 than Z_FINISH or Z_NO_FLUSH are used.
Chris@6 711 */
Chris@6 712
Chris@6 713 ZEXTERN int ZEXPORT deflatePending OF((z_streamp strm,
Chris@6 714 unsigned *pending,
Chris@6 715 int *bits));
Chris@6 716 /*
Chris@6 717 deflatePending() returns the number of bytes and bits of output that have
Chris@6 718 been generated, but not yet provided in the available output. The bytes not
Chris@6 719 provided would be due to the available output space having being consumed.
Chris@6 720 The number of bits of output not provided are between 0 and 7, where they
Chris@6 721 await more bits to join them in order to fill out a full byte. If pending
Chris@6 722 or bits are Z_NULL, then those values are not set.
Chris@6 723
Chris@6 724 deflatePending returns Z_OK if success, or Z_STREAM_ERROR if the source
Chris@6 725 stream state was inconsistent.
Chris@6 726 */
Chris@6 727
Chris@6 728 ZEXTERN int ZEXPORT deflatePrime OF((z_streamp strm,
Chris@6 729 int bits,
Chris@6 730 int value));
Chris@6 731 /*
Chris@6 732 deflatePrime() inserts bits in the deflate output stream. The intent
Chris@6 733 is that this function is used to start off the deflate output with the bits
Chris@6 734 leftover from a previous deflate stream when appending to it. As such, this
Chris@6 735 function can only be used for raw deflate, and must be used before the first
Chris@6 736 deflate() call after a deflateInit2() or deflateReset(). bits must be less
Chris@6 737 than or equal to 16, and that many of the least significant bits of value
Chris@6 738 will be inserted in the output.
Chris@6 739
Chris@6 740 deflatePrime returns Z_OK if success, Z_BUF_ERROR if there was not enough
Chris@6 741 room in the internal buffer to insert the bits, or Z_STREAM_ERROR if the
Chris@6 742 source stream state was inconsistent.
Chris@6 743 */
Chris@6 744
Chris@6 745 ZEXTERN int ZEXPORT deflateSetHeader OF((z_streamp strm,
Chris@6 746 gz_headerp head));
Chris@6 747 /*
Chris@6 748 deflateSetHeader() provides gzip header information for when a gzip
Chris@6 749 stream is requested by deflateInit2(). deflateSetHeader() may be called
Chris@6 750 after deflateInit2() or deflateReset() and before the first call of
Chris@6 751 deflate(). The text, time, os, extra field, name, and comment information
Chris@6 752 in the provided gz_header structure are written to the gzip header (xflag is
Chris@6 753 ignored -- the extra flags are set according to the compression level). The
Chris@6 754 caller must assure that, if not Z_NULL, name and comment are terminated with
Chris@6 755 a zero byte, and that if extra is not Z_NULL, that extra_len bytes are
Chris@6 756 available there. If hcrc is true, a gzip header crc is included. Note that
Chris@6 757 the current versions of the command-line version of gzip (up through version
Chris@6 758 1.3.x) do not support header crc's, and will report that it is a "multi-part
Chris@6 759 gzip file" and give up.
Chris@6 760
Chris@6 761 If deflateSetHeader is not used, the default gzip header has text false,
Chris@6 762 the time set to zero, and os set to 255, with no extra, name, or comment
Chris@6 763 fields. The gzip header is returned to the default state by deflateReset().
Chris@6 764
Chris@6 765 deflateSetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source
Chris@6 766 stream state was inconsistent.
Chris@6 767 */
Chris@6 768
Chris@6 769 /*
Chris@6 770 ZEXTERN int ZEXPORT inflateInit2 OF((z_streamp strm,
Chris@6 771 int windowBits));
Chris@6 772
Chris@6 773 This is another version of inflateInit with an extra parameter. The
Chris@6 774 fields next_in, avail_in, zalloc, zfree and opaque must be initialized
Chris@6 775 before by the caller.
Chris@6 776
Chris@6 777 The windowBits parameter is the base two logarithm of the maximum window
Chris@6 778 size (the size of the history buffer). It should be in the range 8..15 for
Chris@6 779 this version of the library. The default value is 15 if inflateInit is used
Chris@6 780 instead. windowBits must be greater than or equal to the windowBits value
Chris@6 781 provided to deflateInit2() while compressing, or it must be equal to 15 if
Chris@6 782 deflateInit2() was not used. If a compressed stream with a larger window
Chris@6 783 size is given as input, inflate() will return with the error code
Chris@6 784 Z_DATA_ERROR instead of trying to allocate a larger window.
Chris@6 785
Chris@6 786 windowBits can also be zero to request that inflate use the window size in
Chris@6 787 the zlib header of the compressed stream.
Chris@6 788
Chris@6 789 windowBits can also be -8..-15 for raw inflate. In this case, -windowBits
Chris@6 790 determines the window size. inflate() will then process raw deflate data,
Chris@6 791 not looking for a zlib or gzip header, not generating a check value, and not
Chris@6 792 looking for any check values for comparison at the end of the stream. This
Chris@6 793 is for use with other formats that use the deflate compressed data format
Chris@6 794 such as zip. Those formats provide their own check values. If a custom
Chris@6 795 format is developed using the raw deflate format for compressed data, it is
Chris@6 796 recommended that a check value such as an adler32 or a crc32 be applied to
Chris@6 797 the uncompressed data as is done in the zlib, gzip, and zip formats. For
Chris@6 798 most applications, the zlib format should be used as is. Note that comments
Chris@6 799 above on the use in deflateInit2() applies to the magnitude of windowBits.
Chris@6 800
Chris@6 801 windowBits can also be greater than 15 for optional gzip decoding. Add
Chris@6 802 32 to windowBits to enable zlib and gzip decoding with automatic header
Chris@6 803 detection, or add 16 to decode only the gzip format (the zlib format will
Chris@6 804 return a Z_DATA_ERROR). If a gzip stream is being decoded, strm->adler is a
Chris@6 805 crc32 instead of an adler32.
Chris@6 806
Chris@6 807 inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
Chris@6 808 memory, Z_VERSION_ERROR if the zlib library version is incompatible with the
Chris@6 809 version assumed by the caller, or Z_STREAM_ERROR if the parameters are
Chris@6 810 invalid, such as a null pointer to the structure. msg is set to null if
Chris@6 811 there is no error message. inflateInit2 does not perform any decompression
Chris@6 812 apart from possibly reading the zlib header if present: actual decompression
Chris@6 813 will be done by inflate(). (So next_in and avail_in may be modified, but
Chris@6 814 next_out and avail_out are unused and unchanged.) The current implementation
Chris@6 815 of inflateInit2() does not process any header information -- that is
Chris@6 816 deferred until inflate() is called.
Chris@6 817 */
Chris@6 818
Chris@6 819 ZEXTERN int ZEXPORT inflateSetDictionary OF((z_streamp strm,
Chris@6 820 const Bytef *dictionary,
Chris@6 821 uInt dictLength));
Chris@6 822 /*
Chris@6 823 Initializes the decompression dictionary from the given uncompressed byte
Chris@6 824 sequence. This function must be called immediately after a call of inflate,
Chris@6 825 if that call returned Z_NEED_DICT. The dictionary chosen by the compressor
Chris@6 826 can be determined from the adler32 value returned by that call of inflate.
Chris@6 827 The compressor and decompressor must use exactly the same dictionary (see
Chris@6 828 deflateSetDictionary). For raw inflate, this function can be called at any
Chris@6 829 time to set the dictionary. If the provided dictionary is smaller than the
Chris@6 830 window and there is already data in the window, then the provided dictionary
Chris@6 831 will amend what's there. The application must insure that the dictionary
Chris@6 832 that was used for compression is provided.
Chris@6 833
Chris@6 834 inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a
Chris@6 835 parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is
Chris@6 836 inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the
Chris@6 837 expected one (incorrect adler32 value). inflateSetDictionary does not
Chris@6 838 perform any decompression: this will be done by subsequent calls of
Chris@6 839 inflate().
Chris@6 840 */
Chris@6 841
Chris@6 842 ZEXTERN int ZEXPORT inflateSync OF((z_streamp strm));
Chris@6 843 /*
Chris@6 844 Skips invalid compressed data until a possible full flush point (see above
Chris@6 845 for the description of deflate with Z_FULL_FLUSH) can be found, or until all
Chris@6 846 available input is skipped. No output is provided.
Chris@6 847
Chris@6 848 inflateSync searches for a 00 00 FF FF pattern in the compressed data.
Chris@6 849 All full flush points have this pattern, but not all occurences of this
Chris@6 850 pattern are full flush points.
Chris@6 851
Chris@6 852 inflateSync returns Z_OK if a possible full flush point has been found,
Chris@6 853 Z_BUF_ERROR if no more input was provided, Z_DATA_ERROR if no flush point
Chris@6 854 has been found, or Z_STREAM_ERROR if the stream structure was inconsistent.
Chris@6 855 In the success case, the application may save the current current value of
Chris@6 856 total_in which indicates where valid compressed data was found. In the
Chris@6 857 error case, the application may repeatedly call inflateSync, providing more
Chris@6 858 input each time, until success or end of the input data.
Chris@6 859 */
Chris@6 860
Chris@6 861 ZEXTERN int ZEXPORT inflateCopy OF((z_streamp dest,
Chris@6 862 z_streamp source));
Chris@6 863 /*
Chris@6 864 Sets the destination stream as a complete copy of the source stream.
Chris@6 865
Chris@6 866 This function can be useful when randomly accessing a large stream. The
Chris@6 867 first pass through the stream can periodically record the inflate state,
Chris@6 868 allowing restarting inflate at those points when randomly accessing the
Chris@6 869 stream.
Chris@6 870
Chris@6 871 inflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not
Chris@6 872 enough memory, Z_STREAM_ERROR if the source stream state was inconsistent
Chris@6 873 (such as zalloc being Z_NULL). msg is left unchanged in both source and
Chris@6 874 destination.
Chris@6 875 */
Chris@6 876
Chris@6 877 ZEXTERN int ZEXPORT inflateReset OF((z_streamp strm));
Chris@6 878 /*
Chris@6 879 This function is equivalent to inflateEnd followed by inflateInit,
Chris@6 880 but does not free and reallocate all the internal decompression state. The
Chris@6 881 stream will keep attributes that may have been set by inflateInit2.
Chris@6 882
Chris@6 883 inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
Chris@6 884 stream state was inconsistent (such as zalloc or state being Z_NULL).
Chris@6 885 */
Chris@6 886
Chris@6 887 ZEXTERN int ZEXPORT inflateReset2 OF((z_streamp strm,
Chris@6 888 int windowBits));
Chris@6 889 /*
Chris@6 890 This function is the same as inflateReset, but it also permits changing
Chris@6 891 the wrap and window size requests. The windowBits parameter is interpreted
Chris@6 892 the same as it is for inflateInit2.
Chris@6 893
Chris@6 894 inflateReset2 returns Z_OK if success, or Z_STREAM_ERROR if the source
Chris@6 895 stream state was inconsistent (such as zalloc or state being Z_NULL), or if
Chris@6 896 the windowBits parameter is invalid.
Chris@6 897 */
Chris@6 898
Chris@6 899 ZEXTERN int ZEXPORT inflatePrime OF((z_streamp strm,
Chris@6 900 int bits,
Chris@6 901 int value));
Chris@6 902 /*
Chris@6 903 This function inserts bits in the inflate input stream. The intent is
Chris@6 904 that this function is used to start inflating at a bit position in the
Chris@6 905 middle of a byte. The provided bits will be used before any bytes are used
Chris@6 906 from next_in. This function should only be used with raw inflate, and
Chris@6 907 should be used before the first inflate() call after inflateInit2() or
Chris@6 908 inflateReset(). bits must be less than or equal to 16, and that many of the
Chris@6 909 least significant bits of value will be inserted in the input.
Chris@6 910
Chris@6 911 If bits is negative, then the input stream bit buffer is emptied. Then
Chris@6 912 inflatePrime() can be called again to put bits in the buffer. This is used
Chris@6 913 to clear out bits leftover after feeding inflate a block description prior
Chris@6 914 to feeding inflate codes.
Chris@6 915
Chris@6 916 inflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source
Chris@6 917 stream state was inconsistent.
Chris@6 918 */
Chris@6 919
Chris@6 920 ZEXTERN long ZEXPORT inflateMark OF((z_streamp strm));
Chris@6 921 /*
Chris@6 922 This function returns two values, one in the lower 16 bits of the return
Chris@6 923 value, and the other in the remaining upper bits, obtained by shifting the
Chris@6 924 return value down 16 bits. If the upper value is -1 and the lower value is
Chris@6 925 zero, then inflate() is currently decoding information outside of a block.
Chris@6 926 If the upper value is -1 and the lower value is non-zero, then inflate is in
Chris@6 927 the middle of a stored block, with the lower value equaling the number of
Chris@6 928 bytes from the input remaining to copy. If the upper value is not -1, then
Chris@6 929 it is the number of bits back from the current bit position in the input of
Chris@6 930 the code (literal or length/distance pair) currently being processed. In
Chris@6 931 that case the lower value is the number of bytes already emitted for that
Chris@6 932 code.
Chris@6 933
Chris@6 934 A code is being processed if inflate is waiting for more input to complete
Chris@6 935 decoding of the code, or if it has completed decoding but is waiting for
Chris@6 936 more output space to write the literal or match data.
Chris@6 937
Chris@6 938 inflateMark() is used to mark locations in the input data for random
Chris@6 939 access, which may be at bit positions, and to note those cases where the
Chris@6 940 output of a code may span boundaries of random access blocks. The current
Chris@6 941 location in the input stream can be determined from avail_in and data_type
Chris@6 942 as noted in the description for the Z_BLOCK flush parameter for inflate.
Chris@6 943
Chris@6 944 inflateMark returns the value noted above or -1 << 16 if the provided
Chris@6 945 source stream state was inconsistent.
Chris@6 946 */
Chris@6 947
Chris@6 948 ZEXTERN int ZEXPORT inflateGetHeader OF((z_streamp strm,
Chris@6 949 gz_headerp head));
Chris@6 950 /*
Chris@6 951 inflateGetHeader() requests that gzip header information be stored in the
Chris@6 952 provided gz_header structure. inflateGetHeader() may be called after
Chris@6 953 inflateInit2() or inflateReset(), and before the first call of inflate().
Chris@6 954 As inflate() processes the gzip stream, head->done is zero until the header
Chris@6 955 is completed, at which time head->done is set to one. If a zlib stream is
Chris@6 956 being decoded, then head->done is set to -1 to indicate that there will be
Chris@6 957 no gzip header information forthcoming. Note that Z_BLOCK or Z_TREES can be
Chris@6 958 used to force inflate() to return immediately after header processing is
Chris@6 959 complete and before any actual data is decompressed.
Chris@6 960
Chris@6 961 The text, time, xflags, and os fields are filled in with the gzip header
Chris@6 962 contents. hcrc is set to true if there is a header CRC. (The header CRC
Chris@6 963 was valid if done is set to one.) If extra is not Z_NULL, then extra_max
Chris@6 964 contains the maximum number of bytes to write to extra. Once done is true,
Chris@6 965 extra_len contains the actual extra field length, and extra contains the
Chris@6 966 extra field, or that field truncated if extra_max is less than extra_len.
Chris@6 967 If name is not Z_NULL, then up to name_max characters are written there,
Chris@6 968 terminated with a zero unless the length is greater than name_max. If
Chris@6 969 comment is not Z_NULL, then up to comm_max characters are written there,
Chris@6 970 terminated with a zero unless the length is greater than comm_max. When any
Chris@6 971 of extra, name, or comment are not Z_NULL and the respective field is not
Chris@6 972 present in the header, then that field is set to Z_NULL to signal its
Chris@6 973 absence. This allows the use of deflateSetHeader() with the returned
Chris@6 974 structure to duplicate the header. However if those fields are set to
Chris@6 975 allocated memory, then the application will need to save those pointers
Chris@6 976 elsewhere so that they can be eventually freed.
Chris@6 977
Chris@6 978 If inflateGetHeader is not used, then the header information is simply
Chris@6 979 discarded. The header is always checked for validity, including the header
Chris@6 980 CRC if present. inflateReset() will reset the process to discard the header
Chris@6 981 information. The application would need to call inflateGetHeader() again to
Chris@6 982 retrieve the header from the next gzip stream.
Chris@6 983
Chris@6 984 inflateGetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source
Chris@6 985 stream state was inconsistent.
Chris@6 986 */
Chris@6 987
Chris@6 988 /*
Chris@6 989 ZEXTERN int ZEXPORT inflateBackInit OF((z_streamp strm, int windowBits,
Chris@6 990 unsigned char FAR *window));
Chris@6 991
Chris@6 992 Initialize the internal stream state for decompression using inflateBack()
Chris@6 993 calls. The fields zalloc, zfree and opaque in strm must be initialized
Chris@6 994 before the call. If zalloc and zfree are Z_NULL, then the default library-
Chris@6 995 derived memory allocation routines are used. windowBits is the base two
Chris@6 996 logarithm of the window size, in the range 8..15. window is a caller
Chris@6 997 supplied buffer of that size. Except for special applications where it is
Chris@6 998 assured that deflate was used with small window sizes, windowBits must be 15
Chris@6 999 and a 32K byte window must be supplied to be able to decompress general
Chris@6 1000 deflate streams.
Chris@6 1001
Chris@6 1002 See inflateBack() for the usage of these routines.
Chris@6 1003
Chris@6 1004 inflateBackInit will return Z_OK on success, Z_STREAM_ERROR if any of
Chris@6 1005 the parameters are invalid, Z_MEM_ERROR if the internal state could not be
Chris@6 1006 allocated, or Z_VERSION_ERROR if the version of the library does not match
Chris@6 1007 the version of the header file.
Chris@6 1008 */
Chris@6 1009
Chris@6 1010 typedef unsigned (*in_func) OF((void FAR *, unsigned char FAR * FAR *));
Chris@6 1011 typedef int (*out_func) OF((void FAR *, unsigned char FAR *, unsigned));
Chris@6 1012
Chris@6 1013 ZEXTERN int ZEXPORT inflateBack OF((z_streamp strm,
Chris@6 1014 in_func in, void FAR *in_desc,
Chris@6 1015 out_func out, void FAR *out_desc));
Chris@6 1016 /*
Chris@6 1017 inflateBack() does a raw inflate with a single call using a call-back
Chris@6 1018 interface for input and output. This is more efficient than inflate() for
Chris@6 1019 file i/o applications in that it avoids copying between the output and the
Chris@6 1020 sliding window by simply making the window itself the output buffer. This
Chris@6 1021 function trusts the application to not change the output buffer passed by
Chris@6 1022 the output function, at least until inflateBack() returns.
Chris@6 1023
Chris@6 1024 inflateBackInit() must be called first to allocate the internal state
Chris@6 1025 and to initialize the state with the user-provided window buffer.
Chris@6 1026 inflateBack() may then be used multiple times to inflate a complete, raw
Chris@6 1027 deflate stream with each call. inflateBackEnd() is then called to free the
Chris@6 1028 allocated state.
Chris@6 1029
Chris@6 1030 A raw deflate stream is one with no zlib or gzip header or trailer.
Chris@6 1031 This routine would normally be used in a utility that reads zip or gzip
Chris@6 1032 files and writes out uncompressed files. The utility would decode the
Chris@6 1033 header and process the trailer on its own, hence this routine expects only
Chris@6 1034 the raw deflate stream to decompress. This is different from the normal
Chris@6 1035 behavior of inflate(), which expects either a zlib or gzip header and
Chris@6 1036 trailer around the deflate stream.
Chris@6 1037
Chris@6 1038 inflateBack() uses two subroutines supplied by the caller that are then
Chris@6 1039 called by inflateBack() for input and output. inflateBack() calls those
Chris@6 1040 routines until it reads a complete deflate stream and writes out all of the
Chris@6 1041 uncompressed data, or until it encounters an error. The function's
Chris@6 1042 parameters and return types are defined above in the in_func and out_func
Chris@6 1043 typedefs. inflateBack() will call in(in_desc, &buf) which should return the
Chris@6 1044 number of bytes of provided input, and a pointer to that input in buf. If
Chris@6 1045 there is no input available, in() must return zero--buf is ignored in that
Chris@6 1046 case--and inflateBack() will return a buffer error. inflateBack() will call
Chris@6 1047 out(out_desc, buf, len) to write the uncompressed data buf[0..len-1]. out()
Chris@6 1048 should return zero on success, or non-zero on failure. If out() returns
Chris@6 1049 non-zero, inflateBack() will return with an error. Neither in() nor out()
Chris@6 1050 are permitted to change the contents of the window provided to
Chris@6 1051 inflateBackInit(), which is also the buffer that out() uses to write from.
Chris@6 1052 The length written by out() will be at most the window size. Any non-zero
Chris@6 1053 amount of input may be provided by in().
Chris@6 1054
Chris@6 1055 For convenience, inflateBack() can be provided input on the first call by
Chris@6 1056 setting strm->next_in and strm->avail_in. If that input is exhausted, then
Chris@6 1057 in() will be called. Therefore strm->next_in must be initialized before
Chris@6 1058 calling inflateBack(). If strm->next_in is Z_NULL, then in() will be called
Chris@6 1059 immediately for input. If strm->next_in is not Z_NULL, then strm->avail_in
Chris@6 1060 must also be initialized, and then if strm->avail_in is not zero, input will
Chris@6 1061 initially be taken from strm->next_in[0 .. strm->avail_in - 1].
Chris@6 1062
Chris@6 1063 The in_desc and out_desc parameters of inflateBack() is passed as the
Chris@6 1064 first parameter of in() and out() respectively when they are called. These
Chris@6 1065 descriptors can be optionally used to pass any information that the caller-
Chris@6 1066 supplied in() and out() functions need to do their job.
Chris@6 1067
Chris@6 1068 On return, inflateBack() will set strm->next_in and strm->avail_in to
Chris@6 1069 pass back any unused input that was provided by the last in() call. The
Chris@6 1070 return values of inflateBack() can be Z_STREAM_END on success, Z_BUF_ERROR
Chris@6 1071 if in() or out() returned an error, Z_DATA_ERROR if there was a format error
Chris@6 1072 in the deflate stream (in which case strm->msg is set to indicate the nature
Chris@6 1073 of the error), or Z_STREAM_ERROR if the stream was not properly initialized.
Chris@6 1074 In the case of Z_BUF_ERROR, an input or output error can be distinguished
Chris@6 1075 using strm->next_in which will be Z_NULL only if in() returned an error. If
Chris@6 1076 strm->next_in is not Z_NULL, then the Z_BUF_ERROR was due to out() returning
Chris@6 1077 non-zero. (in() will always be called before out(), so strm->next_in is
Chris@6 1078 assured to be defined if out() returns non-zero.) Note that inflateBack()
Chris@6 1079 cannot return Z_OK.
Chris@6 1080 */
Chris@6 1081
Chris@6 1082 ZEXTERN int ZEXPORT inflateBackEnd OF((z_streamp strm));
Chris@6 1083 /*
Chris@6 1084 All memory allocated by inflateBackInit() is freed.
Chris@6 1085
Chris@6 1086 inflateBackEnd() returns Z_OK on success, or Z_STREAM_ERROR if the stream
Chris@6 1087 state was inconsistent.
Chris@6 1088 */
Chris@6 1089
Chris@6 1090 ZEXTERN uLong ZEXPORT zlibCompileFlags OF((void));
Chris@6 1091 /* Return flags indicating compile-time options.
Chris@6 1092
Chris@6 1093 Type sizes, two bits each, 00 = 16 bits, 01 = 32, 10 = 64, 11 = other:
Chris@6 1094 1.0: size of uInt
Chris@6 1095 3.2: size of uLong
Chris@6 1096 5.4: size of voidpf (pointer)
Chris@6 1097 7.6: size of z_off_t
Chris@6 1098
Chris@6 1099 Compiler, assembler, and debug options:
Chris@6 1100 8: DEBUG
Chris@6 1101 9: ASMV or ASMINF -- use ASM code
Chris@6 1102 10: ZLIB_WINAPI -- exported functions use the WINAPI calling convention
Chris@6 1103 11: 0 (reserved)
Chris@6 1104
Chris@6 1105 One-time table building (smaller code, but not thread-safe if true):
Chris@6 1106 12: BUILDFIXED -- build static block decoding tables when needed
Chris@6 1107 13: DYNAMIC_CRC_TABLE -- build CRC calculation tables when needed
Chris@6 1108 14,15: 0 (reserved)
Chris@6 1109
Chris@6 1110 Library content (indicates missing functionality):
Chris@6 1111 16: NO_GZCOMPRESS -- gz* functions cannot compress (to avoid linking
Chris@6 1112 deflate code when not needed)
Chris@6 1113 17: NO_GZIP -- deflate can't write gzip streams, and inflate can't detect
Chris@6 1114 and decode gzip streams (to avoid linking crc code)
Chris@6 1115 18-19: 0 (reserved)
Chris@6 1116
Chris@6 1117 Operation variations (changes in library functionality):
Chris@6 1118 20: PKZIP_BUG_WORKAROUND -- slightly more permissive inflate
Chris@6 1119 21: FASTEST -- deflate algorithm with only one, lowest compression level
Chris@6 1120 22,23: 0 (reserved)
Chris@6 1121
Chris@6 1122 The sprintf variant used by gzprintf (zero is best):
Chris@6 1123 24: 0 = vs*, 1 = s* -- 1 means limited to 20 arguments after the format
Chris@6 1124 25: 0 = *nprintf, 1 = *printf -- 1 means gzprintf() not secure!
Chris@6 1125 26: 0 = returns value, 1 = void -- 1 means inferred string length returned
Chris@6 1126
Chris@6 1127 Remainder:
Chris@6 1128 27-31: 0 (reserved)
Chris@6 1129 */
Chris@6 1130
Chris@6 1131 #ifndef Z_SOLO
Chris@6 1132
Chris@6 1133 /* utility functions */
Chris@6 1134
Chris@6 1135 /*
Chris@6 1136 The following utility functions are implemented on top of the basic
Chris@6 1137 stream-oriented functions. To simplify the interface, some default options
Chris@6 1138 are assumed (compression level and memory usage, standard memory allocation
Chris@6 1139 functions). The source code of these utility functions can be modified if
Chris@6 1140 you need special options.
Chris@6 1141 */
Chris@6 1142
Chris@6 1143 ZEXTERN int ZEXPORT compress OF((Bytef *dest, uLongf *destLen,
Chris@6 1144 const Bytef *source, uLong sourceLen));
Chris@6 1145 /*
Chris@6 1146 Compresses the source buffer into the destination buffer. sourceLen is
Chris@6 1147 the byte length of the source buffer. Upon entry, destLen is the total size
Chris@6 1148 of the destination buffer, which must be at least the value returned by
Chris@6 1149 compressBound(sourceLen). Upon exit, destLen is the actual size of the
Chris@6 1150 compressed buffer.
Chris@6 1151
Chris@6 1152 compress returns Z_OK if success, Z_MEM_ERROR if there was not
Chris@6 1153 enough memory, Z_BUF_ERROR if there was not enough room in the output
Chris@6 1154 buffer.
Chris@6 1155 */
Chris@6 1156
Chris@6 1157 ZEXTERN int ZEXPORT compress2 OF((Bytef *dest, uLongf *destLen,
Chris@6 1158 const Bytef *source, uLong sourceLen,
Chris@6 1159 int level));
Chris@6 1160 /*
Chris@6 1161 Compresses the source buffer into the destination buffer. The level
Chris@6 1162 parameter has the same meaning as in deflateInit. sourceLen is the byte
Chris@6 1163 length of the source buffer. Upon entry, destLen is the total size of the
Chris@6 1164 destination buffer, which must be at least the value returned by
Chris@6 1165 compressBound(sourceLen). Upon exit, destLen is the actual size of the
Chris@6 1166 compressed buffer.
Chris@6 1167
Chris@6 1168 compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
Chris@6 1169 memory, Z_BUF_ERROR if there was not enough room in the output buffer,
Chris@6 1170 Z_STREAM_ERROR if the level parameter is invalid.
Chris@6 1171 */
Chris@6 1172
Chris@6 1173 ZEXTERN uLong ZEXPORT compressBound OF((uLong sourceLen));
Chris@6 1174 /*
Chris@6 1175 compressBound() returns an upper bound on the compressed size after
Chris@6 1176 compress() or compress2() on sourceLen bytes. It would be used before a
Chris@6 1177 compress() or compress2() call to allocate the destination buffer.
Chris@6 1178 */
Chris@6 1179
Chris@6 1180 ZEXTERN int ZEXPORT uncompress OF((Bytef *dest, uLongf *destLen,
Chris@6 1181 const Bytef *source, uLong sourceLen));
Chris@6 1182 /*
Chris@6 1183 Decompresses the source buffer into the destination buffer. sourceLen is
Chris@6 1184 the byte length of the source buffer. Upon entry, destLen is the total size
Chris@6 1185 of the destination buffer, which must be large enough to hold the entire
Chris@6 1186 uncompressed data. (The size of the uncompressed data must have been saved
Chris@6 1187 previously by the compressor and transmitted to the decompressor by some
Chris@6 1188 mechanism outside the scope of this compression library.) Upon exit, destLen
Chris@6 1189 is the actual size of the uncompressed buffer.
Chris@6 1190
Chris@6 1191 uncompress returns Z_OK if success, Z_MEM_ERROR if there was not
Chris@6 1192 enough memory, Z_BUF_ERROR if there was not enough room in the output
Chris@6 1193 buffer, or Z_DATA_ERROR if the input data was corrupted or incomplete. In
Chris@6 1194 the case where there is not enough room, uncompress() will fill the output
Chris@6 1195 buffer with the uncompressed data up to that point.
Chris@6 1196 */
Chris@6 1197
Chris@6 1198 /* gzip file access functions */
Chris@6 1199
Chris@6 1200 /*
Chris@6 1201 This library supports reading and writing files in gzip (.gz) format with
Chris@6 1202 an interface similar to that of stdio, using the functions that start with
Chris@6 1203 "gz". The gzip format is different from the zlib format. gzip is a gzip
Chris@6 1204 wrapper, documented in RFC 1952, wrapped around a deflate stream.
Chris@6 1205 */
Chris@6 1206
Chris@6 1207 typedef struct gzFile_s *gzFile; /* semi-opaque gzip file descriptor */
Chris@6 1208
Chris@6 1209 /*
Chris@6 1210 ZEXTERN gzFile ZEXPORT gzopen OF((const char *path, const char *mode));
Chris@6 1211
Chris@6 1212 Opens a gzip (.gz) file for reading or writing. The mode parameter is as
Chris@6 1213 in fopen ("rb" or "wb") but can also include a compression level ("wb9") or
Chris@6 1214 a strategy: 'f' for filtered data as in "wb6f", 'h' for Huffman-only
Chris@6 1215 compression as in "wb1h", 'R' for run-length encoding as in "wb1R", or 'F'
Chris@6 1216 for fixed code compression as in "wb9F". (See the description of
Chris@6 1217 deflateInit2 for more information about the strategy parameter.) 'T' will
Chris@6 1218 request transparent writing or appending with no compression and not using
Chris@6 1219 the gzip format.
Chris@6 1220
Chris@6 1221 "a" can be used instead of "w" to request that the gzip stream that will
Chris@6 1222 be written be appended to the file. "+" will result in an error, since
Chris@6 1223 reading and writing to the same gzip file is not supported. The addition of
Chris@6 1224 "x" when writing will create the file exclusively, which fails if the file
Chris@6 1225 already exists. On systems that support it, the addition of "e" when
Chris@6 1226 reading or writing will set the flag to close the file on an execve() call.
Chris@6 1227
Chris@6 1228 These functions, as well as gzip, will read and decode a sequence of gzip
Chris@6 1229 streams in a file. The append function of gzopen() can be used to create
Chris@6 1230 such a file. (Also see gzflush() for another way to do this.) When
Chris@6 1231 appending, gzopen does not test whether the file begins with a gzip stream,
Chris@6 1232 nor does it look for the end of the gzip streams to begin appending. gzopen
Chris@6 1233 will simply append a gzip stream to the existing file.
Chris@6 1234
Chris@6 1235 gzopen can be used to read a file which is not in gzip format; in this
Chris@6 1236 case gzread will directly read from the file without decompression. When
Chris@6 1237 reading, this will be detected automatically by looking for the magic two-
Chris@6 1238 byte gzip header.
Chris@6 1239
Chris@6 1240 gzopen returns NULL if the file could not be opened, if there was
Chris@6 1241 insufficient memory to allocate the gzFile state, or if an invalid mode was
Chris@6 1242 specified (an 'r', 'w', or 'a' was not provided, or '+' was provided).
Chris@6 1243 errno can be checked to determine if the reason gzopen failed was that the
Chris@6 1244 file could not be opened.
Chris@6 1245 */
Chris@6 1246
Chris@6 1247 ZEXTERN gzFile ZEXPORT gzdopen OF((int fd, const char *mode));
Chris@6 1248 /*
Chris@6 1249 gzdopen associates a gzFile with the file descriptor fd. File descriptors
Chris@6 1250 are obtained from calls like open, dup, creat, pipe or fileno (if the file
Chris@6 1251 has been previously opened with fopen). The mode parameter is as in gzopen.
Chris@6 1252
Chris@6 1253 The next call of gzclose on the returned gzFile will also close the file
Chris@6 1254 descriptor fd, just like fclose(fdopen(fd, mode)) closes the file descriptor
Chris@6 1255 fd. If you want to keep fd open, use fd = dup(fd_keep); gz = gzdopen(fd,
Chris@6 1256 mode);. The duplicated descriptor should be saved to avoid a leak, since
Chris@6 1257 gzdopen does not close fd if it fails. If you are using fileno() to get the
Chris@6 1258 file descriptor from a FILE *, then you will have to use dup() to avoid
Chris@6 1259 double-close()ing the file descriptor. Both gzclose() and fclose() will
Chris@6 1260 close the associated file descriptor, so they need to have different file
Chris@6 1261 descriptors.
Chris@6 1262
Chris@6 1263 gzdopen returns NULL if there was insufficient memory to allocate the
Chris@6 1264 gzFile state, if an invalid mode was specified (an 'r', 'w', or 'a' was not
Chris@6 1265 provided, or '+' was provided), or if fd is -1. The file descriptor is not
Chris@6 1266 used until the next gz* read, write, seek, or close operation, so gzdopen
Chris@6 1267 will not detect if fd is invalid (unless fd is -1).
Chris@6 1268 */
Chris@6 1269
Chris@6 1270 ZEXTERN int ZEXPORT gzbuffer OF((gzFile file, unsigned size));
Chris@6 1271 /*
Chris@6 1272 Set the internal buffer size used by this library's functions. The
Chris@6 1273 default buffer size is 8192 bytes. This function must be called after
Chris@6 1274 gzopen() or gzdopen(), and before any other calls that read or write the
Chris@6 1275 file. The buffer memory allocation is always deferred to the first read or
Chris@6 1276 write. Two buffers are allocated, either both of the specified size when
Chris@6 1277 writing, or one of the specified size and the other twice that size when
Chris@6 1278 reading. A larger buffer size of, for example, 64K or 128K bytes will
Chris@6 1279 noticeably increase the speed of decompression (reading).
Chris@6 1280
Chris@6 1281 The new buffer size also affects the maximum length for gzprintf().
Chris@6 1282
Chris@6 1283 gzbuffer() returns 0 on success, or -1 on failure, such as being called
Chris@6 1284 too late.
Chris@6 1285 */
Chris@6 1286
Chris@6 1287 ZEXTERN int ZEXPORT gzsetparams OF((gzFile file, int level, int strategy));
Chris@6 1288 /*
Chris@6 1289 Dynamically update the compression level or strategy. See the description
Chris@6 1290 of deflateInit2 for the meaning of these parameters.
Chris@6 1291
Chris@6 1292 gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not
Chris@6 1293 opened for writing.
Chris@6 1294 */
Chris@6 1295
Chris@6 1296 ZEXTERN int ZEXPORT gzread OF((gzFile file, voidp buf, unsigned len));
Chris@6 1297 /*
Chris@6 1298 Reads the given number of uncompressed bytes from the compressed file. If
Chris@6 1299 the input file is not in gzip format, gzread copies the given number of
Chris@6 1300 bytes into the buffer directly from the file.
Chris@6 1301
Chris@6 1302 After reaching the end of a gzip stream in the input, gzread will continue
Chris@6 1303 to read, looking for another gzip stream. Any number of gzip streams may be
Chris@6 1304 concatenated in the input file, and will all be decompressed by gzread().
Chris@6 1305 If something other than a gzip stream is encountered after a gzip stream,
Chris@6 1306 that remaining trailing garbage is ignored (and no error is returned).
Chris@6 1307
Chris@6 1308 gzread can be used to read a gzip file that is being concurrently written.
Chris@6 1309 Upon reaching the end of the input, gzread will return with the available
Chris@6 1310 data. If the error code returned by gzerror is Z_OK or Z_BUF_ERROR, then
Chris@6 1311 gzclearerr can be used to clear the end of file indicator in order to permit
Chris@6 1312 gzread to be tried again. Z_OK indicates that a gzip stream was completed
Chris@6 1313 on the last gzread. Z_BUF_ERROR indicates that the input file ended in the
Chris@6 1314 middle of a gzip stream. Note that gzread does not return -1 in the event
Chris@6 1315 of an incomplete gzip stream. This error is deferred until gzclose(), which
Chris@6 1316 will return Z_BUF_ERROR if the last gzread ended in the middle of a gzip
Chris@6 1317 stream. Alternatively, gzerror can be used before gzclose to detect this
Chris@6 1318 case.
Chris@6 1319
Chris@6 1320 gzread returns the number of uncompressed bytes actually read, less than
Chris@6 1321 len for end of file, or -1 for error.
Chris@6 1322 */
Chris@6 1323
Chris@6 1324 ZEXTERN int ZEXPORT gzwrite OF((gzFile file,
Chris@6 1325 voidpc buf, unsigned len));
Chris@6 1326 /*
Chris@6 1327 Writes the given number of uncompressed bytes into the compressed file.
Chris@6 1328 gzwrite returns the number of uncompressed bytes written or 0 in case of
Chris@6 1329 error.
Chris@6 1330 */
Chris@6 1331
Chris@6 1332 ZEXTERN int ZEXPORTVA gzprintf Z_ARG((gzFile file, const char *format, ...));
Chris@6 1333 /*
Chris@6 1334 Converts, formats, and writes the arguments to the compressed file under
Chris@6 1335 control of the format string, as in fprintf. gzprintf returns the number of
Chris@6 1336 uncompressed bytes actually written, or 0 in case of error. The number of
Chris@6 1337 uncompressed bytes written is limited to 8191, or one less than the buffer
Chris@6 1338 size given to gzbuffer(). The caller should assure that this limit is not
Chris@6 1339 exceeded. If it is exceeded, then gzprintf() will return an error (0) with
Chris@6 1340 nothing written. In this case, there may also be a buffer overflow with
Chris@6 1341 unpredictable consequences, which is possible only if zlib was compiled with
Chris@6 1342 the insecure functions sprintf() or vsprintf() because the secure snprintf()
Chris@6 1343 or vsnprintf() functions were not available. This can be determined using
Chris@6 1344 zlibCompileFlags().
Chris@6 1345 */
Chris@6 1346
Chris@6 1347 ZEXTERN int ZEXPORT gzputs OF((gzFile file, const char *s));
Chris@6 1348 /*
Chris@6 1349 Writes the given null-terminated string to the compressed file, excluding
Chris@6 1350 the terminating null character.
Chris@6 1351
Chris@6 1352 gzputs returns the number of characters written, or -1 in case of error.
Chris@6 1353 */
Chris@6 1354
Chris@6 1355 ZEXTERN char * ZEXPORT gzgets OF((gzFile file, char *buf, int len));
Chris@6 1356 /*
Chris@6 1357 Reads bytes from the compressed file until len-1 characters are read, or a
Chris@6 1358 newline character is read and transferred to buf, or an end-of-file
Chris@6 1359 condition is encountered. If any characters are read or if len == 1, the
Chris@6 1360 string is terminated with a null character. If no characters are read due
Chris@6 1361 to an end-of-file or len < 1, then the buffer is left untouched.
Chris@6 1362
Chris@6 1363 gzgets returns buf which is a null-terminated string, or it returns NULL
Chris@6 1364 for end-of-file or in case of error. If there was an error, the contents at
Chris@6 1365 buf are indeterminate.
Chris@6 1366 */
Chris@6 1367
Chris@6 1368 ZEXTERN int ZEXPORT gzputc OF((gzFile file, int c));
Chris@6 1369 /*
Chris@6 1370 Writes c, converted to an unsigned char, into the compressed file. gzputc
Chris@6 1371 returns the value that was written, or -1 in case of error.
Chris@6 1372 */
Chris@6 1373
Chris@6 1374 ZEXTERN int ZEXPORT gzgetc OF((gzFile file));
Chris@6 1375 /*
Chris@6 1376 Reads one byte from the compressed file. gzgetc returns this byte or -1
Chris@6 1377 in case of end of file or error. This is implemented as a macro for speed.
Chris@6 1378 As such, it does not do all of the checking the other functions do. I.e.
Chris@6 1379 it does not check to see if file is NULL, nor whether the structure file
Chris@6 1380 points to has been clobbered or not.
Chris@6 1381 */
Chris@6 1382
Chris@6 1383 ZEXTERN int ZEXPORT gzungetc OF((int c, gzFile file));
Chris@6 1384 /*
Chris@6 1385 Push one character back onto the stream to be read as the first character
Chris@6 1386 on the next read. At least one character of push-back is allowed.
Chris@6 1387 gzungetc() returns the character pushed, or -1 on failure. gzungetc() will
Chris@6 1388 fail if c is -1, and may fail if a character has been pushed but not read
Chris@6 1389 yet. If gzungetc is used immediately after gzopen or gzdopen, at least the
Chris@6 1390 output buffer size of pushed characters is allowed. (See gzbuffer above.)
Chris@6 1391 The pushed character will be discarded if the stream is repositioned with
Chris@6 1392 gzseek() or gzrewind().
Chris@6 1393 */
Chris@6 1394
Chris@6 1395 ZEXTERN int ZEXPORT gzflush OF((gzFile file, int flush));
Chris@6 1396 /*
Chris@6 1397 Flushes all pending output into the compressed file. The parameter flush
Chris@6 1398 is as in the deflate() function. The return value is the zlib error number
Chris@6 1399 (see function gzerror below). gzflush is only permitted when writing.
Chris@6 1400
Chris@6 1401 If the flush parameter is Z_FINISH, the remaining data is written and the
Chris@6 1402 gzip stream is completed in the output. If gzwrite() is called again, a new
Chris@6 1403 gzip stream will be started in the output. gzread() is able to read such
Chris@6 1404 concatented gzip streams.
Chris@6 1405
Chris@6 1406 gzflush should be called only when strictly necessary because it will
Chris@6 1407 degrade compression if called too often.
Chris@6 1408 */
Chris@6 1409
Chris@6 1410 /*
Chris@6 1411 ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile file,
Chris@6 1412 z_off_t offset, int whence));
Chris@6 1413
Chris@6 1414 Sets the starting position for the next gzread or gzwrite on the given
Chris@6 1415 compressed file. The offset represents a number of bytes in the
Chris@6 1416 uncompressed data stream. The whence parameter is defined as in lseek(2);
Chris@6 1417 the value SEEK_END is not supported.
Chris@6 1418
Chris@6 1419 If the file is opened for reading, this function is emulated but can be
Chris@6 1420 extremely slow. If the file is opened for writing, only forward seeks are
Chris@6 1421 supported; gzseek then compresses a sequence of zeroes up to the new
Chris@6 1422 starting position.
Chris@6 1423
Chris@6 1424 gzseek returns the resulting offset location as measured in bytes from
Chris@6 1425 the beginning of the uncompressed stream, or -1 in case of error, in
Chris@6 1426 particular if the file is opened for writing and the new starting position
Chris@6 1427 would be before the current position.
Chris@6 1428 */
Chris@6 1429
Chris@6 1430 ZEXTERN int ZEXPORT gzrewind OF((gzFile file));
Chris@6 1431 /*
Chris@6 1432 Rewinds the given file. This function is supported only for reading.
Chris@6 1433
Chris@6 1434 gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET)
Chris@6 1435 */
Chris@6 1436
Chris@6 1437 /*
Chris@6 1438 ZEXTERN z_off_t ZEXPORT gztell OF((gzFile file));
Chris@6 1439
Chris@6 1440 Returns the starting position for the next gzread or gzwrite on the given
Chris@6 1441 compressed file. This position represents a number of bytes in the
Chris@6 1442 uncompressed data stream, and is zero when starting, even if appending or
Chris@6 1443 reading a gzip stream from the middle of a file using gzdopen().
Chris@6 1444
Chris@6 1445 gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR)
Chris@6 1446 */
Chris@6 1447
Chris@6 1448 /*
Chris@6 1449 ZEXTERN z_off_t ZEXPORT gzoffset OF((gzFile file));
Chris@6 1450
Chris@6 1451 Returns the current offset in the file being read or written. This offset
Chris@6 1452 includes the count of bytes that precede the gzip stream, for example when
Chris@6 1453 appending or when using gzdopen() for reading. When reading, the offset
Chris@6 1454 does not include as yet unused buffered input. This information can be used
Chris@6 1455 for a progress indicator. On error, gzoffset() returns -1.
Chris@6 1456 */
Chris@6 1457
Chris@6 1458 ZEXTERN int ZEXPORT gzeof OF((gzFile file));
Chris@6 1459 /*
Chris@6 1460 Returns true (1) if the end-of-file indicator has been set while reading,
Chris@6 1461 false (0) otherwise. Note that the end-of-file indicator is set only if the
Chris@6 1462 read tried to go past the end of the input, but came up short. Therefore,
Chris@6 1463 just like feof(), gzeof() may return false even if there is no more data to
Chris@6 1464 read, in the event that the last read request was for the exact number of
Chris@6 1465 bytes remaining in the input file. This will happen if the input file size
Chris@6 1466 is an exact multiple of the buffer size.
Chris@6 1467
Chris@6 1468 If gzeof() returns true, then the read functions will return no more data,
Chris@6 1469 unless the end-of-file indicator is reset by gzclearerr() and the input file
Chris@6 1470 has grown since the previous end of file was detected.
Chris@6 1471 */
Chris@6 1472
Chris@6 1473 ZEXTERN int ZEXPORT gzdirect OF((gzFile file));
Chris@6 1474 /*
Chris@6 1475 Returns true (1) if file is being copied directly while reading, or false
Chris@6 1476 (0) if file is a gzip stream being decompressed.
Chris@6 1477
Chris@6 1478 If the input file is empty, gzdirect() will return true, since the input
Chris@6 1479 does not contain a gzip stream.
Chris@6 1480
Chris@6 1481 If gzdirect() is used immediately after gzopen() or gzdopen() it will
Chris@6 1482 cause buffers to be allocated to allow reading the file to determine if it
Chris@6 1483 is a gzip file. Therefore if gzbuffer() is used, it should be called before
Chris@6 1484 gzdirect().
Chris@6 1485
Chris@6 1486 When writing, gzdirect() returns true (1) if transparent writing was
Chris@6 1487 requested ("wT" for the gzopen() mode), or false (0) otherwise. (Note:
Chris@6 1488 gzdirect() is not needed when writing. Transparent writing must be
Chris@6 1489 explicitly requested, so the application already knows the answer. When
Chris@6 1490 linking statically, using gzdirect() will include all of the zlib code for
Chris@6 1491 gzip file reading and decompression, which may not be desired.)
Chris@6 1492 */
Chris@6 1493
Chris@6 1494 ZEXTERN int ZEXPORT gzclose OF((gzFile file));
Chris@6 1495 /*
Chris@6 1496 Flushes all pending output if necessary, closes the compressed file and
Chris@6 1497 deallocates the (de)compression state. Note that once file is closed, you
Chris@6 1498 cannot call gzerror with file, since its structures have been deallocated.
Chris@6 1499 gzclose must not be called more than once on the same file, just as free
Chris@6 1500 must not be called more than once on the same allocation.
Chris@6 1501
Chris@6 1502 gzclose will return Z_STREAM_ERROR if file is not valid, Z_ERRNO on a
Chris@6 1503 file operation error, Z_MEM_ERROR if out of memory, Z_BUF_ERROR if the
Chris@6 1504 last read ended in the middle of a gzip stream, or Z_OK on success.
Chris@6 1505 */
Chris@6 1506
Chris@6 1507 ZEXTERN int ZEXPORT gzclose_r OF((gzFile file));
Chris@6 1508 ZEXTERN int ZEXPORT gzclose_w OF((gzFile file));
Chris@6 1509 /*
Chris@6 1510 Same as gzclose(), but gzclose_r() is only for use when reading, and
Chris@6 1511 gzclose_w() is only for use when writing or appending. The advantage to
Chris@6 1512 using these instead of gzclose() is that they avoid linking in zlib
Chris@6 1513 compression or decompression code that is not used when only reading or only
Chris@6 1514 writing respectively. If gzclose() is used, then both compression and
Chris@6 1515 decompression code will be included the application when linking to a static
Chris@6 1516 zlib library.
Chris@6 1517 */
Chris@6 1518
Chris@6 1519 ZEXTERN const char * ZEXPORT gzerror OF((gzFile file, int *errnum));
Chris@6 1520 /*
Chris@6 1521 Returns the error message for the last error which occurred on the given
Chris@6 1522 compressed file. errnum is set to zlib error number. If an error occurred
Chris@6 1523 in the file system and not in the compression library, errnum is set to
Chris@6 1524 Z_ERRNO and the application may consult errno to get the exact error code.
Chris@6 1525
Chris@6 1526 The application must not modify the returned string. Future calls to
Chris@6 1527 this function may invalidate the previously returned string. If file is
Chris@6 1528 closed, then the string previously returned by gzerror will no longer be
Chris@6 1529 available.
Chris@6 1530
Chris@6 1531 gzerror() should be used to distinguish errors from end-of-file for those
Chris@6 1532 functions above that do not distinguish those cases in their return values.
Chris@6 1533 */
Chris@6 1534
Chris@6 1535 ZEXTERN void ZEXPORT gzclearerr OF((gzFile file));
Chris@6 1536 /*
Chris@6 1537 Clears the error and end-of-file flags for file. This is analogous to the
Chris@6 1538 clearerr() function in stdio. This is useful for continuing to read a gzip
Chris@6 1539 file that is being written concurrently.
Chris@6 1540 */
Chris@6 1541
Chris@6 1542 #endif /* !Z_SOLO */
Chris@6 1543
Chris@6 1544 /* checksum functions */
Chris@6 1545
Chris@6 1546 /*
Chris@6 1547 These functions are not related to compression but are exported
Chris@6 1548 anyway because they might be useful in applications using the compression
Chris@6 1549 library.
Chris@6 1550 */
Chris@6 1551
Chris@6 1552 ZEXTERN uLong ZEXPORT adler32 OF((uLong adler, const Bytef *buf, uInt len));
Chris@6 1553 /*
Chris@6 1554 Update a running Adler-32 checksum with the bytes buf[0..len-1] and
Chris@6 1555 return the updated checksum. If buf is Z_NULL, this function returns the
Chris@6 1556 required initial value for the checksum.
Chris@6 1557
Chris@6 1558 An Adler-32 checksum is almost as reliable as a CRC32 but can be computed
Chris@6 1559 much faster.
Chris@6 1560
Chris@6 1561 Usage example:
Chris@6 1562
Chris@6 1563 uLong adler = adler32(0L, Z_NULL, 0);
Chris@6 1564
Chris@6 1565 while (read_buffer(buffer, length) != EOF) {
Chris@6 1566 adler = adler32(adler, buffer, length);
Chris@6 1567 }
Chris@6 1568 if (adler != original_adler) error();
Chris@6 1569 */
Chris@6 1570
Chris@6 1571 /*
Chris@6 1572 ZEXTERN uLong ZEXPORT adler32_combine OF((uLong adler1, uLong adler2,
Chris@6 1573 z_off_t len2));
Chris@6 1574
Chris@6 1575 Combine two Adler-32 checksums into one. For two sequences of bytes, seq1
Chris@6 1576 and seq2 with lengths len1 and len2, Adler-32 checksums were calculated for
Chris@6 1577 each, adler1 and adler2. adler32_combine() returns the Adler-32 checksum of
Chris@6 1578 seq1 and seq2 concatenated, requiring only adler1, adler2, and len2. Note
Chris@6 1579 that the z_off_t type (like off_t) is a signed integer. If len2 is
Chris@6 1580 negative, the result has no meaning or utility.
Chris@6 1581 */
Chris@6 1582
Chris@6 1583 ZEXTERN uLong ZEXPORT crc32 OF((uLong crc, const Bytef *buf, uInt len));
Chris@6 1584 /*
Chris@6 1585 Update a running CRC-32 with the bytes buf[0..len-1] and return the
Chris@6 1586 updated CRC-32. If buf is Z_NULL, this function returns the required
Chris@6 1587 initial value for the crc. Pre- and post-conditioning (one's complement) is
Chris@6 1588 performed within this function so it shouldn't be done by the application.
Chris@6 1589
Chris@6 1590 Usage example:
Chris@6 1591
Chris@6 1592 uLong crc = crc32(0L, Z_NULL, 0);
Chris@6 1593
Chris@6 1594 while (read_buffer(buffer, length) != EOF) {
Chris@6 1595 crc = crc32(crc, buffer, length);
Chris@6 1596 }
Chris@6 1597 if (crc != original_crc) error();
Chris@6 1598 */
Chris@6 1599
Chris@6 1600 /*
Chris@6 1601 ZEXTERN uLong ZEXPORT crc32_combine OF((uLong crc1, uLong crc2, z_off_t len2));
Chris@6 1602
Chris@6 1603 Combine two CRC-32 check values into one. For two sequences of bytes,
Chris@6 1604 seq1 and seq2 with lengths len1 and len2, CRC-32 check values were
Chris@6 1605 calculated for each, crc1 and crc2. crc32_combine() returns the CRC-32
Chris@6 1606 check value of seq1 and seq2 concatenated, requiring only crc1, crc2, and
Chris@6 1607 len2.
Chris@6 1608 */
Chris@6 1609
Chris@6 1610
Chris@6 1611 /* various hacks, don't look :) */
Chris@6 1612
Chris@6 1613 /* deflateInit and inflateInit are macros to allow checking the zlib version
Chris@6 1614 * and the compiler's view of z_stream:
Chris@6 1615 */
Chris@6 1616 ZEXTERN int ZEXPORT deflateInit_ OF((z_streamp strm, int level,
Chris@6 1617 const char *version, int stream_size));
Chris@6 1618 ZEXTERN int ZEXPORT inflateInit_ OF((z_streamp strm,
Chris@6 1619 const char *version, int stream_size));
Chris@6 1620 ZEXTERN int ZEXPORT deflateInit2_ OF((z_streamp strm, int level, int method,
Chris@6 1621 int windowBits, int memLevel,
Chris@6 1622 int strategy, const char *version,
Chris@6 1623 int stream_size));
Chris@6 1624 ZEXTERN int ZEXPORT inflateInit2_ OF((z_streamp strm, int windowBits,
Chris@6 1625 const char *version, int stream_size));
Chris@6 1626 ZEXTERN int ZEXPORT inflateBackInit_ OF((z_streamp strm, int windowBits,
Chris@6 1627 unsigned char FAR *window,
Chris@6 1628 const char *version,
Chris@6 1629 int stream_size));
Chris@6 1630 #define deflateInit(strm, level) \
Chris@6 1631 deflateInit_((strm), (level), ZLIB_VERSION, (int)sizeof(z_stream))
Chris@6 1632 #define inflateInit(strm) \
Chris@6 1633 inflateInit_((strm), ZLIB_VERSION, (int)sizeof(z_stream))
Chris@6 1634 #define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \
Chris@6 1635 deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\
Chris@6 1636 (strategy), ZLIB_VERSION, (int)sizeof(z_stream))
Chris@6 1637 #define inflateInit2(strm, windowBits) \
Chris@6 1638 inflateInit2_((strm), (windowBits), ZLIB_VERSION, \
Chris@6 1639 (int)sizeof(z_stream))
Chris@6 1640 #define inflateBackInit(strm, windowBits, window) \
Chris@6 1641 inflateBackInit_((strm), (windowBits), (window), \
Chris@6 1642 ZLIB_VERSION, (int)sizeof(z_stream))
Chris@6 1643
Chris@6 1644 #ifndef Z_SOLO
Chris@6 1645
Chris@6 1646 /* gzgetc() macro and its supporting function and exposed data structure. Note
Chris@6 1647 * that the real internal state is much larger than the exposed structure.
Chris@6 1648 * This abbreviated structure exposes just enough for the gzgetc() macro. The
Chris@6 1649 * user should not mess with these exposed elements, since their names or
Chris@6 1650 * behavior could change in the future, perhaps even capriciously. They can
Chris@6 1651 * only be used by the gzgetc() macro. You have been warned.
Chris@6 1652 */
Chris@6 1653 struct gzFile_s {
Chris@6 1654 unsigned have;
Chris@6 1655 unsigned char *next;
Chris@6 1656 z_off64_t pos;
Chris@6 1657 };
Chris@6 1658 ZEXTERN int ZEXPORT gzgetc_ OF((gzFile file)); /* backward compatibility */
Chris@6 1659 #ifdef Z_PREFIX_SET
Chris@6 1660 # undef z_gzgetc
Chris@6 1661 # define z_gzgetc(g) \
Chris@6 1662 ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g))
Chris@6 1663 #else
Chris@6 1664 # define gzgetc(g) \
Chris@6 1665 ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g))
Chris@6 1666 #endif
Chris@6 1667
Chris@6 1668 /* provide 64-bit offset functions if _LARGEFILE64_SOURCE defined, and/or
Chris@6 1669 * change the regular functions to 64 bits if _FILE_OFFSET_BITS is 64 (if
Chris@6 1670 * both are true, the application gets the *64 functions, and the regular
Chris@6 1671 * functions are changed to 64 bits) -- in case these are set on systems
Chris@6 1672 * without large file support, _LFS64_LARGEFILE must also be true
Chris@6 1673 */
Chris@6 1674 #ifdef Z_LARGE64
Chris@6 1675 ZEXTERN gzFile ZEXPORT gzopen64 OF((const char *, const char *));
Chris@6 1676 ZEXTERN z_off64_t ZEXPORT gzseek64 OF((gzFile, z_off64_t, int));
Chris@6 1677 ZEXTERN z_off64_t ZEXPORT gztell64 OF((gzFile));
Chris@6 1678 ZEXTERN z_off64_t ZEXPORT gzoffset64 OF((gzFile));
Chris@6 1679 ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, z_off64_t));
Chris@6 1680 ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, z_off64_t));
Chris@6 1681 #endif
Chris@6 1682
Chris@6 1683 #if !defined(ZLIB_INTERNAL) && defined(Z_WANT64)
Chris@6 1684 # ifdef Z_PREFIX_SET
Chris@6 1685 # define z_gzopen z_gzopen64
Chris@6 1686 # define z_gzseek z_gzseek64
Chris@6 1687 # define z_gztell z_gztell64
Chris@6 1688 # define z_gzoffset z_gzoffset64
Chris@6 1689 # define z_adler32_combine z_adler32_combine64
Chris@6 1690 # define z_crc32_combine z_crc32_combine64
Chris@6 1691 # else
Chris@6 1692 # define gzopen gzopen64
Chris@6 1693 # define gzseek gzseek64
Chris@6 1694 # define gztell gztell64
Chris@6 1695 # define gzoffset gzoffset64
Chris@6 1696 # define adler32_combine adler32_combine64
Chris@6 1697 # define crc32_combine crc32_combine64
Chris@6 1698 # endif
Chris@6 1699 # ifndef Z_LARGE64
Chris@6 1700 ZEXTERN gzFile ZEXPORT gzopen64 OF((const char *, const char *));
Chris@6 1701 ZEXTERN z_off_t ZEXPORT gzseek64 OF((gzFile, z_off_t, int));
Chris@6 1702 ZEXTERN z_off_t ZEXPORT gztell64 OF((gzFile));
Chris@6 1703 ZEXTERN z_off_t ZEXPORT gzoffset64 OF((gzFile));
Chris@6 1704 ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, z_off_t));
Chris@6 1705 ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, z_off_t));
Chris@6 1706 # endif
Chris@6 1707 #else
Chris@6 1708 ZEXTERN gzFile ZEXPORT gzopen OF((const char *, const char *));
Chris@6 1709 ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile, z_off_t, int));
Chris@6 1710 ZEXTERN z_off_t ZEXPORT gztell OF((gzFile));
Chris@6 1711 ZEXTERN z_off_t ZEXPORT gzoffset OF((gzFile));
Chris@6 1712 ZEXTERN uLong ZEXPORT adler32_combine OF((uLong, uLong, z_off_t));
Chris@6 1713 ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t));
Chris@6 1714 #endif
Chris@6 1715
Chris@6 1716 #else /* Z_SOLO */
Chris@6 1717
Chris@6 1718 ZEXTERN uLong ZEXPORT adler32_combine OF((uLong, uLong, z_off_t));
Chris@6 1719 ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t));
Chris@6 1720
Chris@6 1721 #endif /* !Z_SOLO */
Chris@6 1722
Chris@6 1723 /* hack for buggy compilers */
Chris@6 1724 #if !defined(ZUTIL_H) && !defined(NO_DUMMY_DECL)
Chris@6 1725 struct internal_state {int dummy;};
Chris@6 1726 #endif
Chris@6 1727
Chris@6 1728 /* undocumented functions */
Chris@6 1729 ZEXTERN const char * ZEXPORT zError OF((int));
Chris@6 1730 ZEXTERN int ZEXPORT inflateSyncPoint OF((z_streamp));
Chris@6 1731 ZEXTERN const z_crc_t FAR * ZEXPORT get_crc_table OF((void));
Chris@6 1732 ZEXTERN int ZEXPORT inflateUndermine OF((z_streamp, int));
Chris@6 1733 ZEXTERN int ZEXPORT inflateResetKeep OF((z_streamp));
Chris@6 1734 ZEXTERN int ZEXPORT deflateResetKeep OF((z_streamp));
Chris@6 1735 #if defined(_WIN32) && !defined(Z_SOLO)
Chris@6 1736 ZEXTERN gzFile ZEXPORT gzopen_w OF((const wchar_t *path,
Chris@6 1737 const char *mode));
Chris@6 1738 #endif
Chris@6 1739
Chris@6 1740 #ifdef __cplusplus
Chris@6 1741 }
Chris@6 1742 #endif
Chris@6 1743
Chris@6 1744 #endif /* ZLIB_H */