annotate win32-mingw/include/zlib.h @ 91:9fe94270bdf5

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