zlib.h
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:42k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /* $Id: zlib.h,v 1.2 1997/12/23 10:47:44 paulus Exp $ */
  2. /*
  3.  * This file is derived from zlib.h and zconf.h from the zlib-1.0.4
  4.  * distribution by Jean-loup Gailly and Mark Adler, with some additions
  5.  * by Paul Mackerras to aid in implementing Deflate compression and
  6.  * decompression for PPP packets.
  7.  */
  8. /*
  9.  *  ==FILEVERSION 971127==
  10.  *
  11.  * This marker is used by the Linux installation script to determine
  12.  * whether an up-to-date version of this file is already installed.
  13.  */
  14. /* +++ zlib.h */
  15. /* zlib.h -- interface of the 'zlib' general purpose compression library
  16.   version 1.0.4, Jul 24th, 1996.
  17.   Copyright (C) 1995-1996 Jean-loup Gailly and Mark Adler
  18.   This software is provided 'as-is', without any express or implied
  19.   warranty.  In no event will the authors be held liable for any damages
  20.   arising from the use of this software.
  21.   Permission is granted to anyone to use this software for any purpose,
  22.   including commercial applications, and to alter it and redistribute it
  23.   freely, subject to the following restrictions:
  24.   1. The origin of this software must not be misrepresented; you must not
  25.      claim that you wrote the original software. If you use this software
  26.      in a product, an acknowledgment in the product documentation would be
  27.      appreciated but is not required.
  28.   2. Altered source versions must be plainly marked as such, and must not be
  29.      misrepresented as being the original software.
  30.   3. This notice may not be removed or altered from any source distribution.
  31.   Jean-loup Gailly        Mark Adler
  32.   gzip@prep.ai.mit.edu    madler@alumni.caltech.edu
  33.   The data format used by the zlib library is described by RFCs (Request for
  34.   Comments) 1950 to 1952 in the files ftp://ds.internic.net/rfc/rfc1950.txt
  35.   (zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format).
  36. */
  37. #ifndef _ZLIB_H
  38. #define _ZLIB_H
  39. #ifdef __cplusplus
  40. extern "C" {
  41. #endif
  42. /* +++ zconf.h */
  43. /* zconf.h -- configuration of the zlib compression library
  44.  * Copyright (C) 1995-1996 Jean-loup Gailly.
  45.  * For conditions of distribution and use, see copyright notice in zlib.h 
  46.  */
  47. /* From: zconf.h,v 1.20 1996/07/02 15:09:28 me Exp $ */
  48. #ifndef _ZCONF_H
  49. #define _ZCONF_H
  50. /*
  51.  * If you *really* need a unique prefix for all types and library functions,
  52.  * compile with -DZ_PREFIX. The "standard" zlib should be compiled without it.
  53.  */
  54. #ifdef Z_PREFIX
  55. #  define deflateInit_ z_deflateInit_
  56. #  define deflate z_deflate
  57. #  define deflateEnd z_deflateEnd
  58. #  define inflateInit_  z_inflateInit_
  59. #  define inflate z_inflate
  60. #  define inflateEnd z_inflateEnd
  61. #  define deflateInit2_ z_deflateInit2_
  62. #  define deflateSetDictionary z_deflateSetDictionary
  63. #  define deflateCopy z_deflateCopy
  64. #  define deflateReset z_deflateReset
  65. #  define deflateParams z_deflateParams
  66. #  define inflateInit2_ z_inflateInit2_
  67. #  define inflateSetDictionary z_inflateSetDictionary
  68. #  define inflateSync z_inflateSync
  69. #  define inflateReset z_inflateReset
  70. #  define compress z_compress
  71. #  define uncompress z_uncompress
  72. #  define adler32 z_adler32
  73. #  define crc32 z_crc32
  74. #  define get_crc_table z_get_crc_table
  75. #  define Byte z_Byte
  76. #  define uInt z_uInt
  77. #  define uLong z_uLong
  78. #  define Bytef         z_Bytef
  79. #  define charf z_charf
  80. #  define intf z_intf
  81. #  define uIntf z_uIntf
  82. #  define uLongf z_uLongf
  83. #  define voidpf z_voidpf
  84. #  define voidp z_voidp
  85. #endif
  86. #if (defined(_WIN32) || defined(__WIN32__)) && !defined(WIN32)
  87. #  define WIN32
  88. #endif
  89. #if defined(__GNUC__) || defined(WIN32) || defined(__386__) || defined(i386)
  90. #  ifndef __32BIT__
  91. #    define __32BIT__
  92. #  endif
  93. #endif
  94. #if defined(__MSDOS__) && !defined(MSDOS)
  95. #  define MSDOS
  96. #endif
  97. /*
  98.  * Compile with -DMAXSEG_64K if the alloc function cannot allocate more
  99.  * than 64k bytes at a time (needed on systems with 16-bit int).
  100.  */
  101. #if defined(MSDOS) && !defined(__32BIT__)
  102. #  define MAXSEG_64K
  103. #endif
  104. #ifdef MSDOS
  105. #  define UNALIGNED_OK
  106. #endif
  107. #if (defined(MSDOS) || defined(_WINDOWS) || defined(WIN32))  && !defined(STDC)
  108. #  define STDC
  109. #endif
  110. #if (defined(__STDC__) || defined(__cplusplus)) && !defined(STDC)
  111. #  define STDC
  112. #endif
  113. #ifndef STDC
  114. #  ifndef const /* cannot use !defined(STDC) && !defined(const) on Mac */
  115. #    define const
  116. #  endif
  117. #endif
  118. /* Some Mac compilers merge all .h files incorrectly: */
  119. #if defined(__MWERKS__) || defined(applec) ||defined(THINK_C) ||defined(__SC__)
  120. #  define NO_DUMMY_DECL
  121. #endif
  122. /* Maximum value for memLevel in deflateInit2 */
  123. #ifndef MAX_MEM_LEVEL
  124. #  ifdef MAXSEG_64K
  125. #    define MAX_MEM_LEVEL 8
  126. #  else
  127. #    define MAX_MEM_LEVEL 9
  128. #  endif
  129. #endif
  130. /* Maximum value for windowBits in deflateInit2 and inflateInit2 */
  131. #ifndef MAX_WBITS
  132. #  define MAX_WBITS   15 /* 32K LZ77 window */
  133. #endif
  134. /* The memory requirements for deflate are (in bytes):
  135.             1 << (windowBits+2)   +  1 << (memLevel+9)
  136.  that is: 128K for windowBits=15  +  128K for memLevel = 8  (default values)
  137.  plus a few kilobytes for small objects. For example, if you want to reduce
  138.  the default memory requirements from 256K to 128K, compile with
  139.      make CFLAGS="-O -DMAX_WBITS=14 -DMAX_MEM_LEVEL=7"
  140.  Of course this will generally degrade compression (there's no free lunch).
  141.    The memory requirements for inflate are (in bytes) 1 << windowBits
  142.  that is, 32K for windowBits=15 (default value) plus a few kilobytes
  143.  for small objects.
  144. */
  145.                         /* Type declarations */
  146. #ifndef OF /* function prototypes */
  147. #  ifdef STDC
  148. #    define OF(args)  args
  149. #  else
  150. #    define OF(args)  ()
  151. #  endif
  152. #endif
  153. /* The following definitions for FAR are needed only for MSDOS mixed
  154.  * model programming (small or medium model with some far allocations).
  155.  * This was tested only with MSC; for other MSDOS compilers you may have
  156.  * to define NO_MEMCPY in zutil.h.  If you don't need the mixed model,
  157.  * just define FAR to be empty.
  158.  */
  159. #if (defined(M_I86SM) || defined(M_I86MM)) && !defined(__32BIT__)
  160.    /* MSC small or medium model */
  161. #  define SMALL_MEDIUM
  162. #  ifdef _MSC_VER
  163. #    define FAR __far
  164. #  else
  165. #    define FAR far
  166. #  endif
  167. #endif
  168. #if defined(__BORLANDC__) && (defined(__SMALL__) || defined(__MEDIUM__))
  169. #  ifndef __32BIT__
  170. #    define SMALL_MEDIUM
  171. #    define FAR __far
  172. #  endif
  173. #endif
  174. #ifndef FAR
  175. #   define FAR
  176. #endif
  177. typedef unsigned char  Byte;  /* 8 bits */
  178. typedef unsigned int   uInt;  /* 16 bits or more */
  179. typedef unsigned long  uLong; /* 32 bits or more */
  180. #if defined(__BORLANDC__) && defined(SMALL_MEDIUM)
  181.    /* Borland C/C++ ignores FAR inside typedef */
  182. #  define Bytef Byte FAR
  183. #else
  184.    typedef Byte  FAR Bytef;
  185. #endif
  186. typedef char  FAR charf;
  187. typedef int   FAR intf;
  188. typedef uInt  FAR uIntf;
  189. typedef uLong FAR uLongf;
  190. #ifdef STDC
  191.    typedef void FAR *voidpf;
  192.    typedef void     *voidp;
  193. #else
  194.    typedef Byte FAR *voidpf;
  195.    typedef Byte     *voidp;
  196. #endif
  197. /* Compile with -DZLIB_DLL for Windows DLL support */
  198. #if (defined(_WINDOWS) || defined(WINDOWS)) && defined(ZLIB_DLL)
  199. #  include <windows.h>
  200. #  define EXPORT  WINAPI
  201. #else
  202. #  define EXPORT
  203. #endif
  204. #endif /* _ZCONF_H */
  205. /* --- zconf.h */
  206. #define ZLIB_VERSION "1.0.4P"
  207. /* 
  208.      The 'zlib' compression library provides in-memory compression and
  209.   decompression functions, including integrity checks of the uncompressed
  210.   data.  This version of the library supports only one compression method
  211.   (deflation) but other algorithms may be added later and will have the same
  212.   stream interface.
  213.      For compression the application must provide the output buffer and
  214.   may optionally provide the input buffer for optimization. For decompression,
  215.   the application must provide the input buffer and may optionally provide
  216.   the output buffer for optimization.
  217.      Compression can be done in a single step if the buffers are large
  218.   enough (for example if an input file is mmap'ed), or can be done by
  219.   repeated calls of the compression function.  In the latter case, the
  220.   application must provide more input and/or consume the output
  221.   (providing more output space) before each call.
  222.      The library does not install any signal handler. It is recommended to
  223.   add at least a handler for SIGSEGV when decompressing; the library checks
  224.   the consistency of the input data whenever possible but may go nuts
  225.   for some forms of corrupted input.
  226. */
  227. typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size));
  228. typedef void   (*free_func)  OF((voidpf opaque, voidpf address));
  229. struct internal_state;
  230. typedef struct z_stream_s {
  231.     Bytef    *next_in;  /* next input byte */
  232.     uInt     avail_in;  /* number of bytes available at next_in */
  233.     uLong    total_in;  /* total nb of input bytes read so far */
  234.     Bytef    *next_out; /* next output byte should be put there */
  235.     uInt     avail_out; /* remaining free space at next_out */
  236.     uLong    total_out; /* total nb of bytes output so far */
  237.     char     *msg;      /* last error message, NULL if no error */
  238.     struct internal_state FAR *state; /* not visible by applications */
  239.     alloc_func zalloc;  /* used to allocate the internal state */
  240.     free_func  zfree;   /* used to free the internal state */
  241.     voidpf     opaque;  /* private data object passed to zalloc and zfree */
  242.     int     data_type;  /* best guess about the data type: ascii or binary */
  243.     uLong   adler;      /* adler32 value of the uncompressed data */
  244.     uLong   reserved;   /* reserved for future use */
  245. } z_stream;
  246. typedef z_stream FAR *z_streamp;
  247. /*
  248.    The application must update next_in and avail_in when avail_in has
  249.    dropped to zero. It must update next_out and avail_out when avail_out
  250.    has dropped to zero. The application must initialize zalloc, zfree and
  251.    opaque before calling the init function. All other fields are set by the
  252.    compression library and must not be updated by the application.
  253.    The opaque value provided by the application will be passed as the first
  254.    parameter for calls of zalloc and zfree. This can be useful for custom
  255.    memory management. The compression library attaches no meaning to the
  256.    opaque value.
  257.    zalloc must return Z_NULL if there is not enough memory for the object.
  258.    On 16-bit systems, the functions zalloc and zfree must be able to allocate
  259.    exactly 65536 bytes, but will not be required to allocate more than this
  260.    if the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS,
  261.    pointers returned by zalloc for objects of exactly 65536 bytes *must*
  262.    have their offset normalized to zero. The default allocation function
  263.    provided by this library ensures this (see zutil.c). To reduce memory
  264.    requirements and avoid any allocation of 64K objects, at the expense of
  265.    compression ratio, compile the library with -DMAX_WBITS=14 (see zconf.h).
  266.    The fields total_in and total_out can be used for statistics or
  267.    progress reports. After compression, total_in holds the total size of
  268.    the uncompressed data and may be saved for use in the decompressor
  269.    (particularly if the decompressor wants to decompress everything in
  270.    a single step).
  271. */
  272.                         /* constants */
  273. #define Z_NO_FLUSH      0
  274. #define Z_PARTIAL_FLUSH 1
  275. #define Z_PACKET_FLUSH 2
  276. #define Z_SYNC_FLUSH    3
  277. #define Z_FULL_FLUSH    4
  278. #define Z_FINISH        5
  279. /* Allowed flush values; see deflate() below for details */
  280. #define Z_OK            0
  281. #define Z_STREAM_END    1
  282. #define Z_NEED_DICT     2
  283. #define Z_ERRNO        (-1)
  284. #define Z_STREAM_ERROR (-2)
  285. #define Z_DATA_ERROR   (-3)
  286. #define Z_MEM_ERROR    (-4)
  287. #define Z_BUF_ERROR    (-5)
  288. #define Z_VERSION_ERROR (-6)
  289. /* Return codes for the compression/decompression functions. Negative
  290.  * values are errors, positive values are used for special but normal events.
  291.  */
  292. #define Z_NO_COMPRESSION         0
  293. #define Z_BEST_SPEED             1
  294. #define Z_BEST_COMPRESSION       9
  295. #define Z_DEFAULT_COMPRESSION  (-1)
  296. /* compression levels */
  297. #define Z_FILTERED            1
  298. #define Z_HUFFMAN_ONLY        2
  299. #define Z_DEFAULT_STRATEGY    0
  300. /* compression strategy; see deflateInit2() below for details */
  301. #define Z_BINARY   0
  302. #define Z_ASCII    1
  303. #define Z_UNKNOWN  2
  304. /* Possible values of the data_type field */
  305. #define Z_DEFLATED   8
  306. /* The deflate compression method (the only one supported in this version) */
  307. #define Z_NULL  0  /* for initializing zalloc, zfree, opaque */
  308. #define zlib_version zlibVersion()
  309. /* for compatibility with versions < 1.0.2 */
  310.                         /* basic functions */
  311. extern const char * EXPORT zlibVersion OF((void));
  312. /* The application can compare zlibVersion and ZLIB_VERSION for consistency.
  313.    If the first character differs, the library code actually used is
  314.    not compatible with the zlib.h header file used by the application.
  315.    This check is automatically made by deflateInit and inflateInit.
  316.  */
  317. /* 
  318. extern int EXPORT deflateInit OF((z_streamp strm, int level));
  319.      Initializes the internal stream state for compression. The fields
  320.    zalloc, zfree and opaque must be initialized before by the caller.
  321.    If zalloc and zfree are set to Z_NULL, deflateInit updates them to
  322.    use default allocation functions.
  323.      The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9:
  324.    1 gives best speed, 9 gives best compression, 0 gives no compression at
  325.    all (the input data is simply copied a block at a time).
  326.    Z_DEFAULT_COMPRESSION requests a default compromise between speed and
  327.    compression (currently equivalent to level 6).
  328.      deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not
  329.    enough memory, Z_STREAM_ERROR if level is not a valid compression level,
  330.    Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible
  331.    with the version assumed by the caller (ZLIB_VERSION).
  332.    msg is set to null if there is no error message.  deflateInit does not
  333.    perform any compression: this will be done by deflate().
  334. */
  335. extern int EXPORT deflate OF((z_streamp strm, int flush));
  336. /*
  337.   Performs one or both of the following actions:
  338.   - Compress more input starting at next_in and update next_in and avail_in
  339.     accordingly. If not all input can be processed (because there is not
  340.     enough room in the output buffer), next_in and avail_in are updated and
  341.     processing will resume at this point for the next call of deflate().
  342.   - Provide more output starting at next_out and update next_out and avail_out
  343.     accordingly. This action is forced if the parameter flush is non zero.
  344.     Forcing flush frequently degrades the compression ratio, so this parameter
  345.     should be set only when necessary (in interactive applications).
  346.     Some output may be provided even if flush is not set.
  347.   Before the call of deflate(), the application should ensure that at least
  348.   one of the actions is possible, by providing more input and/or consuming
  349.   more output, and updating avail_in or avail_out accordingly; avail_out
  350.   should never be zero before the call. The application can consume the
  351.   compressed output when it wants, for example when the output buffer is full
  352.   (avail_out == 0), or after each call of deflate(). If deflate returns Z_OK
  353.   and with zero avail_out, it must be called again after making room in the
  354.   output buffer because there might be more output pending.
  355.     If the parameter flush is set to Z_PARTIAL_FLUSH, the current compression
  356.   block is terminated and flushed to the output buffer so that the
  357.   decompressor can get all input data available so far. For method 9, a future
  358.   variant on method 8, the current block will be flushed but not terminated.
  359.   Z_SYNC_FLUSH has the same effect as partial flush except that the compressed
  360.   output is byte aligned (the compressor can clear its internal bit buffer)
  361.   and the current block is always terminated; this can be useful if the
  362.   compressor has to be restarted from scratch after an interruption (in which
  363.   case the internal state of the compressor may be lost).
  364.     If flush is set to Z_FULL_FLUSH, the compression block is terminated, a
  365.   special marker is output and the compression dictionary is discarded; this
  366.   is useful to allow the decompressor to synchronize if one compressed block
  367.   has been damaged (see inflateSync below).  Flushing degrades compression and
  368.   so should be used only when necessary.  Using Z_FULL_FLUSH too often can
  369.   seriously degrade the compression. If deflate returns with avail_out == 0,
  370.   this function must be called again with the same value of the flush
  371.   parameter and more output space (updated avail_out), until the flush is
  372.   complete (deflate returns with non-zero avail_out).
  373.     If the parameter flush is set to Z_PACKET_FLUSH, the compression
  374.   block is terminated, and a zero-length stored block is output,
  375.   omitting the length bytes (the effect of this is that the 3-bit type
  376.   code 000 for a stored block is output, and the output is then
  377.   byte-aligned).  This is designed for use at the end of a PPP packet.
  378.     If the parameter flush is set to Z_FINISH, pending input is processed,
  379.   pending output is flushed and deflate returns with Z_STREAM_END if there
  380.   was enough output space; if deflate returns with Z_OK, this function must be
  381.   called again with Z_FINISH and more output space (updated avail_out) but no
  382.   more input data, until it returns with Z_STREAM_END or an error. After
  383.   deflate has returned Z_STREAM_END, the only possible operations on the
  384.   stream are deflateReset or deflateEnd.
  385.   
  386.     Z_FINISH can be used immediately after deflateInit if all the compression
  387.   is to be done in a single step. In this case, avail_out must be at least
  388.   0.1% larger than avail_in plus 12 bytes.  If deflate does not return
  389.   Z_STREAM_END, then it must be called again as described above.
  390.     deflate() may update data_type if it can make a good guess about
  391.   the input data type (Z_ASCII or Z_BINARY). In doubt, the data is considered
  392.   binary. This field is only for information purposes and does not affect
  393.   the compression algorithm in any manner.
  394.     deflate() returns Z_OK if some progress has been made (more input
  395.   processed or more output produced), Z_STREAM_END if all input has been
  396.   consumed and all output has been produced (only when flush is set to
  397.   Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example
  398.   if next_in or next_out was NULL), Z_BUF_ERROR if no progress is possible.
  399. */
  400. extern int EXPORT deflateEnd OF((z_streamp strm));
  401. /*
  402.      All dynamically allocated data structures for this stream are freed.
  403.    This function discards any unprocessed input and does not flush any
  404.    pending output.
  405.      deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the
  406.    stream state was inconsistent, Z_DATA_ERROR if the stream was freed
  407.    prematurely (some input or output was discarded). In the error case,
  408.    msg may be set but then points to a static string (which must not be
  409.    deallocated).
  410. */
  411. /* 
  412. extern int EXPORT inflateInit OF((z_streamp strm));
  413.      Initializes the internal stream state for decompression. The fields
  414.    zalloc, zfree and opaque must be initialized before by the caller.  If
  415.    zalloc and zfree are set to Z_NULL, inflateInit updates them to use default
  416.    allocation functions.
  417.      inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not
  418.    enough memory, Z_VERSION_ERROR if the zlib library version is incompatible
  419.    with the version assumed by the caller.  msg is set to null if there is no
  420.    error message. inflateInit does not perform any decompression: this will be
  421.    done by inflate().
  422. */
  423. extern int EXPORT inflate OF((z_streamp strm, int flush));
  424. /*
  425.   Performs one or both of the following actions:
  426.   - Decompress more input starting at next_in and update next_in and avail_in
  427.     accordingly. If not all input can be processed (because there is not
  428.     enough room in the output buffer), next_in is updated and processing
  429.     will resume at this point for the next call of inflate().
  430.   - Provide more output starting at next_out and update next_out and avail_out
  431.     accordingly.  inflate() provides as much output as possible, until there
  432.     is no more input data or no more space in the output buffer (see below
  433.     about the flush parameter).
  434.   Before the call of inflate(), the application should ensure that at least
  435.   one of the actions is possible, by providing more input and/or consuming
  436.   more output, and updating the next_* and avail_* values accordingly.
  437.   The application can consume the uncompressed output when it wants, for
  438.   example when the output buffer is full (avail_out == 0), or after each
  439.   call of inflate(). If inflate returns Z_OK and with zero avail_out, it
  440.   must be called again after making room in the output buffer because there
  441.   might be more output pending.
  442.     If the parameter flush is set to Z_PARTIAL_FLUSH or Z_PACKET_FLUSH,
  443.   inflate flushes as much output as possible to the output buffer. The
  444.   flushing behavior of inflate is not specified for values of the flush
  445.   parameter other than Z_PARTIAL_FLUSH, Z_PACKET_FLUSH or Z_FINISH, but the
  446.   current implementation actually flushes as much output as possible
  447.   anyway.  For Z_PACKET_FLUSH, inflate checks that once all the input data
  448.   has been consumed, it is expecting to see the length field of a stored
  449.   block; if not, it returns Z_DATA_ERROR.
  450.     inflate() should normally be called until it returns Z_STREAM_END or an
  451.   error. However if all decompression is to be performed in a single step
  452.   (a single call of inflate), the parameter flush should be set to
  453.   Z_FINISH. In this case all pending input is processed and all pending
  454.   output is flushed; avail_out must be large enough to hold all the
  455.   uncompressed data. (The size of the uncompressed data may have been saved
  456.   by the compressor for this purpose.) The next operation on this stream must
  457.   be inflateEnd to deallocate the decompression state. The use of Z_FINISH
  458.   is never required, but can be used to inform inflate that a faster routine
  459.   may be used for the single inflate() call.
  460.     inflate() returns Z_OK if some progress has been made (more input
  461.   processed or more output produced), Z_STREAM_END if the end of the
  462.   compressed data has been reached and all uncompressed output has been
  463.   produced, Z_NEED_DICT if a preset dictionary is needed at this point (see
  464.   inflateSetDictionary below), Z_DATA_ERROR if the input data was corrupted,
  465.   Z_STREAM_ERROR if the stream structure was inconsistent (for example if
  466.   next_in or next_out was NULL), Z_MEM_ERROR if there was not enough memory,
  467.   Z_BUF_ERROR if no progress is possible or if there was not enough room in
  468.   the output buffer when Z_FINISH is used. In the Z_DATA_ERROR case, the
  469.   application may then call inflateSync to look for a good compression block.
  470.   In the Z_NEED_DICT case, strm->adler is set to the Adler32 value of the
  471.   dictionary chosen by the compressor.
  472. */
  473. extern int EXPORT inflateEnd OF((z_streamp strm));
  474. /*
  475.      All dynamically allocated data structures for this stream are freed.
  476.    This function discards any unprocessed input and does not flush any
  477.    pending output.
  478.      inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state
  479.    was inconsistent. In the error case, msg may be set but then points to a
  480.    static string (which must not be deallocated).
  481. */
  482.                         /* Advanced functions */
  483. /*
  484.     The following functions are needed only in some special applications.
  485. */
  486. /*   
  487. extern int EXPORT deflateInit2 OF((z_streamp strm,
  488.                                    int  level,
  489.                                    int  method,
  490.                                    int  windowBits,
  491.                                    int  memLevel,
  492.                                    int  strategy));
  493.      This is another version of deflateInit with more compression options. The
  494.    fields next_in, zalloc, zfree and opaque must be initialized before by
  495.    the caller.
  496.      The method parameter is the compression method. It must be Z_DEFLATED in
  497.    this version of the library. (Method 9 will allow a 64K history buffer and
  498.    partial block flushes.)
  499.      The windowBits parameter is the base two logarithm of the window size
  500.    (the size of the history buffer).  It should be in the range 8..15 for this
  501.    version of the library (the value 16 will be allowed for method 9). Larger
  502.    values of this parameter result in better compression at the expense of
  503.    memory usage. The default value is 15 if deflateInit is used instead.
  504.      The memLevel parameter specifies how much memory should be allocated
  505.    for the internal compression state. memLevel=1 uses minimum memory but
  506.    is slow and reduces compression ratio; memLevel=9 uses maximum memory
  507.    for optimal speed. The default value is 8. See zconf.h for total memory
  508.    usage as a function of windowBits and memLevel.
  509.      The strategy parameter is used to tune the compression algorithm. Use the
  510.    value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a
  511.    filter (or predictor), or Z_HUFFMAN_ONLY to force Huffman encoding only (no
  512.    string match).  Filtered data consists mostly of small values with a
  513.    somewhat random distribution. In this case, the compression algorithm is
  514.    tuned to compress them better. The effect of Z_FILTERED is to force more
  515.    Huffman coding and less string matching; it is somewhat intermediate
  516.    between Z_DEFAULT and Z_HUFFMAN_ONLY. The strategy parameter only affects
  517.    the compression ratio but not the correctness of the compressed output even
  518.    if it is not set appropriately.
  519.      If next_in is not null, the library will use this buffer to hold also
  520.    some history information; the buffer must either hold the entire input
  521.    data, or have at least 1<<(windowBits+1) bytes and be writable. If next_in
  522.    is null, the library will allocate its own history buffer (and leave next_in
  523.    null). next_out need not be provided here but must be provided by the
  524.    application for the next call of deflate().
  525.      If the history buffer is provided by the application, next_in must
  526.    must never be changed by the application since the compressor maintains
  527.    information inside this buffer from call to call; the application
  528.    must provide more input only by increasing avail_in. next_in is always
  529.    reset by the library in this case.
  530.       deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was
  531.    not enough memory, Z_STREAM_ERROR if a parameter is invalid (such as
  532.    an invalid method). msg is set to null if there is no error message.
  533.    deflateInit2 does not perform any compression: this will be done by
  534.    deflate(). 
  535. */
  536.                             
  537. extern int EXPORT deflateSetDictionary OF((z_streamp strm,
  538.                                            const Bytef *dictionary,
  539.            uInt  dictLength));
  540. /*
  541.      Initializes the compression dictionary (history buffer) from the given
  542.    byte sequence without producing any compressed output. This function must
  543.    be called immediately after deflateInit or deflateInit2, before any call
  544.    of deflate. The compressor and decompressor must use exactly the same
  545.    dictionary (see inflateSetDictionary).
  546.      The dictionary should consist of strings (byte sequences) that are likely
  547.    to be encountered later in the data to be compressed, with the most commonly
  548.    used strings preferably put towards the end of the dictionary. Using a
  549.    dictionary is most useful when the data to be compressed is short and
  550.    can be predicted with good accuracy; the data can then be compressed better
  551.    than with the default empty dictionary. In this version of the library,
  552.    only the last 32K bytes of the dictionary are used.
  553.      Upon return of this function, strm->adler is set to the Adler32 value
  554.    of the dictionary; the decompressor may later use this value to determine
  555.    which dictionary has been used by the compressor. (The Adler32 value
  556.    applies to the whole dictionary even if only a subset of the dictionary is
  557.    actually used by the compressor.)
  558.      deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a
  559.    parameter is invalid (such as NULL dictionary) or the stream state
  560.    is inconsistent (for example if deflate has already been called for this
  561.    stream). deflateSetDictionary does not perform any compression: this will
  562.    be done by deflate(). 
  563. */
  564. extern int EXPORT deflateCopy OF((z_streamp dest,
  565.                                   z_streamp source));
  566. /*
  567.      Sets the destination stream as a complete copy of the source stream.  If
  568.    the source stream is using an application-supplied history buffer, a new
  569.    buffer is allocated for the destination stream.  The compressed output
  570.    buffer is always application-supplied. It's the responsibility of the
  571.    application to provide the correct values of next_out and avail_out for the
  572.    next call of deflate.
  573.      This function can be useful when several compression strategies will be
  574.    tried, for example when there are several ways of pre-processing the input
  575.    data with a filter. The streams that will be discarded should then be freed
  576.    by calling deflateEnd.  Note that deflateCopy duplicates the internal
  577.    compression state which can be quite large, so this strategy is slow and
  578.    can consume lots of memory.
  579.      deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not
  580.    enough memory, Z_STREAM_ERROR if the source stream state was inconsistent
  581.    (such as zalloc being NULL). msg is left unchanged in both source and
  582.    destination.
  583. */
  584. extern int EXPORT deflateReset OF((z_streamp strm));
  585. /*
  586.      This function is equivalent to deflateEnd followed by deflateInit,
  587.    but does not free and reallocate all the internal compression state.
  588.    The stream will keep the same compression level and any other attributes
  589.    that may have been set by deflateInit2.
  590.       deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
  591.    stream state was inconsistent (such as zalloc or state being NULL).
  592. */
  593. extern int EXPORT deflateParams OF((z_streamp strm, int level, int strategy));
  594. /*
  595.      Dynamically update the compression level and compression strategy.
  596.    This can be used to switch between compression and straight copy of
  597.    the input data, or to switch to a different kind of input data requiring
  598.    a different strategy. If the compression level is changed, the input
  599.    available so far is compressed with the old level (and may be flushed);
  600.    the new level will take effect only at the next call of deflate().
  601.      Before the call of deflateParams, the stream state must be set as for
  602.    a call of deflate(), since the currently available input may have to
  603.    be compressed and flushed. In particular, strm->avail_out must be non-zero.
  604.      deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source
  605.    stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR
  606.    if strm->avail_out was zero.
  607. */
  608. extern int EXPORT deflateOutputPending OF((z_streamp strm));
  609. /*
  610.      Returns the number of bytes of output which are immediately
  611.    available from the compressor (i.e. without any further input
  612.    or flush).
  613. */
  614. /*   
  615. extern int EXPORT inflateInit2 OF((z_streamp strm,
  616.                                    int  windowBits));
  617.      This is another version of inflateInit with more compression options. The
  618.    fields next_out, zalloc, zfree and opaque must be initialized before by
  619.    the caller.
  620.      The windowBits parameter is the base two logarithm of the maximum window
  621.    size (the size of the history buffer).  It should be in the range 8..15 for
  622.    this version of the library (the value 16 will be allowed soon). The
  623.    default value is 15 if inflateInit is used instead. If a compressed stream
  624.    with a larger window size is given as input, inflate() will return with
  625.    the error code Z_DATA_ERROR instead of trying to allocate a larger window.
  626.      If next_out is not null, the library will use this buffer for the history
  627.    buffer; the buffer must either be large enough to hold the entire output
  628.    data, or have at least 1<<windowBits bytes.  If next_out is null, the
  629.    library will allocate its own buffer (and leave next_out null). next_in
  630.    need not be provided here but must be provided by the application for the
  631.    next call of inflate().
  632.      If the history buffer is provided by the application, next_out must
  633.    never be changed by the application since the decompressor maintains
  634.    history information inside this buffer from call to call; the application
  635.    can only reset next_out to the beginning of the history buffer when
  636.    avail_out is zero and all output has been consumed.
  637.       inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was
  638.    not enough memory, Z_STREAM_ERROR if a parameter is invalid (such as
  639.    windowBits < 8). msg is set to null if there is no error message.
  640.    inflateInit2 does not perform any decompression: this will be done by
  641.    inflate().
  642. */
  643. extern int EXPORT inflateSetDictionary OF((z_streamp strm,
  644.            const Bytef *dictionary,
  645.    uInt  dictLength));
  646. /*
  647.      Initializes the decompression dictionary (history buffer) from the given
  648.    uncompressed byte sequence. This function must be called immediately after
  649.    a call of inflate if this call returned Z_NEED_DICT. The dictionary chosen
  650.    by the compressor can be determined from the Adler32 value returned by this
  651.    call of inflate. The compressor and decompressor must use exactly the same
  652.    dictionary (see deflateSetDictionary).
  653.      inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a
  654.    parameter is invalid (such as NULL dictionary) or the stream state is
  655.    inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the
  656.    expected one (incorrect Adler32 value). inflateSetDictionary does not
  657.    perform any decompression: this will be done by subsequent calls of
  658.    inflate().
  659. */
  660. extern int EXPORT inflateSync OF((z_streamp strm));
  661. /* 
  662.     Skips invalid compressed data until the special marker (see deflate()
  663.   above) can be found, or until all available input is skipped. No output
  664.   is provided.
  665.     inflateSync returns Z_OK if the special marker has been found, Z_BUF_ERROR
  666.   if no more input was provided, Z_DATA_ERROR if no marker has been found,
  667.   or Z_STREAM_ERROR if the stream structure was inconsistent. In the success
  668.   case, the application may save the current current value of total_in which
  669.   indicates where valid compressed data was found. In the error case, the
  670.   application may repeatedly call inflateSync, providing more input each time,
  671.   until success or end of the input data.
  672. */
  673. extern int EXPORT inflateReset OF((z_streamp strm));
  674. /*
  675.      This function is equivalent to inflateEnd followed by inflateInit,
  676.    but does not free and reallocate all the internal decompression state.
  677.    The stream will keep attributes that may have been set by inflateInit2.
  678.       inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
  679.    stream state was inconsistent (such as zalloc or state being NULL).
  680. */
  681. extern int inflateIncomp OF((z_stream *strm));
  682. /*
  683.      This function adds the data at next_in (avail_in bytes) to the output
  684.    history without performing any output.  There must be no pending output,
  685.    and the decompressor must be expecting to see the start of a block.
  686.    Calling this function is equivalent to decompressing a stored block
  687.    containing the data at next_in (except that the data is not output).
  688. */
  689.                         /* utility functions */
  690. /*
  691.      The following utility functions are implemented on top of the
  692.    basic stream-oriented functions. To simplify the interface, some
  693.    default options are assumed (compression level, window size,
  694.    standard memory allocation functions). The source code of these
  695.    utility functions can easily be modified if you need special options.
  696. */
  697. extern int EXPORT compress OF((Bytef *dest,   uLongf *destLen,
  698.        const Bytef *source, uLong sourceLen));
  699. /*
  700.      Compresses the source buffer into the destination buffer.  sourceLen is
  701.    the byte length of the source buffer. Upon entry, destLen is the total
  702.    size of the destination buffer, which must be at least 0.1% larger than
  703.    sourceLen plus 12 bytes. Upon exit, destLen is the actual size of the
  704.    compressed buffer.
  705.      This function can be used to compress a whole file at once if the
  706.    input file is mmap'ed.
  707.      compress returns Z_OK if success, Z_MEM_ERROR if there was not
  708.    enough memory, Z_BUF_ERROR if there was not enough room in the output
  709.    buffer.
  710. */
  711. extern int EXPORT uncompress OF((Bytef *dest,   uLongf *destLen,
  712.  const Bytef *source, uLong sourceLen));
  713. /*
  714.      Decompresses the source buffer into the destination buffer.  sourceLen is
  715.    the byte length of the source buffer. Upon entry, destLen is the total
  716.    size of the destination buffer, which must be large enough to hold the
  717.    entire uncompressed data. (The size of the uncompressed data must have
  718.    been saved previously by the compressor and transmitted to the decompressor
  719.    by some mechanism outside the scope of this compression library.)
  720.    Upon exit, destLen is the actual size of the compressed buffer.
  721.      This function can be used to decompress a whole file at once if the
  722.    input file is mmap'ed.
  723.      uncompress returns Z_OK if success, Z_MEM_ERROR if there was not
  724.    enough memory, Z_BUF_ERROR if there was not enough room in the output
  725.    buffer, or Z_DATA_ERROR if the input data was corrupted.
  726. */
  727. typedef voidp gzFile;
  728. extern gzFile EXPORT gzopen  OF((const char *path, const char *mode));
  729. /*
  730.      Opens a gzip (.gz) file for reading or writing. The mode parameter
  731.    is as in fopen ("rb" or "wb") but can also include a compression level
  732.    ("wb9").  gzopen can be used to read a file which is not in gzip format;
  733.    in this case gzread will directly read from the file without decompression.
  734.      gzopen returns NULL if the file could not be opened or if there was
  735.    insufficient memory to allocate the (de)compression state; errno
  736.    can be checked to distinguish the two cases (if errno is zero, the
  737.    zlib error is Z_MEM_ERROR).
  738. */
  739. extern gzFile EXPORT gzdopen  OF((int fd, const char *mode));
  740. /*
  741.      gzdopen() associates a gzFile with the file descriptor fd.  File
  742.    descriptors are obtained from calls like open, dup, creat, pipe or
  743.    fileno (in the file has been previously opened with fopen).
  744.    The mode parameter is as in gzopen.
  745.      The next call of gzclose on the returned gzFile will also close the
  746.    file descriptor fd, just like fclose(fdopen(fd), mode) closes the file
  747.    descriptor fd. If you want to keep fd open, use gzdopen(dup(fd), mode).
  748.      gzdopen returns NULL if there was insufficient memory to allocate
  749.    the (de)compression state.
  750. */
  751. extern int EXPORT    gzread  OF((gzFile file, voidp buf, unsigned len));
  752. /*
  753.      Reads the given number of uncompressed bytes from the compressed file.
  754.    If the input file was not in gzip format, gzread copies the given number
  755.    of bytes into the buffer.
  756.      gzread returns the number of uncompressed bytes actually read (0 for
  757.    end of file, -1 for error). */
  758. extern int EXPORT    gzwrite OF((gzFile file, const voidp buf, unsigned len));
  759. /*
  760.      Writes the given number of uncompressed bytes into the compressed file.
  761.    gzwrite returns the number of uncompressed bytes actually written
  762.    (0 in case of error).
  763. */
  764. extern int EXPORT    gzflush OF((gzFile file, int flush));
  765. /*
  766.      Flushes all pending output into the compressed file. The parameter
  767.    flush is as in the deflate() function. The return value is the zlib
  768.    error number (see function gzerror below). gzflush returns Z_OK if
  769.    the flush parameter is Z_FINISH and all output could be flushed.
  770.      gzflush should be called only when strictly necessary because it can
  771.    degrade compression.
  772. */
  773. extern int EXPORT    gzclose OF((gzFile file));
  774. /*
  775.      Flushes all pending output if necessary, closes the compressed file
  776.    and deallocates all the (de)compression state. The return value is the zlib
  777.    error number (see function gzerror below).
  778. */
  779. extern const char * EXPORT gzerror OF((gzFile file, int *errnum));
  780. /*
  781.      Returns the error message for the last error which occurred on the
  782.    given compressed file. errnum is set to zlib error number. If an
  783.    error occurred in the file system and not in the compression library,
  784.    errnum is set to Z_ERRNO and the application may consult errno
  785.    to get the exact error code.
  786. */
  787.                         /* checksum functions */
  788. /*
  789.      These functions are not related to compression but are exported
  790.    anyway because they might be useful in applications using the
  791.    compression library.
  792. */
  793. extern uLong EXPORT adler32 OF((uLong adler, const Bytef *buf, uInt len));
  794. /*
  795.      Update a running Adler-32 checksum with the bytes buf[0..len-1] and
  796.    return the updated checksum. If buf is NULL, this function returns
  797.    the required initial value for the checksum.
  798.    An Adler-32 checksum is almost as reliable as a CRC32 but can be computed
  799.    much faster. Usage example:
  800.      uLong adler = adler32(0L, Z_NULL, 0);
  801.      while (read_buffer(buffer, length) != EOF) {
  802.        adler = adler32(adler, buffer, length);
  803.      }
  804.      if (adler != original_adler) error();
  805. */
  806. extern uLong EXPORT crc32   OF((uLong crc, const Bytef *buf, uInt len));
  807. /*
  808.      Update a running crc with the bytes buf[0..len-1] and return the updated
  809.    crc. If buf is NULL, this function returns the required initial value
  810.    for the crc. Pre- and post-conditioning (one's complement) is performed
  811.    within this function so it shouldn't be done by the application.
  812.    Usage example:
  813.      uLong crc = crc32(0L, Z_NULL, 0);
  814.      while (read_buffer(buffer, length) != EOF) {
  815.        crc = crc32(crc, buffer, length);
  816.      }
  817.      if (crc != original_crc) error();
  818. */
  819.                         /* various hacks, don't look :) */
  820. /* deflateInit and inflateInit are macros to allow checking the zlib version
  821.  * and the compiler's view of z_stream:
  822.  */
  823. extern int EXPORT deflateInit_ OF((z_streamp strm, int level,
  824.            const char *version, int stream_size));
  825. extern int EXPORT inflateInit_ OF((z_streamp strm,
  826.    const char *version, int stream_size));
  827. extern int EXPORT deflateInit2_ OF((z_streamp strm, int  level, int  method,
  828.     int windowBits, int memLevel, int strategy,
  829.     const char *version, int stream_size));
  830. extern int EXPORT inflateInit2_ OF((z_streamp strm, int  windowBits,
  831.     const char *version, int stream_size));
  832. #define deflateInit(strm, level) 
  833.         deflateInit_((strm), (level),       ZLIB_VERSION, sizeof(z_stream))
  834. #define inflateInit(strm) 
  835.         inflateInit_((strm),                ZLIB_VERSION, sizeof(z_stream))
  836. #define deflateInit2(strm, level, method, windowBits, memLevel, strategy) 
  837.         deflateInit2_((strm),(level),(method),(windowBits),(memLevel),
  838.       (strategy),           ZLIB_VERSION, sizeof(z_stream))
  839. #define inflateInit2(strm, windowBits) 
  840.         inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))
  841. #if !defined(_Z_UTIL_H) && !defined(NO_DUMMY_DECL)
  842.     struct internal_state {int dummy;}; /* hack for buggy compilers */
  843. #endif
  844. uLongf *get_crc_table OF((void)); /* can be used by asm versions of crc32() */
  845. #ifdef __cplusplus
  846. }
  847. #endif
  848. #endif /* _ZLIB_H */
  849. /* --- zlib.h */