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