ZLIB.H
上传用户:wep9318
上传日期:2007-01-07
资源大小:893k
文件大小:36k
源码类别:

图片显示

开发平台:

Visual C++

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