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