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