zlib.h
上传用户:yhdzpy8989
上传日期:2007-06-13
资源大小:13604k
文件大小:40k
源码类别:

生物技术

开发平台:

C/C++

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