zlib.h
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:65k
源码类别:

通讯编程

开发平台:

Visual C++

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