zlib.h
上传用户:zhongxx05
上传日期:2007-06-06
资源大小:33641k
文件大小:41k
源码类别:

Symbian

开发平台:

C/C++

  1. /* zlib.h -- interface of the 'zlib' general purpose compression library
  2.   version 1.1.4, March 11th, 2002
  3.   Copyright (C) 1995-2002 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 ftp://ds.internic.net/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.1.4"
  30. /* 
  31.      The 'zlib' compression library provides in-memory compression and
  32.   decompression functions, including integrity checks of the uncompressed
  33.   data.  This version of the library supports only one compression method
  34.   (deflation) but other algorithms will be added later and will have the same
  35.   stream interface.
  36.      Compression can be done in a single step if the buffers are large
  37.   enough (for example if an input file is mmap'ed), or can be done by
  38.   repeated calls of the compression function.  In the latter case, the
  39.   application must provide more input and/or consume the output
  40.   (providing more output space) before each call.
  41.      The library also supports reading and writing files in gzip (.gz) format
  42.   with an interface similar to that of stdio.
  43.      The library does not install any signal handler. The decoder checks
  44.   the consistency of the compressed data, so the library should never
  45.   crash even in case of corrupted input.
  46. */
  47. typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size));
  48. typedef void   (*free_func)  OF((voidpf opaque, voidpf address));
  49. struct internal_state;
  50. typedef struct z_stream_s {
  51.     Bytef    *next_in;  /* next input byte */
  52.     uInt     avail_in;  /* number of bytes available at next_in */
  53.     uLong    total_in;  /* total nb of input bytes read so far */
  54.     Bytef    *next_out; /* next output byte should be put there */
  55.     uInt     avail_out; /* remaining free space at next_out */
  56.     uLong    total_out; /* total nb of bytes output so far */
  57.     char     *msg;      /* last error message, NULL if no error */
  58.     struct internal_state FAR *state; /* not visible by applications */
  59.     alloc_func zalloc;  /* used to allocate the internal state */
  60.     free_func  zfree;   /* used to free the internal state */
  61.     voidpf     opaque;  /* private data object passed to zalloc and zfree */
  62.     int     data_type;  /* best guess about the data type: ascii or binary */
  63.     uLong   adler;      /* adler32 value of the uncompressed data */
  64.     uLong   reserved;   /* reserved for future use */
  65. } z_stream;
  66. typedef z_stream FAR *z_streamp;
  67. /*
  68.    The application must update next_in and avail_in when avail_in has
  69.    dropped to zero. It must update next_out and avail_out when avail_out
  70.    has dropped to zero. The application must initialize zalloc, zfree and
  71.    opaque before calling the init function. All other fields are set by the
  72.    compression library and must not be updated by the application.
  73.    The opaque value provided by the application will be passed as the first
  74.    parameter for calls of zalloc and zfree. This can be useful for custom
  75.    memory management. The compression library attaches no meaning to the
  76.    opaque value.
  77.    zalloc must return Z_NULL if there is not enough memory for the object.
  78.    If zlib is used in a multi-threaded application, zalloc and zfree must be
  79.    thread safe.
  80.    On 16-bit systems, the functions zalloc and zfree must be able to allocate
  81.    exactly 65536 bytes, but will not be required to allocate more than this
  82.    if the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS,
  83.    pointers returned by zalloc for objects of exactly 65536 bytes *must*
  84.    have their offset normalized to zero. The default allocation function
  85.    provided by this library ensures this (see zutil.c). To reduce memory
  86.    requirements and avoid any allocation of 64K objects, at the expense of
  87.    compression ratio, compile the library with -DMAX_WBITS=14 (see zconf.h).
  88.    The fields total_in and total_out can be used for statistics or
  89.    progress reports. After compression, total_in holds the total size of
  90.    the uncompressed data and may be saved for use in the decompressor
  91.    (particularly if the decompressor wants to decompress everything in
  92.    a single step).
  93. */
  94.                         /* constants */
  95. #define Z_NO_FLUSH      0
  96. #define Z_PARTIAL_FLUSH 1 /* will be removed, use Z_SYNC_FLUSH instead */
  97. #define Z_SYNC_FLUSH    2
  98. #define Z_FULL_FLUSH    3
  99. #define Z_FINISH        4
  100. /* Allowed flush values; see deflate() below for details */
  101. #define Z_OK            0
  102. #define Z_STREAM_END    1
  103. #define Z_NEED_DICT     2
  104. #define Z_ERRNO        (-1)
  105. #define Z_STREAM_ERROR (-2)
  106. #define Z_DATA_ERROR   (-3)
  107. #define Z_MEM_ERROR    (-4)
  108. #define Z_BUF_ERROR    (-5)
  109. #define Z_VERSION_ERROR (-6)
  110. /* Return codes for the compression/decompression functions. Negative
  111.  * values are errors, positive values are used for special but normal events.
  112.  */
  113. #define Z_NO_COMPRESSION         0
  114. #define Z_BEST_SPEED             1
  115. #define Z_BEST_COMPRESSION       9
  116. #define Z_DEFAULT_COMPRESSION  (-1)
  117. /* compression levels */
  118. #define Z_FILTERED            1
  119. #define Z_HUFFMAN_ONLY        2
  120. #define Z_DEFAULT_STRATEGY    0
  121. /* compression strategy; see deflateInit2() below for details */
  122. #define Z_BINARY   0
  123. #define Z_ASCII    1
  124. #define Z_UNKNOWN  2
  125. /* Possible values of the data_type field */
  126. #define Z_DEFLATED   8
  127. /* The deflate compression method (the only one supported in this version) */
  128. #define Z_NULL  0  /* for initializing zalloc, zfree, opaque */
  129. #define zlib_version zlibVersion()
  130. /* for compatibility with versions < 1.0.2 */
  131.                         /* basic functions */
  132. ZEXTERN const char * ZEXPORT zlibVersion OF((void));
  133. /* The application can compare zlibVersion and ZLIB_VERSION for consistency.
  134.    If the first character differs, the library code actually used is
  135.    not compatible with the zlib.h header file used by the application.
  136.    This check is automatically made by deflateInit and inflateInit.
  137.  */
  138. /* 
  139. ZEXTERN int ZEXPORT deflateInit OF((z_streamp strm, int level));
  140.      Initializes the internal stream state for compression. The fields
  141.    zalloc, zfree and opaque must be initialized before by the caller.
  142.    If zalloc and zfree are set to Z_NULL, deflateInit updates them to
  143.    use default allocation functions.
  144.      The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9:
  145.    1 gives best speed, 9 gives best compression, 0 gives no compression at
  146.    all (the input data is simply copied a block at a time).
  147.    Z_DEFAULT_COMPRESSION requests a default compromise between speed and
  148.    compression (currently equivalent to level 6).
  149.      deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not
  150.    enough memory, Z_STREAM_ERROR if level is not a valid compression level,
  151.    Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible
  152.    with the version assumed by the caller (ZLIB_VERSION).
  153.    msg is set to null if there is no error message.  deflateInit does not
  154.    perform any compression: this will be done by deflate().
  155. */
  156. ZEXTERN int ZEXPORT deflate OF((z_streamp strm, int flush));
  157. /*
  158.     deflate compresses as much data as possible, and stops when the input
  159.   buffer becomes empty or the output buffer becomes full. It may introduce some
  160.   output latency (reading input without producing any output) except when
  161.   forced to flush.
  162.     The detailed semantics are as follows. deflate performs one or both of the
  163.   following actions:
  164.   - Compress more input starting at next_in and update next_in and avail_in
  165.     accordingly. If not all input can be processed (because there is not
  166.     enough room in the output buffer), next_in and avail_in are updated and
  167.     processing will resume at this point for the next call of deflate().
  168.   - Provide more output starting at next_out and update next_out and avail_out
  169.     accordingly. This action is forced if the parameter flush is non zero.
  170.     Forcing flush frequently degrades the compression ratio, so this parameter
  171.     should be set only when necessary (in interactive applications).
  172.     Some output may be provided even if flush is not set.
  173.   Before the call of deflate(), the application should ensure that at least
  174.   one of the actions is possible, by providing more input and/or consuming
  175.   more output, and updating avail_in or avail_out accordingly; avail_out
  176.   should never be zero before the call. The application can consume the
  177.   compressed output when it wants, for example when the output buffer is full
  178.   (avail_out == 0), or after each call of deflate(). If deflate returns Z_OK
  179.   and with zero avail_out, it must be called again after making room in the
  180.   output buffer because there might be more output pending.
  181.     If the parameter flush is set to Z_SYNC_FLUSH, all pending output is
  182.   flushed to the output buffer and the output is aligned on a byte boundary, so
  183.   that the decompressor can get all input data available so far. (In particular
  184.   avail_in is zero after the call if enough output space has been provided
  185.   before the call.)  Flushing may degrade compression for some compression
  186.   algorithms and so it should be used only when necessary.
  187.     If flush is set to Z_FULL_FLUSH, all output is flushed as with
  188.   Z_SYNC_FLUSH, and the compression state is reset so that decompression can
  189.   restart from this point if previous compressed data has been damaged or if
  190.   random access is desired. Using Z_FULL_FLUSH too often can seriously degrade
  191.   the compression.
  192.     If deflate returns with avail_out == 0, this function must be called again
  193.   with the same value of the flush parameter and more output space (updated
  194.   avail_out), until the flush is complete (deflate returns with non-zero
  195.   avail_out).
  196.     If the parameter flush is set to Z_FINISH, pending input is processed,
  197.   pending output is flushed and deflate returns with Z_STREAM_END if there
  198.   was enough output space; if deflate returns with Z_OK, this function must be
  199.   called again with Z_FINISH and more output space (updated avail_out) but no
  200.   more input data, until it returns with Z_STREAM_END or an error. After
  201.   deflate has returned Z_STREAM_END, the only possible operations on the
  202.   stream are deflateReset or deflateEnd.
  203.   
  204.     Z_FINISH can be used immediately after deflateInit if all the compression
  205.   is to be done in a single step. In this case, avail_out must be at least
  206.   0.1% larger than avail_in plus 12 bytes.  If deflate does not return
  207.   Z_STREAM_END, then it must be called again as described above.
  208.     deflate() sets strm->adler to the adler32 checksum of all input read
  209.   so far (that is, total_in bytes).
  210.     deflate() may update data_type if it can make a good guess about
  211.   the input data type (Z_ASCII or Z_BINARY). In doubt, the data is considered
  212.   binary. This field is only for information purposes and does not affect
  213.   the compression algorithm in any manner.
  214.     deflate() returns Z_OK if some progress has been made (more input
  215.   processed or more output produced), Z_STREAM_END if all input has been
  216.   consumed and all output has been produced (only when flush is set to
  217.   Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example
  218.   if next_in or next_out was NULL), Z_BUF_ERROR if no progress is possible
  219.   (for example avail_in or avail_out was zero).
  220. */
  221. ZEXTERN int ZEXPORT deflateEnd OF((z_streamp strm));
  222. /*
  223.      All dynamically allocated data structures for this stream are freed.
  224.    This function discards any unprocessed input and does not flush any
  225.    pending output.
  226.      deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the
  227.    stream state was inconsistent, Z_DATA_ERROR if the stream was freed
  228.    prematurely (some input or output was discarded). In the error case,
  229.    msg may be set but then points to a static string (which must not be
  230.    deallocated).
  231. */
  232. /* 
  233. ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm));
  234.      Initializes the internal stream state for decompression. The fields
  235.    next_in, avail_in, zalloc, zfree and opaque must be initialized before by
  236.    the caller. If next_in is not Z_NULL and avail_in is large enough (the exact
  237.    value depends on the compression method), inflateInit determines the
  238.    compression method from the zlib header and allocates all data structures
  239.    accordingly; otherwise the allocation will be deferred to the first call of
  240.    inflate.  If zalloc and zfree are set to Z_NULL, inflateInit updates them to
  241.    use default allocation functions.
  242.      inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough
  243.    memory, Z_VERSION_ERROR if the zlib library version is incompatible with the
  244.    version assumed by the caller.  msg is set to null if there is no error
  245.    message. inflateInit does not perform any decompression apart from reading
  246.    the zlib header if present: this will be done by inflate().  (So next_in and
  247.    avail_in may be modified, but next_out and avail_out are unchanged.)
  248. */
  249. ZEXTERN int ZEXPORT inflate OF((z_streamp strm, int flush));
  250. /*
  251.     inflate decompresses as much data as possible, and stops when the input
  252.   buffer becomes empty or the output buffer becomes full. It may some
  253.   introduce some output latency (reading input without producing any output)
  254.   except when forced to flush.
  255.   The detailed semantics are as follows. inflate performs one or both of the
  256.   following actions:
  257.   - Decompress more input starting at next_in and update next_in and avail_in
  258.     accordingly. If not all input can be processed (because there is not
  259.     enough room in the output buffer), next_in is updated and processing
  260.     will resume at this point for the next call of inflate().
  261.   - Provide more output starting at next_out and update next_out and avail_out
  262.     accordingly.  inflate() provides as much output as possible, until there
  263.     is no more input data or no more space in the output buffer (see below
  264.     about the flush parameter).
  265.   Before the call of inflate(), the application should ensure that at least
  266.   one of the actions is possible, by providing more input and/or consuming
  267.   more output, and updating the next_* and avail_* values accordingly.
  268.   The application can consume the uncompressed output when it wants, for
  269.   example when the output buffer is full (avail_out == 0), or after each
  270.   call of inflate(). If inflate returns Z_OK and with zero avail_out, it
  271.   must be called again after making room in the output buffer because there
  272.   might be more output pending.
  273.     If the parameter flush is set to Z_SYNC_FLUSH, inflate flushes as much
  274.   output as possible to the output buffer. The flushing behavior of inflate is
  275.   not specified for values of the flush parameter other than Z_SYNC_FLUSH
  276.   and Z_FINISH, but the current implementation actually flushes as much output
  277.   as possible anyway.
  278.     inflate() should normally be called until it returns Z_STREAM_END or an
  279.   error. However if all decompression is to be performed in a single step
  280.   (a single call of inflate), the parameter flush should be set to
  281.   Z_FINISH. In this case all pending input is processed and all pending
  282.   output is flushed; avail_out must be large enough to hold all the
  283.   uncompressed data. (The size of the uncompressed data may have been saved
  284.   by the compressor for this purpose.) The next operation on this stream must
  285.   be inflateEnd to deallocate the decompression state. The use of Z_FINISH
  286.   is never required, but can be used to inform inflate that a faster routine
  287.   may be used for the single inflate() call.
  288.      If a preset dictionary is needed at this point (see inflateSetDictionary
  289.   below), inflate sets strm-adler to the adler32 checksum of the
  290.   dictionary chosen by the compressor and returns Z_NEED_DICT; otherwise 
  291.   it sets strm->adler to the adler32 checksum of all output produced
  292.   so far (that is, total_out bytes) and returns Z_OK, Z_STREAM_END or
  293.   an error code as described below. At the end of the stream, inflate()
  294.   checks that its computed adler32 checksum is equal to that saved by the
  295.   compressor and returns Z_STREAM_END only if the checksum is correct.
  296.     inflate() returns Z_OK if some progress has been made (more input processed
  297.   or more output produced), Z_STREAM_END if the end of the compressed data has
  298.   been reached and all uncompressed output has been produced, Z_NEED_DICT if a
  299.   preset dictionary is needed at this point, Z_DATA_ERROR if the input data was
  300.   corrupted (input stream not conforming to the zlib format or incorrect
  301.   adler32 checksum), Z_STREAM_ERROR if the stream structure was inconsistent
  302.   (for example if next_in or next_out was NULL), Z_MEM_ERROR if there was not
  303.   enough memory, Z_BUF_ERROR if no progress is possible or if there was not
  304.   enough room in the output buffer when Z_FINISH is used. In the Z_DATA_ERROR
  305.   case, the application may then call inflateSync to look for a good
  306.   compression block.
  307. */
  308. ZEXTERN int ZEXPORT inflateEnd OF((z_streamp strm));
  309. /*
  310.      All dynamically allocated data structures for this stream are freed.
  311.    This function discards any unprocessed input and does not flush any
  312.    pending output.
  313.      inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state
  314.    was inconsistent. In the error case, msg may be set but then points to a
  315.    static string (which must not be deallocated).
  316. */
  317.                         /* Advanced functions */
  318. /*
  319.     The following functions are needed only in some special applications.
  320. */
  321. /*   
  322. ZEXTERN int ZEXPORT deflateInit2 OF((z_streamp strm,
  323.                                      int  level,
  324.                                      int  method,
  325.                                      int  windowBits,
  326.                                      int  memLevel,
  327.                                      int  strategy));
  328.      This is another version of deflateInit with more compression options. The
  329.    fields next_in, zalloc, zfree and opaque must be initialized before by
  330.    the caller.
  331.      The method parameter is the compression method. It must be Z_DEFLATED in
  332.    this version of the library.
  333.      The windowBits parameter is the base two logarithm of the window size
  334.    (the size of the history buffer).  It should be in the range 8..15 for this
  335.    version of the library. Larger values of this parameter result in better
  336.    compression at the expense of memory usage. The default value is 15 if
  337.    deflateInit is used instead.
  338.      The memLevel parameter specifies how much memory should be allocated
  339.    for the internal compression state. memLevel=1 uses minimum memory but
  340.    is slow and reduces compression ratio; memLevel=9 uses maximum memory
  341.    for optimal speed. The default value is 8. See zconf.h for total memory
  342.    usage as a function of windowBits and memLevel.
  343.      The strategy parameter is used to tune the compression algorithm. Use the
  344.    value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a
  345.    filter (or predictor), or Z_HUFFMAN_ONLY to force Huffman encoding only (no
  346.    string match).  Filtered data consists mostly of small values with a
  347.    somewhat random distribution. In this case, the compression algorithm is
  348.    tuned to compress them better. The effect of Z_FILTERED is to force more
  349.    Huffman coding and less string matching; it is somewhat intermediate
  350.    between Z_DEFAULT and Z_HUFFMAN_ONLY. The strategy parameter only affects
  351.    the compression ratio but not the correctness of the compressed output even
  352.    if it is not set appropriately.
  353.       deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
  354.    memory, Z_STREAM_ERROR if a parameter is invalid (such as an invalid
  355.    method). msg is set to null if there is no error message.  deflateInit2 does
  356.    not perform any compression: this will be done by deflate().
  357. */
  358.                             
  359. ZEXTERN int ZEXPORT deflateSetDictionary OF((z_streamp strm,
  360.                                              const Bytef *dictionary,
  361.                                              uInt  dictLength));
  362. /*
  363.      Initializes the compression dictionary from the given byte sequence
  364.    without producing any compressed output. This function must be called
  365.    immediately after deflateInit, deflateInit2 or deflateReset, before any
  366.    call of deflate. The compressor and decompressor must use exactly the same
  367.    dictionary (see inflateSetDictionary).
  368.      The dictionary should consist of strings (byte sequences) that are likely
  369.    to be encountered later in the data to be compressed, with the most commonly
  370.    used strings preferably put towards the end of the dictionary. Using a
  371.    dictionary is most useful when the data to be compressed is short and can be
  372.    predicted with good accuracy; the data can then be compressed better than
  373.    with the default empty dictionary.
  374.      Depending on the size of the compression data structures selected by
  375.    deflateInit or deflateInit2, a part of the dictionary may in effect be
  376.    discarded, for example if the dictionary is larger than the window size in
  377.    deflate or deflate2. Thus the strings most likely to be useful should be
  378.    put at the end of the dictionary, not at the front.
  379.      Upon return of this function, strm->adler is set to the Adler32 value
  380.    of the dictionary; the decompressor may later use this value to determine
  381.    which dictionary has been used by the compressor. (The Adler32 value
  382.    applies to the whole dictionary even if only a subset of the dictionary is
  383.    actually used by the compressor.)
  384.      deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a
  385.    parameter is invalid (such as NULL dictionary) or the stream state is
  386.    inconsistent (for example if deflate has already been called for this stream
  387.    or if the compression method is bsort). deflateSetDictionary does not
  388.    perform any compression: this will be done by deflate().
  389. */
  390. ZEXTERN int ZEXPORT deflateCopy OF((z_streamp dest,
  391.                                     z_streamp source));
  392. /*
  393.      Sets the destination stream as a complete copy of the source stream.
  394.      This function can be useful when several compression strategies will be
  395.    tried, for example when there are several ways of pre-processing the input
  396.    data with a filter. The streams that will be discarded should then be freed
  397.    by calling deflateEnd.  Note that deflateCopy duplicates the internal
  398.    compression state which can be quite large, so this strategy is slow and
  399.    can consume lots of memory.
  400.      deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not
  401.    enough memory, Z_STREAM_ERROR if the source stream state was inconsistent
  402.    (such as zalloc being NULL). msg is left unchanged in both source and
  403.    destination.
  404. */
  405. ZEXTERN int ZEXPORT deflateReset OF((z_streamp strm));
  406. /*
  407.      This function is equivalent to deflateEnd followed by deflateInit,
  408.    but does not free and reallocate all the internal compression state.
  409.    The stream will keep the same compression level and any other attributes
  410.    that may have been set by deflateInit2.
  411.       deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
  412.    stream state was inconsistent (such as zalloc or state being NULL).
  413. */
  414. ZEXTERN int ZEXPORT deflateParams OF((z_streamp strm,
  415.       int level,
  416.       int strategy));
  417. /*
  418.      Dynamically update the compression level and compression strategy.  The
  419.    interpretation of level and strategy is as in deflateInit2.  This can be
  420.    used to switch between compression and straight copy of the input data, or
  421.    to switch to a different kind of input data requiring a different
  422.    strategy. If the compression level is changed, the input available so far
  423.    is compressed with the old level (and may be flushed); the new level will
  424.    take effect only at the next call of deflate().
  425.      Before the call of deflateParams, the stream state must be set as for
  426.    a call of deflate(), since the currently available input may have to
  427.    be compressed and flushed. In particular, strm->avail_out must be non-zero.
  428.      deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source
  429.    stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR
  430.    if strm->avail_out was zero.
  431. */
  432. /*   
  433. ZEXTERN int ZEXPORT inflateInit2 OF((z_streamp strm,
  434.                                      int  windowBits));
  435.      This is another version of inflateInit with an extra parameter. The
  436.    fields next_in, avail_in, zalloc, zfree and opaque must be initialized
  437.    before by the caller.
  438.      The windowBits parameter is the base two logarithm of the maximum window
  439.    size (the size of the history buffer).  It should be in the range 8..15 for
  440.    this version of the library. The default value is 15 if inflateInit is used
  441.    instead. If a compressed stream with a larger window size is given as
  442.    input, inflate() will return with the error code Z_DATA_ERROR instead of
  443.    trying to allocate a larger window.
  444.       inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
  445.    memory, Z_STREAM_ERROR if a parameter is invalid (such as a negative
  446.    memLevel). msg is set to null if there is no error message.  inflateInit2
  447.    does not perform any decompression apart from reading the zlib header if
  448.    present: this will be done by inflate(). (So next_in and avail_in may be
  449.    modified, but next_out and avail_out are unchanged.)
  450. */
  451. ZEXTERN int ZEXPORT inflateSetDictionary OF((z_streamp strm,
  452.                                              const Bytef *dictionary,
  453.                                              uInt  dictLength));
  454. /*
  455.      Initializes the decompression dictionary from the given uncompressed byte
  456.    sequence. This function must be called immediately after a call of inflate
  457.    if this call returned Z_NEED_DICT. The dictionary chosen by the compressor
  458.    can be determined from the Adler32 value returned by this call of
  459.    inflate. The compressor and decompressor must use exactly the same
  460.    dictionary (see deflateSetDictionary).
  461.      inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a
  462.    parameter is invalid (such as NULL dictionary) or the stream state is
  463.    inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the
  464.    expected one (incorrect Adler32 value). inflateSetDictionary does not
  465.    perform any decompression: this will be done by subsequent calls of
  466.    inflate().
  467. */
  468. ZEXTERN int ZEXPORT inflateSync OF((z_streamp strm));
  469. /* 
  470.     Skips invalid compressed data until a full flush point (see above the
  471.   description of deflate with Z_FULL_FLUSH) can be found, or until all
  472.   available input is skipped. No output is provided.
  473.     inflateSync returns Z_OK if a full flush point has been found, Z_BUF_ERROR
  474.   if no more input was provided, Z_DATA_ERROR if no flush point has been found,
  475.   or Z_STREAM_ERROR if the stream structure was inconsistent. In the success
  476.   case, the application may save the current current value of total_in which
  477.   indicates where valid compressed data was found. In the error case, the
  478.   application may repeatedly call inflateSync, providing more input each time,
  479.   until success or end of the input data.
  480. */
  481. ZEXTERN int ZEXPORT inflateReset OF((z_streamp strm));
  482. /*
  483.      This function is equivalent to inflateEnd followed by inflateInit,
  484.    but does not free and reallocate all the internal decompression state.
  485.    The stream will keep attributes that may have been set by inflateInit2.
  486.       inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
  487.    stream state was inconsistent (such as zalloc or state being NULL).
  488. */
  489.                         /* utility functions */
  490. /*
  491.      The following utility functions are implemented on top of the
  492.    basic stream-oriented functions. To simplify the interface, some
  493.    default options are assumed (compression level and memory usage,
  494.    standard memory allocation functions). The source code of these
  495.    utility functions can easily be modified if you need special options.
  496. */
  497. ZEXTERN int ZEXPORT compress OF((Bytef *dest,   uLongf *destLen,
  498.                                  const Bytef *source, uLong sourceLen));
  499. /*
  500.      Compresses the source buffer into the destination buffer.  sourceLen is
  501.    the byte length of the source buffer. Upon entry, destLen is the total
  502.    size of the destination buffer, which must be at least 0.1% larger than
  503.    sourceLen plus 12 bytes. Upon exit, destLen is the actual size of the
  504.    compressed buffer.
  505.      This function can be used to compress a whole file at once if the
  506.    input file is mmap'ed.
  507.      compress returns Z_OK if success, Z_MEM_ERROR if there was not
  508.    enough memory, Z_BUF_ERROR if there was not enough room in the output
  509.    buffer.
  510. */
  511. ZEXTERN int ZEXPORT compress2 OF((Bytef *dest,   uLongf *destLen,
  512.                                   const Bytef *source, uLong sourceLen,
  513.                                   int level));
  514. /*
  515.      Compresses the source buffer into the destination buffer. The level
  516.    parameter has the same meaning as in deflateInit.  sourceLen is the byte
  517.    length of the source buffer. Upon entry, destLen is the total size of the
  518.    destination buffer, which must be at least 0.1% larger than sourceLen plus
  519.    12 bytes. Upon exit, destLen is the actual size of the compressed buffer.
  520.      compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
  521.    memory, Z_BUF_ERROR if there was not enough room in the output buffer,
  522.    Z_STREAM_ERROR if the level parameter is invalid.
  523. */
  524. ZEXTERN int ZEXPORT uncompress OF((Bytef *dest,   uLongf *destLen,
  525.                                    const Bytef *source, uLong sourceLen));
  526. /*
  527.      Decompresses the source buffer into the destination buffer.  sourceLen is
  528.    the byte length of the source buffer. Upon entry, destLen is the total
  529.    size of the destination buffer, which must be large enough to hold the
  530.    entire uncompressed data. (The size of the uncompressed data must have
  531.    been saved previously by the compressor and transmitted to the decompressor
  532.    by some mechanism outside the scope of this compression library.)
  533.    Upon exit, destLen is the actual size of the compressed buffer.
  534.      This function can be used to decompress a whole file at once if the
  535.    input file is mmap'ed.
  536.      uncompress returns Z_OK if success, Z_MEM_ERROR if there was not
  537.    enough memory, Z_BUF_ERROR if there was not enough room in the output
  538.    buffer, or Z_DATA_ERROR if the input data was corrupted.
  539. */
  540. typedef voidp gzFile;
  541. ZEXTERN gzFile ZEXPORT gzopen  OF((const char *path, const char *mode));
  542. /*
  543.      Opens a gzip (.gz) file for reading or writing. The mode parameter
  544.    is as in fopen ("rb" or "wb") but can also include a compression level
  545.    ("wb9") or a strategy: 'f' for filtered data as in "wb6f", 'h' for
  546.    Huffman only compression as in "wb1h". (See the description
  547.    of deflateInit2 for more information about the strategy parameter.)
  548.      gzopen can be used to read a file which is not in gzip format; in this
  549.    case gzread will directly read from the file without decompression.
  550.      gzopen returns NULL if the file could not be opened or if there was
  551.    insufficient memory to allocate the (de)compression state; errno
  552.    can be checked to distinguish the two cases (if errno is zero, the
  553.    zlib error is Z_MEM_ERROR).  */
  554. ZEXTERN gzFile ZEXPORT gzdopen  OF((int fd, const char *mode));
  555. /*
  556.      gzdopen() associates a gzFile with the file descriptor fd.  File
  557.    descriptors are obtained from calls like open, dup, creat, pipe or
  558.    fileno (in the file has been previously opened with fopen).
  559.    The mode parameter is as in gzopen.
  560.      The next call of gzclose on the returned gzFile will also close the
  561.    file descriptor fd, just like fclose(fdopen(fd), mode) closes the file
  562.    descriptor fd. If you want to keep fd open, use gzdopen(dup(fd), mode).
  563.      gzdopen returns NULL if there was insufficient memory to allocate
  564.    the (de)compression state.
  565. */
  566. ZEXTERN int ZEXPORT gzsetparams OF((gzFile file, int level, int strategy));
  567. /*
  568.      Dynamically update the compression level or strategy. See the description
  569.    of deflateInit2 for the meaning of these parameters.
  570.      gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not
  571.    opened for writing.
  572. */
  573. ZEXTERN int ZEXPORT    gzread  OF((gzFile file, voidp buf, unsigned len));
  574. /*
  575.      Reads the given number of uncompressed bytes from the compressed file.
  576.    If the input file was not in gzip format, gzread copies the given number
  577.    of bytes into the buffer.
  578.      gzread returns the number of uncompressed bytes actually read (0 for
  579.    end of file, -1 for error). */
  580. ZEXTERN int ZEXPORT    gzwrite OF((gzFile file, 
  581.    const voidp buf, unsigned len));
  582. /*
  583.      Writes the given number of uncompressed bytes into the compressed file.
  584.    gzwrite returns the number of uncompressed bytes actually written
  585.    (0 in case of error).
  586. */
  587. ZEXTERN int ZEXPORTVA   gzprintf OF((gzFile file, const char *format, ...));
  588. /*
  589.      Converts, formats, and writes the args to the compressed file under
  590.    control of the format string, as in fprintf. gzprintf returns the number of
  591.    uncompressed bytes actually written (0 in case of error).
  592. */
  593. ZEXTERN int ZEXPORT gzputs OF((gzFile file, const char *s));
  594. /*
  595.       Writes the given null-terminated string to the compressed file, excluding
  596.    the terminating null character.
  597.       gzputs returns the number of characters written, or -1 in case of error.
  598. */
  599. ZEXTERN char * ZEXPORT gzgets OF((gzFile file, char *buf, int len));
  600. /*
  601.       Reads bytes from the compressed file until len-1 characters are read, or
  602.    a newline character is read and transferred to buf, or an end-of-file
  603.    condition is encountered.  The string is then terminated with a null
  604.    character.
  605.       gzgets returns buf, or Z_NULL in case of error.
  606. */
  607. ZEXTERN int ZEXPORT    gzputc OF((gzFile file, int c));
  608. /*
  609.       Writes c, converted to an unsigned char, into the compressed file.
  610.    gzputc returns the value that was written, or -1 in case of error.
  611. */
  612. ZEXTERN int ZEXPORT    gzgetc OF((gzFile file));
  613. /*
  614.       Reads one byte from the compressed file. gzgetc returns this byte
  615.    or -1 in case of end of file or error.
  616. */
  617. ZEXTERN int ZEXPORT    gzflush OF((gzFile file, int flush));
  618. /*
  619.      Flushes all pending output into the compressed file. The parameter
  620.    flush is as in the deflate() function. The return value is the zlib
  621.    error number (see function gzerror below). gzflush returns Z_OK if
  622.    the flush parameter is Z_FINISH and all output could be flushed.
  623.      gzflush should be called only when strictly necessary because it can
  624.    degrade compression.
  625. */
  626. ZEXTERN z_off_t ZEXPORT    gzseek OF((gzFile file,
  627.       z_off_t offset, int whence));
  628. /* 
  629.       Sets the starting position for the next gzread or gzwrite on the
  630.    given compressed file. The offset represents a number of bytes in the
  631.    uncompressed data stream. The whence parameter is defined as in lseek(2);
  632.    the value SEEK_END is not supported.
  633.      If the file is opened for reading, this function is emulated but can be
  634.    extremely slow. If the file is opened for writing, only forward seeks are
  635.    supported; gzseek then compresses a sequence of zeroes up to the new
  636.    starting position.
  637.       gzseek returns the resulting offset location as measured in bytes from
  638.    the beginning of the uncompressed stream, or -1 in case of error, in
  639.    particular if the file is opened for writing and the new starting position
  640.    would be before the current position.
  641. */
  642. ZEXTERN int ZEXPORT    gzrewind OF((gzFile file));
  643. /*
  644.      Rewinds the given file. This function is supported only for reading.
  645.    gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET)
  646. */
  647. ZEXTERN z_off_t ZEXPORT    gztell OF((gzFile file));
  648. /*
  649.      Returns the starting position for the next gzread or gzwrite on the
  650.    given compressed file. This position represents a number of bytes in the
  651.    uncompressed data stream.
  652.    gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR)
  653. */
  654. ZEXTERN int ZEXPORT gzeof OF((gzFile file));
  655. /*
  656.      Returns 1 when EOF has previously been detected reading the given
  657.    input stream, otherwise zero.
  658. */
  659. ZEXTERN int ZEXPORT    gzclose OF((gzFile file));
  660. /*
  661.      Flushes all pending output if necessary, closes the compressed file
  662.    and deallocates all the (de)compression state. The return value is the zlib
  663.    error number (see function gzerror below).
  664. */
  665. ZEXTERN const char * ZEXPORT gzerror OF((gzFile file, int *errnum));
  666. /*
  667.      Returns the error message for the last error which occurred on the
  668.    given compressed file. errnum is set to zlib error number. If an
  669.    error occurred in the file system and not in the compression library,
  670.    errnum is set to Z_ERRNO and the application may consult errno
  671.    to get the exact error code.
  672. */
  673.                         /* checksum functions */
  674. /*
  675.      These functions are not related to compression but are exported
  676.    anyway because they might be useful in applications using the
  677.    compression library.
  678. */
  679. ZEXTERN uLong ZEXPORT adler32 OF((uLong adler, const Bytef *buf, uInt len));
  680. /*
  681.      Update a running Adler-32 checksum with the bytes buf[0..len-1] and
  682.    return the updated checksum. If buf is NULL, this function returns
  683.    the required initial value for the checksum.
  684.    An Adler-32 checksum is almost as reliable as a CRC32 but can be computed
  685.    much faster. Usage example:
  686.      uLong adler = adler32(0L, Z_NULL, 0);
  687.      while (read_buffer(buffer, length) != EOF) {
  688.        adler = adler32(adler, buffer, length);
  689.      }
  690.      if (adler != original_adler) error();
  691. */
  692. ZEXTERN uLong ZEXPORT crc32   OF((uLong crc, const Bytef *buf, uInt len));
  693. /*
  694.      Update a running crc with the bytes buf[0..len-1] and return the updated
  695.    crc. If buf is NULL, this function returns the required initial value
  696.    for the crc. Pre- and post-conditioning (one's complement) is performed
  697.    within this function so it shouldn't be done by the application.
  698.    Usage example:
  699.      uLong crc = crc32(0L, Z_NULL, 0);
  700.      while (read_buffer(buffer, length) != EOF) {
  701.        crc = crc32(crc, buffer, length);
  702.      }
  703.      if (crc != original_crc) error();
  704. */
  705.                         /* various hacks, don't look :) */
  706. /* deflateInit and inflateInit are macros to allow checking the zlib version
  707.  * and the compiler's view of z_stream:
  708.  */
  709. ZEXTERN int ZEXPORT deflateInit_ OF((z_streamp strm, int level,
  710.                                      const char *version, int stream_size));
  711. ZEXTERN int ZEXPORT inflateInit_ OF((z_streamp strm,
  712.                                      const char *version, int stream_size));
  713. ZEXTERN int ZEXPORT deflateInit2_ OF((z_streamp strm, int  level, int  method,
  714.                                       int windowBits, int memLevel,
  715.                                       int strategy, const char *version,
  716.                                       int stream_size));
  717. ZEXTERN int ZEXPORT inflateInit2_ OF((z_streamp strm, int  windowBits,
  718.                                       const char *version, int stream_size));
  719. #define deflateInit(strm, level) 
  720.         deflateInit_((strm), (level),       ZLIB_VERSION, sizeof(z_stream))
  721. #define inflateInit(strm) 
  722.         inflateInit_((strm),                ZLIB_VERSION, sizeof(z_stream))
  723. #define deflateInit2(strm, level, method, windowBits, memLevel, strategy) 
  724.         deflateInit2_((strm),(level),(method),(windowBits),(memLevel),
  725.                       (strategy),           ZLIB_VERSION, sizeof(z_stream))
  726. #define inflateInit2(strm, windowBits) 
  727.         inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))
  728. #if !defined(_Z_UTIL_H) && !defined(NO_DUMMY_DECL)
  729.     struct internal_state {int dummy;}; /* hack for buggy compilers */
  730. #endif
  731. ZEXTERN const char   * ZEXPORT zError           OF((int err));
  732. ZEXTERN int            ZEXPORT inflateSyncPoint OF((z_streamp z));
  733. ZEXTERN const uLongf * ZEXPORT get_crc_table    OF((void));
  734. #ifdef __cplusplus
  735. }
  736. #endif
  737. #endif /* _ZLIB_H */