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