modernc.org/cc@v1.0.1/v2/headers/linux_386/usr/include/zlib.h (about)

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