jzlib.h
上传用户:lyxiangda
上传日期:2007-01-12
资源大小:3042k
文件大小:39k
源码类别:

CA认证

开发平台:

WINDOWS

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