Diff

Differences From Artifact [1a18ba7ea3]:

To Artifact [400d35465f]:


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