zlib.h
上传用户:jlfgdled
上传日期:2013-04-10
资源大小:33168k
文件大小:17k
源码类别:

Linux/Unix编程

开发平台:

Unix_Linux

  1. /* */
  2. /*
  3.  * This file is derived from zlib.h and zconf.h from the zlib-0.95
  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 960122==
  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 -- interface of the 'zlib' general purpose compression library
  15.   version 0.95, Aug 16th, 1995.
  16.   Copyright (C) 1995 Jean-loup Gailly and Mark Adler
  17.   This software is provided 'as-is', without any express or implied
  18.   warranty.  In no event will the authors be held liable for any damages
  19.   arising from the use of this software.
  20.   Permission is granted to anyone to use this software for any purpose,
  21.   including commercial applications, and to alter it and redistribute it
  22.   freely, subject to the following restrictions:
  23.   1. The origin of this software must not be misrepresented; you must not
  24.      claim that you wrote the original software. If you use this software
  25.      in a product, an acknowledgment in the product documentation would be
  26.      appreciated but is not required.
  27.   2. Altered source versions must be plainly marked as such, and must not be
  28.      misrepresented as being the original software.
  29.   3. This notice may not be removed or altered from any source distribution.
  30.   Jean-loup Gailly        Mark Adler
  31.   gzip@prep.ai.mit.edu    madler@alumni.caltech.edu
  32.  */
  33. #ifndef _ZLIB_H
  34. #define _ZLIB_H
  35. /* #include "zconf.h" */ /* included directly here */
  36. /* zconf.h -- configuration of the zlib compression library
  37.  * Copyright (C) 1995 Jean-loup Gailly.
  38.  * For conditions of distribution and use, see copyright notice in zlib.h 
  39.  */
  40. /* From: zconf.h,v 1.12 1995/05/03 17:27:12 jloup Exp */
  41. /*
  42.      The library does not install any signal handler. It is recommended to
  43.   add at least a handler for SIGSEGV when decompressing; the library checks
  44.   the consistency of the input data whenever possible but may go nuts
  45.   for some forms of corrupted input.
  46.  */
  47. /*
  48.  * Compile with -DMAXSEG_64K if the alloc function cannot allocate more
  49.  * than 64k bytes at a time (needed on systems with 16-bit int).
  50.  * Compile with -DUNALIGNED_OK if it is OK to access shorts or ints
  51.  * at addresses which are not a multiple of their size.
  52.  * Under DOS, -DFAR=far or -DFAR=__far may be needed.
  53.  */
  54. #ifndef STDC
  55. #  if defined(MSDOS) || defined(__STDC__) || defined(__cplusplus)
  56. #    define STDC
  57. #  endif
  58. #endif
  59. #ifdef __MWERKS__ /* Metrowerks CodeWarrior declares fileno() in unix.h */
  60. #  include <unix.h>
  61. #endif
  62. /* Maximum value for memLevel in deflateInit2 */
  63. #ifndef MAX_MEM_LEVEL
  64. #  ifdef MAXSEG_64K
  65. #    define MAX_MEM_LEVEL 8
  66. #  else
  67. #    define MAX_MEM_LEVEL 9
  68. #  endif
  69. #endif
  70. #ifndef FAR
  71. #  define FAR
  72. #endif
  73. /* Maximum value for windowBits in deflateInit2 and inflateInit2 */
  74. #ifndef MAX_WBITS
  75. #  define MAX_WBITS   15 /* 32K LZ77 window */
  76. #endif
  77. /* The memory requirements for deflate are (in bytes):
  78.             1 << (windowBits+2)   +  1 << (memLevel+9)
  79.  that is: 128K for windowBits=15  +  128K for memLevel = 8  (default values)
  80.  plus a few kilobytes for small objects. For example, if you want to reduce
  81.  the default memory requirements from 256K to 128K, compile with
  82.      make CFLAGS="-O -DMAX_WBITS=14 -DMAX_MEM_LEVEL=7"
  83.  Of course this will generally degrade compression (there's no free lunch).
  84.    The memory requirements for inflate are (in bytes) 1 << windowBits
  85.  that is, 32K for windowBits=15 (default value) plus a few kilobytes
  86.  for small objects.
  87. */
  88.                         /* Type declarations */
  89. #ifndef OF /* function prototypes */
  90. #  ifdef STDC
  91. #    define OF(args)  args
  92. #  else
  93. #    define OF(args)  ()
  94. #  endif
  95. #endif
  96. typedef unsigned char  Byte;  /* 8 bits */
  97. typedef unsigned int   uInt;  /* 16 bits or more */
  98. typedef unsigned long  uLong; /* 32 bits or more */
  99. typedef Byte FAR Bytef;
  100. typedef char FAR charf;
  101. typedef int FAR intf;
  102. typedef uInt FAR uIntf;
  103. typedef uLong FAR uLongf;
  104. #ifdef STDC
  105.    typedef void FAR *voidpf;
  106.    typedef void     *voidp;
  107. #else
  108.    typedef Byte FAR *voidpf;
  109.    typedef Byte     *voidp;
  110. #endif
  111. /* end of original zconf.h */
  112. #define ZLIB_VERSION "0.95P"
  113. /* 
  114.      The 'zlib' compression library provides in-memory compression and
  115.   decompression functions, including integrity checks of the uncompressed
  116.   data.  This version of the library supports only one compression method
  117.   (deflation) but other algorithms may be added later and will have the same
  118.   stream interface.
  119.      For compression the application must provide the output buffer and
  120.   may optionally provide the input buffer for optimization. For decompression,
  121.   the application must provide the input buffer and may optionally provide
  122.   the output buffer for optimization.
  123.      Compression can be done in a single step if the buffers are large
  124.   enough (for example if an input file is mmap'ed), or can be done by
  125.   repeated calls of the compression function.  In the latter case, the
  126.   application must provide more input and/or consume the output
  127.   (providing more output space) before each call.
  128. */
  129. typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size));
  130. typedef void   (*free_func)  OF((voidpf opaque, voidpf address, uInt nbytes));
  131. struct internal_state;
  132. typedef struct z_stream_s {
  133.     Bytef    *next_in;  /* next input byte */
  134.     uInt     avail_in;  /* number of bytes available at next_in */
  135.     uLong    total_in;  /* total nb of input bytes read so far */
  136.     Bytef    *next_out; /* next output byte should be put there */
  137.     uInt     avail_out; /* remaining free space at next_out */
  138.     uLong    total_out; /* total nb of bytes output so far */
  139.     char     *msg;      /* last error message, NULL if no error */
  140.     struct internal_state FAR *state; /* not visible by applications */
  141.     alloc_func zalloc;  /* used to allocate the internal state */
  142.     free_func  zfree;   /* used to free the internal state */
  143.     voidp      opaque;  /* private data object passed to zalloc and zfree */
  144.     Byte     data_type; /* best guess about the data type: ascii or binary */
  145. } z_stream;
  146. /*
  147.    The application must update next_in and avail_in when avail_in has
  148.    dropped to zero. It must update next_out and avail_out when avail_out
  149.    has dropped to zero. The application must initialize zalloc, zfree and
  150.    opaque before calling the init function. All other fields are set by the
  151.    compression library and must not be updated by the application.
  152.    The opaque value provided by the application will be passed as the first
  153.    parameter for calls of zalloc and zfree. This can be useful for custom
  154.    memory management. The compression library attaches no meaning to the
  155.    opaque value.
  156.    zalloc must return Z_NULL if there is not enough memory for the object.
  157.    On 16-bit systems, the functions zalloc and zfree must be able to allocate
  158.    exactly 65536 bytes, but will not be required to allocate more than this
  159.    if the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS,
  160.    pointers returned by zalloc for objects of exactly 65536 bytes *must*
  161.    have their offset normalized to zero. The default allocation function
  162.    provided by this library ensures this (see zutil.c). To reduce memory
  163.    requirements and avoid any allocation of 64K objects, at the expense of
  164.    compression ratio, compile the library with -DMAX_WBITS=14 (see zconf.h).
  165.    The fields total_in and total_out can be used for statistics or
  166.    progress reports. After compression, total_in holds the total size of
  167.    the uncompressed data and may be saved for use in the decompressor
  168.    (particularly if the decompressor wants to decompress everything in
  169.    a single step).
  170. */
  171.                         /* constants */
  172. #define Z_NO_FLUSH      0
  173. #define Z_PARTIAL_FLUSH 1
  174. #define Z_FULL_FLUSH    2
  175. #define Z_SYNC_FLUSH    3 /* experimental: partial_flush + byte align */
  176. #define Z_FINISH        4
  177. #define Z_PACKET_FLUSH 5
  178. /* See deflate() below for the usage of these constants */
  179. #define Z_OK            0
  180. #define Z_STREAM_END    1
  181. #define Z_ERRNO        (-1)
  182. #define Z_STREAM_ERROR (-2)
  183. #define Z_DATA_ERROR   (-3)
  184. #define Z_MEM_ERROR    (-4)
  185. #define Z_BUF_ERROR    (-5)
  186. /* error codes for the compression/decompression functions */
  187. #define Z_BEST_SPEED             1
  188. #define Z_BEST_COMPRESSION       9
  189. #define Z_DEFAULT_COMPRESSION  (-1)
  190. /* compression levels */
  191. #define Z_FILTERED            1
  192. #define Z_HUFFMAN_ONLY        2
  193. #define Z_DEFAULT_STRATEGY    0
  194. #define Z_BINARY   0
  195. #define Z_ASCII    1
  196. #define Z_UNKNOWN  2
  197. /* Used to set the data_type field */
  198. #define Z_NULL  0  /* for initializing zalloc, zfree, opaque */
  199. extern char *zlib_version;
  200. /* The application can compare zlib_version and ZLIB_VERSION for consistency.
  201.    If the first character differs, the library code actually used is
  202.    not compatible with the zlib.h header file used by the application.
  203.  */
  204.                         /* basic functions */
  205. extern int inflateInit OF((z_stream *strm));
  206. /* 
  207.      Initializes the internal stream state for decompression. The fields
  208.    zalloc and zfree must be initialized before by the caller.  If zalloc and
  209.    zfree are set to Z_NULL, inflateInit updates them to use default allocation
  210.    functions.
  211.      inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not
  212.    enough memory.  msg is set to null if there is no error message.
  213.    inflateInit does not perform any decompression: this will be done by
  214.    inflate().
  215. */
  216. extern int inflate OF((z_stream *strm, int flush));
  217. /*
  218.   Performs one or both of the following actions:
  219.   - Decompress more input starting at next_in and update next_in and avail_in
  220.     accordingly. If not all input can be processed (because there is not
  221.     enough room in the output buffer), next_in is updated and processing
  222.     will resume at this point for the next call of inflate().
  223.   - Provide more output starting at next_out and update next_out and avail_out
  224.     accordingly.  inflate() always provides as much output as possible
  225.     (until there is no more input data or no more space in the output buffer).
  226.   Before the call of inflate(), the application should ensure that at least
  227.   one of the actions is possible, by providing more input and/or consuming
  228.   more output, and updating the next_* and avail_* values accordingly.
  229.   The application can consume the uncompressed output when it wants, for
  230.   example when the output buffer is full (avail_out == 0), or after each
  231.   call of inflate().
  232.     If the parameter flush is set to Z_PARTIAL_FLUSH or Z_PACKET_FLUSH,
  233.   inflate flushes as much output as possible to the output buffer. The
  234.   flushing behavior of inflate is not specified for values of the flush
  235.   parameter other than Z_PARTIAL_FLUSH, Z_PACKET_FLUSH or Z_FINISH, but the
  236.   current implementation actually flushes as much output as possible
  237.   anyway.  For Z_PACKET_FLUSH, inflate checks that once all the input data
  238.   has been consumed, it is expecting to see the length field of a stored
  239.   block; if not, it returns Z_DATA_ERROR.
  240.     inflate() should normally be called until it returns Z_STREAM_END or an
  241.   error. However if all decompression is to be performed in a single step
  242.   (a single call of inflate), the parameter flush should be set to
  243.   Z_FINISH. In this case all pending input is processed and all pending
  244.   output is flushed; avail_out must be large enough to hold all the
  245.   uncompressed data. (The size of the uncompressed data may have been saved
  246.   by the compressor for this purpose.) The next operation on this stream must
  247.   be inflateEnd to deallocate the decompression state. The use of Z_FINISH
  248.   is never required, but can be used to inform inflate that a faster routine
  249.   may be used for the single inflate() call.
  250.     inflate() returns Z_OK if some progress has been made (more input
  251.   processed or more output produced), Z_STREAM_END if the end of the
  252.   compressed data has been reached and all uncompressed output has been
  253.   produced, Z_DATA_ERROR if the input data was corrupted, Z_STREAM_ERROR if
  254.   the stream structure was inconsistent (for example if next_in or next_out
  255.   was NULL), Z_MEM_ERROR if there was not enough memory, Z_BUF_ERROR if no
  256.   progress is possible or if there was not enough room in the output buffer
  257.   when Z_FINISH is used. In the Z_DATA_ERROR case, the application may then
  258.   call inflateSync to look for a good compression block.  */
  259. extern int inflateEnd OF((z_stream *strm));
  260. /*
  261.      All dynamically allocated data structures for this stream are freed.
  262.    This function discards any unprocessed input and does not flush any
  263.    pending output.
  264.      inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state
  265.    was inconsistent. In the error case, msg may be set but then points to a
  266.    static string (which must not be deallocated).
  267. */
  268.                         /* advanced functions */
  269. extern int inflateInit2 OF((z_stream *strm,
  270.                             int  windowBits));
  271. /*   
  272.      This is another version of inflateInit with more compression options. The
  273.    fields next_out, zalloc and zfree must be initialized before by the caller.
  274.      The windowBits parameter is the base two logarithm of the maximum window
  275.    size (the size of the history buffer).  It should be in the range 8..15 for
  276.    this version of the library (the value 16 will be allowed soon). The
  277.    default value is 15 if inflateInit is used instead. If a compressed stream
  278.    with a larger window size is given as input, inflate() will return with
  279.    the error code Z_DATA_ERROR instead of trying to allocate a larger window.
  280.      If next_out is not null, the library will use this buffer for the history
  281.    buffer; the buffer must either be large enough to hold the entire output
  282.    data, or have at least 1<<windowBits bytes.  If next_out is null, the
  283.    library will allocate its own buffer (and leave next_out null). next_in
  284.    need not be provided here but must be provided by the application for the
  285.    next call of inflate().
  286.      If the history buffer is provided by the application, next_out must
  287.    never be changed by the application since the decompressor maintains
  288.    history information inside this buffer from call to call; the application
  289.    can only reset next_out to the beginning of the history buffer when
  290.    avail_out is zero and all output has been consumed.
  291.       inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was
  292.    not enough memory, Z_STREAM_ERROR if a parameter is invalid (such as
  293.    windowBits < 8). msg is set to null if there is no error message.
  294.    inflateInit2 does not perform any decompression: this will be done by
  295.    inflate().
  296. */
  297. extern int inflateSync OF((z_stream *strm));
  298. /* 
  299.     Skips invalid compressed data until the special marker (see deflate()
  300.   above) can be found, or until all available input is skipped. No output
  301.   is provided.
  302.     inflateSync returns Z_OK if the special marker has been found, Z_BUF_ERROR
  303.   if no more input was provided, Z_DATA_ERROR if no marker has been found,
  304.   or Z_STREAM_ERROR if the stream structure was inconsistent. In the success
  305.   case, the application may save the current current value of total_in which
  306.   indicates where valid compressed data was found. In the error case, the
  307.   application may repeatedly call inflateSync, providing more input each time,
  308.   until success or end of the input data.
  309. */
  310. extern int inflateReset OF((z_stream *strm));
  311. /*
  312.      This function is equivalent to inflateEnd followed by inflateInit,
  313.    but does not free and reallocate all the internal decompression state.
  314.    The stream will keep attributes that may have been set by inflateInit2.
  315.       inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
  316.    stream state was inconsistent (such as zalloc or state being NULL).
  317. */
  318. extern int inflateIncomp OF((z_stream *strm));
  319. /*
  320.      This function adds the data at next_in (avail_in bytes) to the output
  321.    history without performing any output.  There must be no pending output,
  322.    and the decompressor must be expecting to see the start of a block.
  323.    Calling this function is equivalent to decompressing a stored block
  324.    containing the data at next_in (except that the data is not output).
  325. */
  326.                         /* checksum functions */
  327. /*
  328.      This function is not related to compression but is exported
  329.    anyway because it might be useful in applications using the
  330.    compression library.
  331. */
  332. extern uLong adler32 OF((uLong adler, Bytef *buf, uInt len));
  333. /*
  334.      Update a running Adler-32 checksum with the bytes buf[0..len-1] and
  335.    return the updated checksum. If buf is NULL, this function returns
  336.    the required initial value for the checksum.
  337.    An Adler-32 checksum is almost as reliable as a CRC32 but can be computed
  338.    much faster. Usage example:
  339.      uLong adler = adler32(0L, Z_NULL, 0);
  340.      while (read_buffer(buffer, length) != EOF) {
  341.        adler = adler32(adler, buffer, length);
  342.      }
  343.      if (adler != original_adler) error();
  344. */
  345. #ifndef _Z_UTIL_H
  346.     struct internal_state {int dummy;}; /* hack for buggy compilers */
  347. #endif
  348. #endif /* _ZLIB_H */