Changeset 94a2ecc in rtems


Ignore:
Timestamp:
Mar 18, 2011, 10:11:35 AM (9 years ago)
Author:
Ralf Corsepius <ralf.corsepius@…>
Branches:
4.11, master
Children:
43b1d3a, a9503cc
Parents:
416fb2ba
Message:

Import from zlib-1.2.4

Location:
cpukit/zlib
Files:
1 added
3 edited

Legend:

Unmodified
Added
Removed
  • cpukit/zlib/zlib.3

    r416fb2ba r94a2ecc  
    1 .TH ZLIB 3 "18 July 2005"
     1.TH ZLIB 3 "14 March 2010"
    22.SH NAME
    33zlib \- compression/decompression library
     
    1010.I zlib
    1111library is a general purpose data compression library.
    12 The code is thread safe.
     12The code is thread safe, assuming that the standard library functions
     13used are thread safe, such as memory allocation routines.
    1314It provides in-memory compression and decompression functions,
    1415including integrity checks of the uncompressed data.
    1516This version of the library supports only one compression method (deflation)
    16 but other algorithms will be added later
    17 and will have the same stream interface.
     17but other algorithms may be added later
     18with the same stream interface.
    1819.LP
    1920Compression can be done in a single step if the buffers are large enough
    20 (for example if an input file is mmap'ed),
    2121or can be done by repeated calls of the compression function.
    2222In the latter case,
     
    3131The library does not install any signal handler.
    3232The decoder checks the consistency of the compressed data,
    33 so the library should never crash even in case of corrupted input.
     33so the library should never crash even in the case of corrupted input.
    3434.LP
    3535All functions of the compression library are documented in the file
     
    3939.I example.c
    4040and
    41 .IR minigzip.c .
     41.IR minigzip.c,
     42as well as other examples in the
     43.IR examples/
     44directory.
    4245.LP
    4346Changes to this version are documented in the file
    4447.I ChangeLog
    45 that accompanies the source,
    46 and are concerned primarily with bug fixes and portability enhancements.
     48that accompanies the source.
    4749.LP
    48 A Java implementation of
    4950.I zlib
    50 is available in the Java Development Kit 1.1:
     51is available in Java using the java.util.zip package:
    5152.IP
    52 http://www.javasoft.com/products/JDK/1.1/docs/api/Package-java.util.zip.html
     53http://java.sun.com/developer/technicalArticles/Programming/compression/
    5354.LP
    5455A Perl interface to
     
    5859including:
    5960.IP
    60 http://www.cpan.org/modules/by-module/Compress/
     61http://search.cpan.org/~pmqs/IO-Compress-Zlib/
    6162.LP
    6263A Python interface to
     
    6768http://www.python.org/doc/lib/module-zlib.html
    6869.LP
    69 A
    7070.I zlib
    71 binding for
    72 .IR tcl (1),
    73 written by Andreas Kupries (a.kupries@westend.com),
    74 is availlable at:
     71is built into
     72.IR tcl:
    7573.IP
    76 http://www.westend.com/~kupries/doc/trf/man/man.html
     74http://wiki.tcl.tk/4610
    7775.LP
    7876An experimental package to read and write files in .zip format,
     
    8280is available at:
    8381.IP
    84 http://www.winimage.com/zLibDll/unzip.html
     82http://www.winimage.com/zLibDll/minizip.html
    8583and also in the
    8684.I contrib/minizip
    8785directory of the main
    8886.I zlib
    89 web site.
     87source distribution.
    9088.SH "SEE ALSO"
    9189The
    9290.I zlib
    93 web site can be found at either of these locations:
     91web site can be found at:
    9492.IP
    95 http://www.zlib.org
    96 .br
    97 http://www.gzip.org/zlib/
     93http://zlib.net/
    9894.LP
    9995The data format used by the zlib library is described by RFC
    10096(Request for Comments) 1950 to 1952 in the files:
    10197.IP
    102 http://www.ietf.org/rfc/rfc1950.txt (concerning zlib format)
     98http://www.ietf.org/rfc/rfc1950.txt (for the zlib header and trailer format)
    10399.br
    104 http://www.ietf.org/rfc/rfc1951.txt (concerning deflate format)
     100http://www.ietf.org/rfc/rfc1951.txt (for the deflate compressed data format)
    105101.br
    106 http://www.ietf.org/rfc/rfc1952.txt (concerning gzip format)
     102http://www.ietf.org/rfc/rfc1952.txt (for the gzip header and trailer format)
    107103.LP
    108 These documents are also available in other formats from:
    109 .IP
    110 ftp://ftp.uu.net/graphics/png/documents/zlib/zdoc-index.html
    111 .LP
    112 Mark Nelson (markn@ieee.org) wrote an article about
     104Mark Nelson wrote an article about
    113105.I zlib
    114106for the Jan. 1997 issue of  Dr. Dobb's Journal;
    115107a copy of the article is available at:
    116108.IP
    117 http://dogma.net/markn/articles/zlibtool/zlibtool.htm
     109http://marknelson.us/1997/01/01/zlib-engine/
    118110.SH "REPORTING PROBLEMS"
    119111Before reporting a problem,
     
    128120FAQ at:
    129121.IP
    130 http://www.gzip.org/zlib/zlib_faq.html
     122http://zlib.net/zlib_faq.html
    131123.LP
    132124before asking for help.
     
    134126or (for the Windows DLL version) to Gilles Vollant (info@winimage.com).
    135127.SH AUTHORS
    136 Version 1.2.3
    137 Copyright (C) 1995-2005 Jean-loup Gailly (jloup@gzip.org)
     128Version 1.2.4
     129Copyright (C) 1995-2010 Jean-loup Gailly (jloup@gzip.org)
    138130and Mark Adler (madler@alumni.caltech.edu).
    139131.LP
  • cpukit/zlib/zlib.h

    r416fb2ba r94a2ecc  
    11/* zlib.h -- interface of the 'zlib' general purpose compression library
    2   version 1.2.3, July 18th, 2005
    3 
    4   Copyright (C) 1995-2005 Jean-loup Gailly and Mark Adler
     2  version 1.2.4, Mar 14th, 2010
     3
     4  Copyright (C) 1995-2010 Jean-loup Gailly and Mark Adler
    55
    66  This software is provided 'as-is', without any express or implied
     
    3838#endif
    3939
    40 #define ZLIB_VERSION "1.2.3"
    41 #define ZLIB_VERNUM 0x1230
    42 
    43 /*
    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.
    49 
    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
     40#define ZLIB_VERSION "1.2.4"
     41#define ZLIB_VERNUM 0x1240
     42#define ZLIB_VER_MAJOR 1
     43#define ZLIB_VER_MINOR 2
     44#define ZLIB_VER_REVISION 4
     45#define ZLIB_VER_SUBREVISION 0
     46
     47/*
     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.
     53
     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
    5457  (providing more output space) before each call.
    5558
    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
    5760  the zlib format, which is a zlib wrapper documented in RFC 1950, wrapped
    5861  around a deflate stream, which is itself documented in RFC 1951.
    5962
    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
    6164  with an interface similar to that of stdio using the functions that start
    6265  with "gz".  The gzip format is different from the zlib format.  gzip is a
    6366  gzip wrapper, documented in RFC 1952, wrapped around a deflate stream.
    6467
    65      This library can optionally read and write gzip streams in memory as well.
    66 
    67      The zlib format was designed to be compact and fast for use in memory
     68    This library can optionally read and write gzip streams in memory as well.
     69
     70    The zlib format was designed to be compact and fast for use in memory
    6871  and on communications channels.  The gzip format was designed for single-
    6972  file compression on file systems, has a larger header than zlib to maintain
    7073  directory information, and uses a different, slower check method than zlib.
    7174
    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.
    7578*/
    7679
     
    127130
    128131/*
    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.
    134 
    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
     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.
     137
     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
    138141   opaque value.
    139142
    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.
    141144   If zlib is used in a multi-threaded application, zalloc and zfree must be
    142145   thread safe.
    143146
    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).
    152 
    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).
     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).
     155
     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).
    158160*/
    159161
     
    161163
    162164#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
    164166#define Z_SYNC_FLUSH    2
    165167#define Z_FULL_FLUSH    3
    166168#define Z_FINISH        4
    167169#define Z_BLOCK         5
     170#define Z_TREES         6
    168171/* Allowed flush values; see deflate() and inflate() below for details */
    169172
     
    177180#define Z_BUF_ERROR    (-5)
    178181#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.
    181184 */
    182185
     
    208211/* for compatibility with versions < 1.0.2 */
    209212
     213
    210214                        /* basic functions */
    211215
    212216ZEXTERN const char * ZEXPORT zlibVersion OF((void));
    213217/* 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.
    217221 */
    218222
     
    220224ZEXTERN int ZEXPORT deflateInit OF((z_streamp strm, int level));
    221225
    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.
    226230
    227231     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 
    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,
     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).
     236
     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
    235239   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().
    239243*/
    240244
     
    243247/*
    244248    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
    247251  forced to flush.
    248252
    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
    250254  following actions:
    251255
    252256  - 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
    254258    enough room in the output buffer), next_in and avail_in are updated and
    255259    processing will resume at this point for the next call of deflate().
    256260
    257261  - 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.
    259263    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.
    262 
    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.
     264    should be set only when necessary (in interactive applications).  Some
     265    output may be provided even if flush is not set.
     266
     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.
    271275
    272276    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
    274278  maximize compression.
    275279
    276280    If the parameter flush is set to Z_SYNC_FLUSH, all pending output is
    277281  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.
    282306
    283307    If flush is set to Z_FULL_FLUSH, all output is flushed as with
    284308  Z_SYNC_FLUSH, and the compression state is reset so that decompression can
    285309  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
    287311  compression.
    288312
     
    290314  with the same value of the flush parameter and more output space (updated
    291315  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
    293317  avail_out is greater than six to avoid repeated flush markers due to
    294318  avail_out == 0 on return.
    295319
    296320    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
    299323  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.
    303327
    304328    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
     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). If deflate does not return
    307331  Z_STREAM_END, then it must be called again as described above.
    308332
     
    311335
    312336    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.
     337  the input data type (Z_BINARY or Z_TEXT).  In doubt, the data is considered
     338  binary.  This field is only for information purposes and does not affect the
     339  compression algorithm in any manner.
    316340
    317341    deflate() returns Z_OK if some progress has been made (more input
     
    319343  consumed and all output has been produced (only when flush is set to
    320344  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
     345  if next_in or next_out was Z_NULL), Z_BUF_ERROR if no progress is possible
     346  (for example avail_in or avail_out was zero).  Note that Z_BUF_ERROR is not
    323347  fatal, and deflate() can be called again with more input and more output
    324348  space to continue compressing.
     
    329353/*
    330354     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.
     355   This function discards any unprocessed input and does not flush any pending
     356   output.
    333357
    334358     deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the
    335359   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
     360   prematurely (some input or output was discarded).  In the error case, msg
     361   may be set but then points to a static string (which must not be
    338362   deallocated).
    339363*/
     
    343367ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm));
    344368
    345      Initializes the internal stream state for decompression. The fields
     369     Initializes the internal stream state for decompression.  The fields
    346370   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
     371   the caller.  If next_in is not Z_NULL and avail_in is large enough (the
     372   exact value depends on the compression method), inflateInit determines the
    349373   compression method from the zlib header and allocates all data structures
    350374   accordingly; otherwise the allocation will be deferred to the first call of
     
    354378     inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough
    355379   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.)
     380   version assumed by the caller, or Z_STREAM_ERROR if the parameters are
     381   invalid, such as a null pointer to the structure.  msg is set to null if
     382   there is no error message.  inflateInit does not perform any decompression
     383   apart from possibly reading the zlib header if present: actual decompression
     384   will be done by inflate().  (So next_in and avail_in may be modified, but
     385   next_out and avail_out are unused and unchanged.) The current implementation
     386   of inflateInit() does not process any header information -- that is deferred
     387   until inflate() is called.
    360388*/
    361389
     
    364392/*
    365393    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
     394  buffer becomes empty or the output buffer becomes full.  It may introduce
    367395  some output latency (reading input without producing any output) except when
    368396  forced to flush.
    369397
    370   The detailed semantics are as follows. inflate performs one or both of the
     398  The detailed semantics are as follows.  inflate performs one or both of the
    371399  following actions:
    372400
    373401  - 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().
     402    accordingly.  If not all input can be processed (because there is not
     403    enough room in the output buffer), next_in is updated and processing will
     404    resume at this point for the next call of inflate().
    377405
    378406  - 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.
     407    accordingly.  inflate() provides as much output as possible, until there is
     408    no more input data or no more space in the output buffer (see below about
     409    the flush parameter).
     410
     411    Before the call of inflate(), the application should ensure that at least
     412  one of the actions is possible, by providing more input and/or consuming more
     413  output, and updating the next_* and avail_* values accordingly.  The
     414  application can consume the uncompressed output when it wants, for example
     415  when the output buffer is full (avail_out == 0), or after each call of
     416  inflate().  If inflate returns Z_OK and with zero avail_out, it must be
     417  called again after making room in the output buffer because there might be
     418  more output pending.
     419
     420    The flush parameter of inflate() can be Z_NO_FLUSH, Z_SYNC_FLUSH, Z_FINISH,
     421  Z_BLOCK, or Z_TREES. Z_SYNC_FLUSH requests that inflate() flush as much
     422  output as possible to the output buffer.  Z_BLOCK requests that inflate()
     423  stop if and when it gets to the next deflate block boundary.  When decoding
     424  the zlib or gzip format, this will cause inflate() to return immediately
     425  after the header and before the first block.  When doing a raw inflate,
     426  inflate() will go ahead and process the first block, and will return when it
     427  gets to the end of that block, or when it runs out of data.
    400428
    401429    The Z_BLOCK option assists in appending to or combining deflate streams.
    402430  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.
     431  number of unused bits in the last byte taken from strm->next_in, plus 64 if
     432  inflate() is currently decoding the last block in the deflate stream, plus
     433  128 if inflate() returned immediately after decoding an end-of-block code or
     434  decoding the complete header up to just before the first byte of the deflate
     435  stream.  The end-of-block will not be indicated until all of the uncompressed
     436  data from that block has been written to strm->next_out.  The number of
     437  unused bits may in general be greater than seven, except when bit 7 of
     438  data_type is set, in which case the number of unused bits will be less than
     439  eight.  data_type is set as noted here every time inflate() returns for all
     440  flush options, and so can be used to determine the amount of currently
     441  consumed input in bits.
     442
     443    The Z_TREES option behaves as Z_BLOCK does, but it also returns when the
     444  end of each deflate block header is reached, before any actual data in that
     445  block is decoded.  This allows the caller to determine the length of the
     446  deflate block header for later use in random access within a deflate block.
     447  256 is added to the value of strm->data_type when inflate() returns
     448  immediately after reaching the end of the deflate block header.
    412449
    413450    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.
     451  error.  However if all decompression is to be performed in a single step (a
     452  single call of inflate), the parameter flush should be set to Z_FINISH.  In
     453  this case all pending input is processed and all pending output is flushed;
     454  avail_out must be large enough to hold all the uncompressed data.  (The size
     455  of the uncompressed data may have been saved by the compressor for this
     456  purpose.) The next operation on this stream must be inflateEnd to deallocate
     457  the decompression state.  The use of Z_FINISH is never required, but can be
     458  used to inform inflate that a faster approach may be used for the single
     459  inflate() call.
    423460
    424461     In this implementation, inflate() always flushes as much output as
    425462  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
     463  first call.  So the only effect of the flush parameter in this implementation
    427464  is on the return value of inflate(), as noted below, or when it returns early
    428   because Z_BLOCK is used.
     465  because Z_BLOCK or Z_TREES is used.
    429466
    430467     If a preset dictionary is needed after this call (see inflateSetDictionary
     
    433470  strm->adler to the adler32 checksum of all output produced so far (that is,
    434471  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
     472  below.  At the end of the stream, inflate() checks that its computed adler32
    436473  checksum is equal to that saved by the compressor and returns Z_STREAM_END
    437474  only if the checksum is correct.
    438475
    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.
     476    inflate() can decompress and check either zlib-wrapped or gzip-wrapped
     477  deflate data.  The header type is detected automatically, if requested when
     478  initializing with inflateInit2().  Any information contained in the gzip
     479  header is not retained, so applications that need that information should
     480  instead use raw inflate, see inflateInit2() below, or inflateBack() and
     481  perform their own processing of the gzip header and trailer.
    445482
    446483    inflate() returns Z_OK if some progress has been made (more input processed
     
    450487  corrupted (input stream not conforming to the zlib format or incorrect check
    451488  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,
     489  next_in or next_out was Z_NULL), Z_MEM_ERROR if there was not enough memory,
    453490  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
     491  output buffer when Z_FINISH is used.  Note that Z_BUF_ERROR is not fatal, and
    455492  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.
     493  continue decompressing.  If Z_DATA_ERROR is returned, the application may
     494  then call inflateSync() to look for a good compression block if a partial
     495  recovery of the data is desired.
    459496*/
    460497
     
    463500/*
    464501     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.
     502   This function discards any unprocessed input and does not flush any pending
     503   output.
    467504
    468505     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
     506   was inconsistent.  In the error case, msg may be set but then points to a
    470507   static string (which must not be deallocated).
    471508*/
     509
    472510
    473511                        /* Advanced functions */
     
    485523                                     int  strategy));
    486524
    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.
    490 
    491      The method parameter is the compression method. It must be Z_DEFLATED in
     525     This is another version of deflateInit with more compression options.  The
     526   fields next_in, zalloc, zfree and opaque must be initialized before by the
     527   caller.
     528
     529     The method parameter is the compression method.  It must be Z_DEFLATED in
    492530   this version of the library.
    493531
    494532     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
     533   (the size of the history buffer).  It should be in the range 8..15 for this
     534   version of the library.  Larger values of this parameter result in better
     535   compression at the expense of memory usage.  The default value is 15 if
    498536   deflateInit is used instead.
    499537
    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
     538     windowBits can also be -8..-15 for raw deflate.  In this case, -windowBits
     539   determines the window size.  deflate() will then generate raw deflate data
    502540   with no zlib header or trailer, and will not compute an adler32 check value.
    503541
    504      windowBits can also be greater than 15 for optional gzip encoding. Add
     542     windowBits can also be greater than 15 for optional gzip encoding.  Add
    505543   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
     544   compressed data instead of a zlib wrapper.  The gzip header will have no
     545   file name, no extra data, no comment, no modification time (set to zero), no
     546   header crc, and the operating system will be set to 255 (unknown).  If a
    509547   gzip stream is being written, strm->adler is a crc32 instead of an adler32.
    510548
    511549     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.
    516 
    517      The strategy parameter is used to tune the compression algorithm. Use the
     550   for the internal compression state.  memLevel=1 uses minimum memory but is
     551   slow and reduces compression ratio; memLevel=9 uses maximum memory for
     552   optimal speed.  The default value is 8.  See zconf.h for total memory usage
     553   as a function of windowBits and memLevel.
     554
     555     The strategy parameter is used to tune the compression algorithm.  Use the
    518556   value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a
    519557   filter (or predictor), Z_HUFFMAN_ONLY to force Huffman encoding only (no
    520558   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
     559   encoding).  Filtered data consists mostly of small values with a somewhat
     560   random distribution.  In this case, the compression algorithm is tuned to
     561   compress them better.  The effect of Z_FILTERED is to force more Huffman
    524562   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.
    531 
    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().
     563   Z_DEFAULT_STRATEGY and Z_HUFFMAN_ONLY.  Z_RLE is designed to be almost as
     564   fast as Z_HUFFMAN_ONLY, but give better compression for PNG image data.  The
     565   strategy parameter only affects the compression ratio but not the
     566   correctness of the compressed output even if it is not set appropriately.
     567   Z_FIXED prevents the use of dynamic Huffman codes, allowing for a simpler
     568   decoder for special applications.
     569
     570     deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
     571   memory, Z_STREAM_ERROR if any parameter is invalid (such as an invalid
     572   method), or Z_VERSION_ERROR if the zlib library version (zlib_version) is
     573   incompatible with the version assumed by the caller (ZLIB_VERSION).  msg is
     574   set to null if there is no error message.  deflateInit2 does not perform any
     575   compression: this will be done by deflate().
    536576*/
    537577
     
    541581/*
    542582     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
     583   without producing any compressed output.  This function must be called
     584   immediately after deflateInit, deflateInit2 or deflateReset, before any call
     585   of deflate. The compressor and decompressor must use exactly the same
    546586   dictionary (see inflateSetDictionary).
    547587
    548588     The dictionary should consist of strings (byte sequences) that are likely
    549589   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
     590   used strings preferably put towards the end of the dictionary.  Using a
    551591   dictionary is most useful when the data to be compressed is short and can be
    552592   predicted with good accuracy; the data can then be compressed better than
     
    555595     Depending on the size of the compression data structures selected by
    556596   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.
     597   discarded, for example if the dictionary is larger than the window size
     598   provided in deflateInit or deflateInit2.  Thus the strings most likely to be
     599   useful should be put at the end of the dictionary, not at the front.  In
     600   addition, the current implementation of deflate will use at most the window
     601   size minus 262 bytes of the provided dictionary.
    562602
    563603     Upon return of this function, strm->adler is set to the adler32 value
    564604   of the dictionary; the decompressor may later use this value to determine
    565    which dictionary has been used by the compressor. (The adler32 value
     605   which dictionary has been used by the compressor.  (The adler32 value
    566606   applies to the whole dictionary even if only a subset of the dictionary is
    567607   actually used by the compressor.) If a raw deflate was requested, then the
     
    569609
    570610     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
     611   parameter is invalid (e.g.  dictionary being Z_NULL) or the stream state is
    572612   inconsistent (for example if deflate has already been called for this stream
    573    or if the compression method is bsort). deflateSetDictionary does not
     613   or if the compression method is bsort).  deflateSetDictionary does not
    574614   perform any compression: this will be done by deflate().
    575615*/
     
    582622     This function can be useful when several compression strategies will be
    583623   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
     624   data with a filter.  The streams that will be discarded should then be freed
    585625   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.
     626   compression state which can be quite large, so this strategy is slow and can
     627   consume lots of memory.
    588628
    589629     deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not
    590630   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
     631   (such as zalloc being Z_NULL). msg is left unchanged in both source and
    592632   destination.
    593633*/
     
    596636/*
    597637     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.
    601 
    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).
     638   but does not free and reallocate all the internal compression state.  The
     639   stream will keep the same compression level and any other attributes that
     640   may have been set by deflateInit2.
     641
     642     deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
     643   stream state was inconsistent (such as zalloc or state being Z_NULL).
    604644*/
    605645
     
    611651   interpretation of level and strategy is as in deflateInit2.  This can be
    612652   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().
     653   to switch to a different kind of input data requiring a different strategy.
     654   If the compression level is changed, the input available so far is
     655   compressed with the old level (and may be flushed); the new level will take
     656   effect only at the next call of deflate().
    617657
    618658     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.
     659   a call of deflate(), since the currently available input may have to be
     660   compressed and flushed. In particular, strm->avail_out must be non-zero.
    621661
    622662     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.
     663   stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR if
     664   strm->avail_out was zero.
    625665*/
    626666
     
    646686/*
    647687     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().
     688   deflation of sourceLen bytes.  It must be called after deflateInit() or
     689   deflateInit2(), and after deflateSetHeader(), if used.  This would be used
     690   to allocate an output buffer for deflation in a single pass, and so would be
     691   called before deflate().
    651692*/
    652693
     
    656697/*
    657698     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.
    664 
    665       deflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source
     699   is that this function is used to start off the deflate output with the bits
     700   leftover from a previous deflate stream when appending to it.  As such, this
     701   function can only be used for raw deflate, and must be used before the first
     702   deflate() call after a deflateInit2() or deflateReset().  bits must be less
     703   than or equal to 16, and that many of the least significant bits of value
     704  will be inserted in the output.
     705
     706     deflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source
    666707   stream state was inconsistent.
    667708*/
     
    670711                                         gz_headerp head));
    671712/*
    672       deflateSetHeader() provides gzip header information for when a gzip
     713     deflateSetHeader() provides gzip header information for when a gzip
    673714   stream is requested by deflateInit2().  deflateSetHeader() may be called
    674715   after deflateInit2() or deflateReset() and before the first call of
     
    683724   gzip file" and give up.
    684725
    685       If deflateSetHeader is not used, the default gzip header has text false,
     726     If deflateSetHeader is not used, the default gzip header has text false,
    686727   the time set to zero, and os set to 255, with no extra, name, or comment
    687728   fields.  The gzip header is returned to the default state by deflateReset().
    688729
    689       deflateSetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source
     730     deflateSetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source
    690731   stream state was inconsistent.
    691732*/
     
    695736                                     int  windowBits));
    696737
    697      This is another version of inflateInit with an extra parameter. The
     738     This is another version of inflateInit with an extra parameter.  The
    698739   fields next_in, avail_in, zalloc, zfree and opaque must be initialized
    699740   before by the caller.
     
    701742     The windowBits parameter is the base two logarithm of the maximum window
    702743   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
     744   this version of the library.  The default value is 15 if inflateInit is used
     745   instead.  windowBits must be greater than or equal to the windowBits value
    705746   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
     747   deflateInit2() was not used.  If a compressed stream with a larger window
    707748   size is given as input, inflate() will return with the error code
    708749   Z_DATA_ERROR instead of trying to allocate a larger window.
    709750
    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,
     751     windowBits can also be zero to request that inflate use the window size in
     752   the zlib header of the compressed stream.
     753
     754     windowBits can also be -8..-15 for raw inflate.  In this case, -windowBits
     755   determines the window size.  inflate() will then process raw deflate data,
    712756   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
     757   looking for any check values for comparison at the end of the stream.  This
    714758   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
     759   such as zip.  Those formats provide their own check values.  If a custom
    716760   format is developed using the raw deflate format for compressed data, it is
    717761   recommended that a check value such as an adler32 or a crc32 be applied to
    718762   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
     763   most applications, the zlib format should be used as is.  Note that comments
    720764   above on the use in deflateInit2() applies to the magnitude of windowBits.
    721765
    722      windowBits can also be greater than 15 for optional gzip decoding. Add
     766     windowBits can also be greater than 15 for optional gzip decoding.  Add
    723767   32 to windowBits to enable zlib and gzip decoding with automatic header
    724768   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.
     769   return a Z_DATA_ERROR).  If a gzip stream is being decoded, strm->adler is a
     770   crc32 instead of an adler32.
    727771
    728772     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.)
     773   memory, Z_VERSION_ERROR if the zlib library version is incompatible with the
     774   version assumed by the caller, or Z_STREAM_ERROR if the parameters are
     775   invalid, such as a null pointer to the structure.  msg is set to null if
     776   there is no error message.  inflateInit2 does not perform any decompression
     777   apart from possibly reading the zlib header if present: actual decompression
     778   will be done by inflate().  (So next_in and avail_in may be modified, but
     779   next_out and avail_out are unused and unchanged.) The current implementation
     780   of inflateInit2() does not process any header information -- that is
     781   deferred until inflate() is called.
    734782*/
    735783
     
    739787/*
    740788     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
     789   sequence.  This function must be called immediately after a call of inflate,
     790   if that call returned Z_NEED_DICT.  The dictionary chosen by the compressor
    743791   can be determined from the adler32 value returned by that call of inflate.
    744792   The compressor and decompressor must use exactly the same dictionary (see
     
    749797
    750798     inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a
    751    parameter is invalid (such as NULL dictionary) or the stream state is
     799   parameter is invalid (e.g.  dictionary being Z_NULL) or the stream state is
    752800   inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the
    753    expected one (incorrect adler32 value). inflateSetDictionary does not
     801   expected one (incorrect adler32 value).  inflateSetDictionary does not
    754802   perform any decompression: this will be done by subsequent calls of
    755803   inflate().
     
    758806ZEXTERN int ZEXPORT inflateSync OF((z_streamp strm));
    759807/*
    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.
    763 
    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.
     808     Skips invalid compressed data until a full flush point (see above the
     809   description of deflate with Z_FULL_FLUSH) can be found, or until all
     810   available input is skipped. No output is provided.
     811
     812     inflateSync returns Z_OK if a full flush point has been found, Z_BUF_ERROR
     813   if no more input was provided, Z_DATA_ERROR if no flush point has been
     814   found, or Z_STREAM_ERROR if the stream structure was inconsistent.  In the
     815   success case, the application may save the current current value of total_in
     816   which indicates where valid compressed data was found.  In the error case,
     817   the application may repeatedly call inflateSync, providing more input each
     818   time, until success or end of the input data.
    771819*/
    772820
     
    783831     inflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not
    784832   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
     833   (such as zalloc being Z_NULL). msg is left unchanged in both source and
    786834   destination.
    787835*/
     
    790838/*
    791839     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.
    794 
    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).
     840   but does not free and reallocate all the internal decompression state.  The
     841   stream will keep attributes that may have been set by inflateInit2.
     842
     843     inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
     844   stream state was inconsistent (such as zalloc or state being Z_NULL).
     845*/
     846
     847ZEXTERN int ZEXPORT inflateReset2 OF((z_streamp strm,
     848                                      int windowBits));
     849/*
     850     This function is the same as inflateReset, but it also permits changing
     851   the wrap and window size requests.  The windowBits parameter is interpreted
     852   the same as it is for inflateInit2.
     853
     854     inflateReset2 returns Z_OK if success, or Z_STREAM_ERROR if the source
     855   stream state was inconsistent (such as zalloc or state being Z_NULL), or if
     856   the windowBits parameter is invalid.
    797857*/
    798858
     
    802862/*
    803863     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.
    810 
    811       inflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source
     864   that this function is used to start inflating at a bit position in the
     865   middle of a byte.  The provided bits will be used before any bytes are used
     866   from next_in.  This function should only be used with raw inflate, and
     867   should be used before the first inflate() call after inflateInit2() or
     868   inflateReset().  bits must be less than or equal to 16, and that many of the
     869   least significant bits of value will be inserted in the input.
     870
     871     If bits is negative, then the input stream bit buffer is emptied.  Then
     872   inflatePrime() can be called again to put bits in the buffer.  This is used
     873   to clear out bits leftover after feeding inflate a block description prior
     874   to feeding inflate codes.
     875
     876     inflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source
    812877   stream state was inconsistent.
     878*/
     879
     880ZEXTERN long ZEXPORT inflateMark OF((z_streamp strm));
     881/*
     882     This function returns two values, one in the lower 16 bits of the return
     883   value, and the other in the remaining upper bits, obtained by shifting the
     884   return value down 16 bits.  If the upper value is -1 and the lower value is
     885   zero, then inflate() is currently decoding information outside of a block.
     886   If the upper value is -1 and the lower value is non-zero, then inflate is in
     887   the middle of a stored block, with the lower value equaling the number of
     888   bytes from the input remaining to copy.  If the upper value is not -1, then
     889   it is the number of bits back from the current bit position in the input of
     890   the code (literal or length/distance pair) currently being processed.  In
     891   that case the lower value is the number of bytes already emitted for that
     892   code.
     893
     894     A code is being processed if inflate is waiting for more input to complete
     895   decoding of the code, or if it has completed decoding but is waiting for
     896   more output space to write the literal or match data.
     897
     898     inflateMark() is used to mark locations in the input data for random
     899   access, which may be at bit positions, and to note those cases where the
     900   output of a code may span boundaries of random access blocks.  The current
     901   location in the input stream can be determined from avail_in and data_type
     902   as noted in the description for the Z_BLOCK flush parameter for inflate.
     903
     904     inflateMark returns the value noted above or -1 << 16 if the provided
     905   source stream state was inconsistent.
    813906*/
    814907
     
    816909                                         gz_headerp head));
    817910/*
    818       inflateGetHeader() requests that gzip header information be stored in the
     911     inflateGetHeader() requests that gzip header information be stored in the
    819912   provided gz_header structure.  inflateGetHeader() may be called after
    820913   inflateInit2() or inflateReset(), and before the first call of inflate().
     
    822915   is completed, at which time head->done is set to one.  If a zlib stream is
    823916   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.
    827 
    828       The text, time, xflags, and os fields are filled in with the gzip header
     917   no gzip header information forthcoming.  Note that Z_BLOCK or Z_TREES can be
     918   used to force inflate() to return immediately after header processing is
     919   complete and before any actual data is decompressed.
     920
     921     The text, time, xflags, and os fields are filled in with the gzip header
    829922   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
     923   was valid if done is set to one.) If extra is not Z_NULL, then extra_max
    831924   contains the maximum number of bytes to write to extra.  Once done is true,
    832925   extra_len contains the actual extra field length, and extra contains the
     
    835928   terminated with a zero unless the length is greater than name_max.  If
    836929   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
     930   terminated with a zero unless the length is greater than comm_max.  When any
     931   of extra, name, or comment are not Z_NULL and the respective field is not
     932   present in the header, then that field is set to Z_NULL to signal its
    840933   absence.  This allows the use of deflateSetHeader() with the returned
    841934   structure to duplicate the header.  However if those fields are set to
     
    843936   elsewhere so that they can be eventually freed.
    844937
    845       If inflateGetHeader is not used, then the header information is simply
     938     If inflateGetHeader is not used, then the header information is simply
    846939   discarded.  The header is always checked for validity, including the header
    847940   CRC if present.  inflateReset() will reset the process to discard the header
     
    849942   retrieve the header from the next gzip stream.
    850943
    851       inflateGetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source
     944     inflateGetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source
    852945   stream state was inconsistent.
    853946*/
     
    870963
    871964     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.
     965   the paramaters are invalid, Z_MEM_ERROR if the internal state could not be
     966   allocated, or Z_VERSION_ERROR if the version of the library does not match
     967   the version of the header file.
    875968*/
    876969
     
    892985   and to initialize the state with the user-provided window buffer.
    893986   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.
     987   deflate stream with each call.  inflateBackEnd() is then called to free the
     988   allocated state.
    896989
    897990     A raw deflate stream is one with no zlib or gzip header or trailer.
    898991   This routine would normally be used in a utility that reads zip or gzip
    899992   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
     993   header and process the trailer on its own, hence this routine expects only
     994   the raw deflate stream to decompress.  This is different from the normal
     995   behavior of inflate(), which expects either a zlib or gzip header and
    903996   trailer around the deflate stream.
    904997
     
    9261019   immediately for input.  If strm->next_in is not Z_NULL, then strm->avail_in
    9271020   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].
     1021   initially be taken from strm->next_in[0 ..  strm->avail_in - 1].
    9291022
    9301023     The in_desc and out_desc parameters of inflateBack() is passed as the
     
    9361029   pass back any unused input that was provided by the last in() call.  The
    9371030   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.
     1031   if in() or out() returned an error, Z_DATA_ERROR if there was a format error
     1032   in the deflate stream (in which case strm->msg is set to indicate the nature
     1033   of the error), or Z_STREAM_ERROR if the stream was not properly initialized.
     1034   In the case of Z_BUF_ERROR, an input or output error can be distinguished
     1035   using strm->next_in which will be Z_NULL only if in() returned an error.  If
     1036   strm->next_in is not Z_NULL, then the Z_BUF_ERROR was due to out() returning
     1037   non-zero.  (in() will always be called before out(), so strm->next_in is
     1038   assured to be defined if out() returns non-zero.) Note that inflateBack()
     1039   cannot return Z_OK.
    9471040*/
    9481041
     
    10001093
    10011094/*
    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.
     1095     The following utility functions are implemented on top of the basic
     1096   stream-oriented functions.  To simplify the interface, some default options
     1097   are assumed (compression level and memory usage, standard memory allocation
     1098   functions).  The source code of these utility functions can be modified if
     1099   you need special options.
    10071100*/
    10081101
     
    10111104/*
    10121105     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
     1106   the byte length of the source buffer.  Upon entry, destLen is the total size
     1107   of the destination buffer, which must be at least the value returned by
     1108   compressBound(sourceLen). Upon exit, destLen is the actual size of the
    10161109   compressed buffer.
    1017      This function can be used to compress a whole file at once if the
    1018    input file is mmap'ed.
     1110
    10191111     compress returns Z_OK if success, Z_MEM_ERROR if there was not
    10201112   enough memory, Z_BUF_ERROR if there was not enough room in the output
     
    10261118                                  int level));
    10271119/*
    1028      Compresses the source buffer into the destination buffer. The level
     1120     Compresses the source buffer into the destination buffer.  The level
    10291121   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
     1122   length of the source buffer.  Upon entry, destLen is the total size of the
    10311123   destination buffer, which must be at least the value returned by
    1032    compressBound(sourceLen). Upon exit, destLen is the actual size of the
     1124   compressBound(sourceLen).  Upon exit, destLen is the actual size of the
    10331125   compressed buffer.
    10341126
     
    10411133/*
    10421134     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.
     1135   compress() or compress2() on sourceLen bytes.  It would be used before a
     1136   compress() or compress2() call to allocate the destination buffer.
    10451137*/
    10461138
     
    10491141/*
    10501142     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.
     1143   the byte length of the source buffer.  Upon entry, destLen is the total size
     1144   of the destination buffer, which must be large enough to hold the entire
     1145   uncompressed data.  (The size of the uncompressed data must have been saved
     1146   previously by the compressor and transmitted to the decompressor by some
     1147   mechanism outside the scope of this compression library.) Upon exit, destLen
     1148   is the actual size of the uncompressed buffer.
    10591149
    10601150     uncompress returns Z_OK if success, Z_MEM_ERROR if there was not
     
    10641154
    10651155
    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.)
     1156                        /* gzip file access functions */
     1157
     1158/*
     1159     This library supports reading and writing files in gzip (.gz) format with
     1160   an interface similar to that of stdio, using the functions that start with
     1161   "gz".  The gzip format is different from the zlib format.  gzip is a gzip
     1162   wrapper, documented in RFC 1952, wrapped around a deflate stream.
     1163*/
     1164
     1165typedef voidp gzFile;       /* opaque gzip file descriptor */
     1166
     1167/*
     1168ZEXTERN gzFile ZEXPORT gzopen OF((const char *path, const char *mode));
     1169
     1170     Opens a gzip (.gz) file for reading or writing.  The mode parameter is as
     1171   in fopen ("rb" or "wb") but can also include a compression level ("wb9") or
     1172   a strategy: 'f' for filtered data as in "wb6f", 'h' for Huffman-only
     1173   compression as in "wb1h", 'R' for run-length encoding as in "wb1R", or 'F'
     1174   for fixed code compression as in "wb9F".  (See the description of
     1175   deflateInit2 for more information about the strategy parameter.) Also "a"
     1176   can be used instead of "w" to request that the gzip stream that will be
     1177   written be appended to the file.  "+" will result in an error, since reading
     1178   and writing to the same gzip file is not supported.
    10761179
    10771180     gzopen can be used to read a file which is not in gzip format; in this
    10781181   case gzread will directly read from the file without decompression.
    10791182
    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.
     1183     gzopen returns NULL if the file could not be opened, if there was
     1184   insufficient memory to allocate the gzFile state, or if an invalid mode was
     1185   specified (an 'r', 'w', or 'a' was not provided, or '+' was provided).
     1186   errno can be checked to determine if the reason gzopen failed was that the
     1187   file could not be opened.
     1188*/
     1189
     1190ZEXTERN gzFile ZEXPORT gzdopen OF((int fd, const char *mode));
     1191/*
     1192     gzdopen associates a gzFile with the file descriptor fd.  File descriptors
     1193   are obtained from calls like open, dup, creat, pipe or fileno (if the file
     1194   has been previously opened with fopen).  The mode parameter is as in gzopen.
     1195
     1196     The next call of gzclose on the returned gzFile will also close the file
     1197   descriptor fd, just like fclose(fdopen(fd, mode)) closes the file descriptor
     1198   fd.  If you want to keep fd open, use fd = dup(fd_keep); gz = gzdopen(fd,
     1199   mode);.  The duplicated descriptor should be saved to avoid a leak, since
     1200   gzdopen does not close fd if it fails.
     1201
     1202     gzdopen returns NULL if there was insufficient memory to allocate the
     1203   gzFile state, if an invalid mode was specified (an 'r', 'w', or 'a' was not
     1204   provided, or '+' was provided), or if fd is -1.  The file descriptor is not
     1205   used until the next gz* read, write, seek, or close operation, so gzdopen
     1206   will not detect if fd is invalid (unless fd is -1).
     1207*/
     1208
     1209ZEXTERN int ZEXPORT gzbuffer OF((gzFile file, unsigned size));
     1210/*
     1211     Set the internal buffer size used by this library's functions.  The
     1212   default buffer size is 8192 bytes.  This function must be called after
     1213   gzopen() or gzdopen(), and before any other calls that read or write the
     1214   file.  The buffer memory allocation is always deferred to the first read or
     1215   write.  Two buffers are allocated, either both of the specified size when
     1216   writing, or one of the specified size and the other twice that size when
     1217   reading.  A larger buffer size of, for example, 64K or 128K bytes will
     1218   noticeably increase the speed of decompression (reading).
     1219
     1220     The new buffer size also affects the maximum length for gzprintf().
     1221
     1222     gzbuffer() returns 0 on success, or -1 on failure, such as being called
     1223   too late.
    10961224*/
    10971225
    10981226ZEXTERN int ZEXPORT gzsetparams OF((gzFile file, int level, int strategy));
    10991227/*
    1100      Dynamically update the compression level or strategy. See the description
     1228     Dynamically update the compression level or strategy.  See the description
    11011229   of deflateInit2 for the meaning of these parameters.
     1230
    11021231     gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not
    11031232   opened for writing.
    11041233*/
    11051234
    1106 ZEXTERN int ZEXPORT    gzread  OF((gzFile file, voidp buf, unsigned len));
    1107 /*
    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). */
    1113 
    1114 ZEXTERN int ZEXPORT    gzwrite OF((gzFile file,
    1115                                    voidpc buf, unsigned len));
     1235ZEXTERN int ZEXPORT gzread OF((gzFile file, voidp buf, unsigned len));
     1236/*
     1237     Reads the given number of uncompressed bytes from the compressed file.  If
     1238   the input file was not in gzip format, gzread copies the given number of
     1239   bytes into the buffer.
     1240
     1241     After reaching the end of a gzip stream in the input, gzread will continue
     1242   to read, looking for another gzip stream, or failing that, reading the rest
     1243   of the input file directly without decompression.  The entire input file
     1244   will be read if gzread is called until it returns less than the requested
     1245   len.
     1246
     1247     gzread returns the number of uncompressed bytes actually read, less than
     1248   len for end of file, or -1 for error.
     1249*/
     1250
     1251ZEXTERN int ZEXPORT gzwrite OF((gzFile file,
     1252                                voidpc buf, unsigned len));
    11161253/*
    11171254     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).
    1120 */
    1121 
    1122 ZEXTERN int ZEXPORTVA   gzprintf OF((gzFile file, const char *format, ...));
    1123 /*
    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.
     1255   gzwrite returns the number of uncompressed bytes written or 0 in case of
     1256   error.
     1257*/
     1258
     1259ZEXTERN int ZEXPORTVA gzprintf OF((gzFile file, const char *format, ...));
     1260/*
     1261     Converts, formats, and writes the arguments to the compressed file under
     1262   control of the format string, as in fprintf.  gzprintf returns the number of
     1263   uncompressed bytes actually written, or 0 in case of error.  The number of
     1264   uncompressed bytes written is limited to 8191, or one less than the buffer
     1265   size given to gzbuffer().  The caller should assure that this limit is not
     1266   exceeded.  If it is exceeded, then gzprintf() will return an error (0) with
     1267   nothing written.  In this case, there may also be a buffer overflow with
     1268   unpredictable consequences, which is possible only if zlib was compiled with
     1269   the insecure functions sprintf() or vsprintf() because the secure snprintf()
     1270   or vsnprintf() functions were not available.  This can be determined using
     1271   zlibCompileFlags().
    11331272*/
    11341273
    11351274ZEXTERN int ZEXPORT gzputs OF((gzFile file, const char *s));
    11361275/*
    1137       Writes the given null-terminated string to the compressed file, excluding
     1276     Writes the given null-terminated string to the compressed file, excluding
    11381277   the terminating null character.
    1139       gzputs returns the number of characters written, or -1 in case of error.
     1278
     1279     gzputs returns the number of characters written, or -1 in case of error.
    11401280*/
    11411281
    11421282ZEXTERN char * ZEXPORT gzgets OF((gzFile file, char *buf, int len));
    11431283/*
    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);
     1284     Reads bytes from the compressed file until len-1 characters are read, or a
     1285   newline character is read and transferred to buf, or an end-of-file
     1286   condition is encountered.  If any characters are read or if len == 1, the
     1287   string is terminated with a null character.  If no characters are read due
     1288   to an end-of-file or len < 1, then the buffer is left untouched.
     1289
     1290     gzgets returns buf which is a null-terminated string, or it returns NULL
     1291   for end-of-file or in case of error.  If there was an error, the contents at
     1292   buf are indeterminate.
     1293*/
     1294
     1295ZEXTERN int ZEXPORT gzputc OF((gzFile file, int c));
     1296/*
     1297     Writes c, converted to an unsigned char, into the compressed file.  gzputc
     1298   returns the value that was written, or -1 in case of error.
     1299*/
     1300
     1301ZEXTERN int ZEXPORT gzgetc OF((gzFile file));
     1302/*
     1303     Reads one byte from the compressed file.  gzgetc returns this byte or -1
     1304   in case of end of file or error.
     1305*/
     1306
     1307ZEXTERN int ZEXPORT gzungetc OF((int c, gzFile file));
     1308/*
     1309     Push one character back onto the stream to be read as the first character
     1310   on the next read.  At least one character of push-back is allowed.
     1311   gzungetc() returns the character pushed, or -1 on failure.  gzungetc() will
     1312   fail if c is -1, and may fail if a character has been pushed but not read
     1313   yet.  If gzungetc is used immediately after gzopen or gzdopen, at least the
     1314   output buffer size of pushed characters is allowed.  (See gzbuffer above.)
     1315   The pushed character will be discarded if the stream is repositioned with
     1316   gzseek() or gzrewind().
     1317*/
     1318
     1319ZEXTERN int ZEXPORT gzflush OF((gzFile file, int flush));
     1320/*
     1321     Flushes all pending output into the compressed file.  The parameter flush
     1322   is as in the deflate() function.  The return value is the zlib error number
     1323   (see function gzerror below).  gzflush is only permitted when writing.
     1324
     1325     If the flush parameter is Z_FINISH, the remaining data is written and the
     1326   gzip stream is completed in the output.  If gzwrite() is called again, a new
     1327   gzip stream will be started in the output.  gzread() is able to read such
     1328   concatented gzip streams.
     1329
     1330     gzflush should be called only when strictly necessary because it will
     1331   degrade compression if called too often.
     1332*/
     1333
     1334/*
     1335ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile file,
     1336                                   z_off_t offset, int whence));
     1337
     1338     Sets the starting position for the next gzread or gzwrite on the given
     1339   compressed file.  The offset represents a number of bytes in the
     1340   uncompressed data stream.  The whence parameter is defined as in lseek(2);
    11891341   the value SEEK_END is not supported.
     1342
    11901343     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
     1344   extremely slow.  If the file is opened for writing, only forward seeks are
    11921345   supported; gzseek then compresses a sequence of zeroes up to the new
    11931346   starting position.
    11941347
    1195       gzseek returns the resulting offset location as measured in bytes from
     1348     gzseek returns the resulting offset location as measured in bytes from
    11961349   the beginning of the uncompressed stream, or -1 in case of error, in
    11971350   particular if the file is opened for writing and the new starting position
     
    12031356     Rewinds the given file. This function is supported only for reading.
    12041357
    1205    gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET)
    1206 */
    1207 
     1358     gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET)
     1359*/
     1360
     1361/*
    12081362ZEXTERN z_off_t ZEXPORT    gztell OF((gzFile file));
    1209 /*
    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.
    1213 
    1214    gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR)
     1363
     1364     Returns the starting position for the next gzread or gzwrite on the given
     1365   compressed file.  This position represents a number of bytes in the
     1366   uncompressed data stream, and is zero when starting, even if appending or
     1367   reading a gzip stream from the middle of a file using gzdopen().
     1368
     1369     gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR)
     1370*/
     1371
     1372/*
     1373ZEXTERN z_off_t ZEXPORT gzoffset OF((gzFile file));
     1374
     1375     Returns the current offset in the file being read or written.  This offset
     1376   includes the count of bytes that precede the gzip stream, for example when
     1377   appending or when using gzdopen() for reading.  When reading, the offset
     1378   does not include as yet unused buffered input.  This information can be used
     1379   for a progress indicator.  On error, gzoffset() returns -1.
    12151380*/
    12161381
    12171382ZEXTERN int ZEXPORT gzeof OF((gzFile file));
    12181383/*
    1219      Returns 1 when EOF has previously been detected reading the given
    1220    input stream, otherwise zero.
     1384     Returns true (1) if the end-of-file indicator has been set while reading,
     1385   false (0) otherwise.  Note that the end-of-file indicator is set only if the
     1386   read tried to go past the end of the input, but came up short.  Therefore,
     1387   just like feof(), gzeof() may return false even if there is no more data to
     1388   read, in the event that the last read request was for the exact number of
     1389   bytes remaining in the input file.  This will happen if the input file size
     1390   is an exact multiple of the buffer size.
     1391
     1392     If gzeof() returns true, then the read functions will return no more data,
     1393   unless the end-of-file indicator is reset by gzclearerr() and the input file
     1394   has grown since the previous end of file was detected.
    12211395*/
    12221396
    12231397ZEXTERN int ZEXPORT gzdirect OF((gzFile file));
    12241398/*
    1225      Returns 1 if file is being read directly without decompression, otherwise
    1226    zero.
     1399     Returns true (1) if file is being copied directly while reading, or false
     1400   (0) if file is a gzip stream being decompressed.  This state can change from
     1401   false to true while reading the input file if the end of a gzip stream is
     1402   reached, but is followed by data that is not another gzip stream.
     1403
     1404     If the input file is empty, gzdirect() will return true, since the input
     1405   does not contain a gzip stream.
     1406
     1407     If gzdirect() is used immediately after gzopen() or gzdopen() it will
     1408   cause buffers to be allocated to allow reading the file to determine if it
     1409   is a gzip file.  Therefore if gzbuffer() is used, it should be called before
     1410   gzdirect().
    12271411*/
    12281412
    12291413ZEXTERN int ZEXPORT    gzclose OF((gzFile file));
    12301414/*
    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).
     1415     Flushes all pending output if necessary, closes the compressed file and
     1416   deallocates the (de)compression state.  Note that once file is closed, you
     1417   cannot call gzerror with file, since its structures have been deallocated.
     1418   gzclose must not be called more than once on the same file, just as free
     1419   must not be called more than once on the same allocation.
     1420
     1421     gzclose will return Z_STREAM_ERROR if file is not valid, Z_ERRNO on a
     1422   file operation error, or Z_OK on success.
     1423*/
     1424
     1425ZEXTERN int ZEXPORT gzclose_r OF((gzFile file));
     1426ZEXTERN int ZEXPORT gzclose_w OF((gzFile file));
     1427/*
     1428     Same as gzclose(), but gzclose_r() is only for use when reading, and
     1429   gzclose_w() is only for use when writing or appending.  The advantage to
     1430   using these instead of gzclose() is that they avoid linking in zlib
     1431   compression or decompression code that is not used when only reading or only
     1432   writing respectively.  If gzclose() is used, then both compression and
     1433   decompression code will be included the application when linking to a static
     1434   zlib library.
    12341435*/
    12351436
    12361437ZEXTERN const char * ZEXPORT gzerror OF((gzFile file, int *errnum));
    12371438/*
    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.
     1439     Returns the error message for the last error which occurred on the given
     1440   compressed file.  errnum is set to zlib error number.  If an error occurred
     1441   in the file system and not in the compression library, errnum is set to
     1442   Z_ERRNO and the application may consult errno to get the exact error code.
     1443
     1444     The application must not modify the returned string.  Future calls to
     1445   this function may invalidate the previously returned string.  If file is
     1446   closed, then the string previously returned by gzerror will no longer be
     1447   available.
     1448
     1449     gzerror() should be used to distinguish errors from end-of-file for those
     1450   functions above that do not distinguish those cases in their return values.
    12431451*/
    12441452
    12451453ZEXTERN void ZEXPORT gzclearerr OF((gzFile file));
    12461454/*
    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
     1455     Clears the error and end-of-file flags for file.  This is analogous to the
     1456   clearerr() function in stdio.  This is useful for continuing to read a gzip
    12491457   file that is being written concurrently.
    12501458*/
    12511459
     1460
    12521461                        /* checksum functions */
    12531462
    12541463/*
    12551464     These functions are not related to compression but are exported
    1256    anyway because they might be useful in applications using the
    1257    compression library.
     1465   anyway because they might be useful in applications using the compression
     1466   library.
    12581467*/
    12591468
     
    12611470/*
    12621471     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:
     1472   return the updated checksum.  If buf is Z_NULL, this function returns the
     1473   required initial value for the checksum.
     1474
     1475     An Adler-32 checksum is almost as reliable as a CRC32 but can be computed
     1476   much faster.
     1477
     1478   Usage example:
    12671479
    12681480     uLong adler = adler32(0L, Z_NULL, 0);
     
    12741486*/
    12751487
     1488/*
    12761489ZEXTERN uLong ZEXPORT adler32_combine OF((uLong adler1, uLong adler2,
    12771490                                          z_off_t len2));
    1278 /*
     1491
    12791492     Combine two Adler-32 checksums into one.  For two sequences of bytes, seq1
    12801493   and seq2 with lengths len1 and len2, Adler-32 checksums were calculated for
     
    12861499/*
    12871500     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
    1290    performed within this function so it shouldn't be done by the application.
     1501   updated CRC-32.  If buf is Z_NULL, this function returns the required
     1502   initial value for the for the crc.  Pre- and post-conditioning (one's
     1503   complement) is performed within this function so it shouldn't be done by the
     1504   application.
     1505
    12911506   Usage example:
    12921507
     
    12991514*/
    13001515
     1516/*
    13011517ZEXTERN uLong ZEXPORT crc32_combine OF((uLong crc1, uLong crc2, z_off_t len2));
    13021518
    1303 /*
    13041519     Combine two CRC-32 check values into one.  For two sequences of bytes,
    13051520   seq1 and seq2 with lengths len1 and len2, CRC-32 check values were
     
    13401555#define inflateBackInit(strm, windowBits, window) \
    13411556        inflateBackInit_((strm), (windowBits), (window), \
    1342         ZLIB_VERSION, sizeof(z_stream))
    1343 
     1557                                            ZLIB_VERSION, sizeof(z_stream))
     1558
     1559#ifdef _LARGEFILE64_SOURCE
     1560   ZEXTERN gzFile ZEXPORT gzopen64 OF((const char *, const char *));
     1561   ZEXTERN off64_t ZEXPORT gzseek64 OF((gzFile, off64_t, int));
     1562   ZEXTERN off64_t ZEXPORT gztell64 OF((gzFile));
     1563   ZEXTERN off64_t ZEXPORT gzoffset64 OF((gzFile));
     1564   ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, off64_t));
     1565   ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, off64_t));
     1566#endif
     1567
     1568#if !defined(ZLIB_INTERNAL) && _FILE_OFFSET_BITS == 64
     1569#  define gzopen gzopen64
     1570#  define gzseek gzseek64
     1571#  define gztell gztell64
     1572#  define gzoffset gzoffset64
     1573#  define adler32_combine adler32_combine64
     1574#  define crc32_combine crc32_combine64
     1575#  ifndef _LARGEFILE64_SOURCE
     1576     ZEXTERN gzFile ZEXPORT gzopen64 OF((const char *, const char *));
     1577     ZEXTERN off_t ZEXPORT gzseek64 OF((gzFile, off_t, int));
     1578     ZEXTERN off_t ZEXPORT gztell64 OF((gzFile));
     1579     ZEXTERN off_t ZEXPORT gzoffset64 OF((gzFile));
     1580     ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, off_t));
     1581     ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, off_t));
     1582#  endif
     1583#else
     1584   ZEXTERN gzFile ZEXPORT gzopen OF((const char *, const char *));
     1585   ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile, z_off_t, int));
     1586   ZEXTERN z_off_t ZEXPORT gztell OF((gzFile));
     1587   ZEXTERN z_off_t ZEXPORT gzoffset OF((gzFile));
     1588   ZEXTERN uLong ZEXPORT adler32_combine OF((uLong, uLong, z_off_t));
     1589   ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t));
     1590#endif
    13441591
    13451592#if !defined(ZUTIL_H) && !defined(NO_DUMMY_DECL)
     
    13481595
    13491596ZEXTERN const char   * ZEXPORT zError           OF((int));
    1350 ZEXTERN int            ZEXPORT inflateSyncPoint OF((z_streamp z));
     1597ZEXTERN int            ZEXPORT inflateSyncPoint OF((z_streamp));
    13511598ZEXTERN const uLongf * ZEXPORT get_crc_table    OF((void));
     1599ZEXTERN int            ZEXPORT inflateUndermine OF((z_streamp, int));
    13521600
    13531601#ifdef __cplusplus
  • cpukit/zlib/zutil.h

    r416fb2ba r94a2ecc  
    11/* zutil.h -- internal interface and configuration of the compression library
    2  * Copyright (C) 1995-2005 Jean-loup Gailly.
     2 * Copyright (C) 1995-2010 Jean-loup Gailly.
    33 * For conditions of distribution and use, see copyright notice in zlib.h
    44 */
     
    1818
    1919#ifdef STDC
    20 #  ifndef _WIN32_WCE
     20#  if !(defined(_WIN32_WCE) && defined(_MSC_VER))
    2121#    include <stddef.h>
    2222#  endif
     
    2424#  include <stdlib.h>
    2525#endif
    26 #ifdef NO_ERRNO_H
    27 #   ifdef _WIN32_WCE
    28       /* The Microsoft C Run-Time Library for Windows CE doesn't have
    29        * errno.  We define it as a global variable to simplify porting.
    30        * Its value is always 0 and should not be used.  We rename it to
    31        * avoid conflict with other libraries that use the same workaround.
    32        */
    33 #     define errno z_errno
    34 #   endif
    35     extern int errno;
    36 #else
    37 #  ifndef _WIN32_WCE
     26
     27#if defined(UNDER_CE) && defined(NO_ERRNO_H)
     28#  define zseterrno(ERR) SetLastError((DWORD)(ERR))
     29#  define zerrno() ((int)GetLastError())
     30#else
     31#  ifdef NO_ERRNO_H
     32     extern int errno;
     33#  else
    3834#    include <errno.h>
    3935#  endif
     36#  define zseterrno(ERR) do { errno = (ERR); } while (0)
     37#  define zerrno() errno
    4038#endif
    4139
     
    9088#  define OS_CODE  0x00
    9189#  if defined(__TURBOC__) || defined(__BORLANDC__)
    92 #    if(__STDC__ == 1) && (defined(__LARGE__) || defined(__COMPACT__))
     90#    if (__STDC__ == 1) && (defined(__LARGE__) || defined(__COMPACT__))
    9391       /* Allow compilation with ANSI keywords only enabled */
    9492       void _Cdecl farfree( void *block );
     
    119117#  define OS_CODE  0x06
    120118#  ifdef M_I86
    121      #include <malloc.h>
     119#    include <malloc.h>
    122120#  endif
    123121#endif
     
    152150#endif
    153151
    154 #if (defined(_MSC_VER) && (_MSC_VER > 600))
     152#if (defined(_MSC_VER) && (_MSC_VER > 600)) && !defined __INTERIX
    155153#  if defined(_WIN32_WCE)
    156154#    define fdopen(fd,mode) NULL /* No fdopen() */
     
    164162#endif
    165163
     164#if defined(__BORLANDC__)
     165  #pragma warn -8004
     166  #pragma warn -8008
     167  #pragma warn -8066
     168#endif
     169
     170#ifdef _LARGEFILE64_SOURCE
     171#  define z_off64_t off64_t
     172#else
     173#  define z_off64_t z_off_t
     174#endif
     175
    166176        /* common defaults */
    167177
     
    172182#ifndef F_OPEN
    173183#  define F_OPEN(name, mode) fopen((name), (mode))
     184#endif
     185
     186#ifdef _LARGEFILE64_SOURCE
     187#  define F_OPEN64(name, mode) fopen64((name), (mode))
     188#else
     189#  define F_OPEN64(name, mode) fopen((name), (mode))
    174190#endif
    175191
     
    198214     /* In Win32, vsnprintf is available as the "non-ANSI" _vsnprintf. */
    199215#    if !defined(vsnprintf) && !defined(NO_vsnprintf)
    200 #      define vsnprintf _vsnprintf
     216#      if !defined(_MSC_VER) || ( defined(_MSC_VER) && _MSC_VER < 1500 )
     217#         define vsnprintf _vsnprintf
     218#      endif
    201219#    endif
    202220#  endif
Note: See TracChangeset for help on using the changeset viewer.