common/zlib.h

   1 /*      $Id: zlib.h,v 1.4 1997/03/04 03:26:36 paulus Exp $      */
   2
   3 /*
   4  * This file is derived from zlib.h and zconf.h from the zlib-0.95
   5  * distribution by Jean-loup Gailly and Mark Adler, with some additions
   6  * by Paul Mackerras to aid in implementing Deflate compression and
   7  * decompression for PPP packets.
   8  */
   9
  10 /*
  11  *  ==FILEVERSION 960122==
  12  *
  13  * This marker is used by the Linux installation script to determine
  14  * whether an up-to-date version of this file is already installed.
  15  */
  16
  17 /* zlib.h -- interface of the 'zlib' general purpose compression library
  18   version 0.95, Aug 16th, 1995.
  19
  20   Copyright (C) 1995 Jean-loup Gailly and Mark Adler
  21
  22   This software is provided 'as-is', without any express or implied
  23   warranty.  In no event will the authors be held liable for any damages
  24   arising from the use of this software.
  25
  26   Permission is granted to anyone to use this software for any purpose,
  27   including commercial applications, and to alter it and redistribute it
  28   freely, subject to the following restrictions:
  29
  30   1. The origin of this software must not be misrepresented; you must not
  31      claim that you wrote the original software. If you use this software
  32      in a product, an acknowledgment in the product documentation would be
  33      appreciated but is not required.
  34   2. Altered source versions must be plainly marked as such, and must not be
  35      misrepresented as being the original software.
  36   3. This notice may not be removed or altered from any source distribution.
  37
  38   Jean-loup Gailly        Mark Adler
  39   gzip@prep.ai.mit.edu    madler@alumni.caltech.edu
  40  */
  41
  42 #ifndef _ZLIB_H
  43 #define _ZLIB_H
  44
  45 /* #include "zconf.h" */        /* included directly here */
  46
  47 /* zconf.h -- configuration of the zlib compression library
  48  * Copyright (C) 1995 Jean-loup Gailly.
  49  * For conditions of distribution and use, see copyright notice in zlib.h
  50  */
  51
  52 /* From: zconf.h,v 1.12 1995/05/03 17:27:12 jloup Exp */
  53
  54 /*
  55      The library does not install any signal handler. It is recommended to
  56   add at least a handler for SIGSEGV when decompressing; the library checks
  57   the consistency of the input data whenever possible but may go nuts
  58   for some forms of corrupted input.
  59  */
  60
  61 /*
  62  * Compile with -DMAXSEG_64K if the alloc function cannot allocate more
  63  * than 64k bytes at a time (needed on systems with 16-bit int).
  64  * Compile with -DUNALIGNED_OK if it is OK to access shorts or ints
  65  * at addresses which are not a multiple of their size.
  66  * Under DOS, -DFAR=far or -DFAR=__far may be needed.
  67  */
  68
  69 #ifndef STDC
  70 #  if defined(MSDOS) || defined(__STDC__) || defined(__cplusplus)
  71 #    define STDC
  72 #  endif
  73 #endif
  74
  75 #ifdef  __MWERKS__ /* Metrowerks CodeWarrior declares fileno() in unix.h */
  76 #  include <unix.h>
  77 #endif
  78
  79 /* Maximum value for memLevel in deflateInit2 */
  80 #ifndef MAX_MEM_LEVEL
  81 #  ifdef MAXSEG_64K
  82 #    define MAX_MEM_LEVEL 8
  83 #  else
  84 #    define MAX_MEM_LEVEL 9
  85 #  endif
  86 #endif
  87
  88 #ifndef FAR
  89 #  define FAR
  90 #endif
  91
  92 /* Maximum value for windowBits in deflateInit2 and inflateInit2 */
  93 #ifndef MAX_WBITS
  94 #  define MAX_WBITS   15 /* 32K LZ77 window */
  95 #endif
  96
  97 /* The memory requirements for deflate are (in bytes):
  98             1 << (windowBits+2)   +  1 << (memLevel+9)
  99  that is: 128K for windowBits=15  +  128K for memLevel = 8  (default values)
 100  plus a few kilobytes for small objects. For example, if you want to reduce
 101  the default memory requirements from 256K to 128K, compile with
 102      make CFLAGS="-O -DMAX_WBITS=14 -DMAX_MEM_LEVEL=7"
 103  Of course this will generally degrade compression (there's no free lunch).
 104
 105    The memory requirements for inflate are (in bytes) 1 << windowBits
 106  that is, 32K for windowBits=15 (default value) plus a few kilobytes
 107  for small objects.
 108 */
 109
 110                         /* Type declarations */
 111
 112 #ifndef OF /* function prototypes */
 113 #  ifdef STDC
 114 #    define OF(args)  args
 115 #  else
 116 #    define OF(args)  ()
 117 #  endif
 118 #endif
 119
 120 typedef unsigned char  Byte;  /* 8 bits */
 121 typedef unsigned int   uInt;  /* 16 bits or more */
 122 typedef unsigned long  uLong; /* 32 bits or more */
 123
 124 typedef Byte FAR Bytef;
 125 typedef char FAR charf;
 126 typedef int FAR intf;
 127 typedef uInt FAR uIntf;
 128 typedef uLong FAR uLongf;
 129
 130 #ifdef STDC
 131    typedef void FAR *voidpf;
 132    typedef void     *voidp;
 133 #else
 134    typedef Byte FAR *voidpf;
 135    typedef Byte     *voidp;
 136 #endif
 137
 138 /* end of original zconf.h */
 139
 140 #define ZLIB_VERSION "0.95P"
 141
 142 /*
 143      The 'zlib' compression library provides in-memory compression and
 144   decompression functions, including integrity checks of the uncompressed
 145   data.  This version of the library supports only one compression method
 146   (deflation) but other algorithms may be added later and will have the same
 147   stream interface.
 148
 149      For compression the application must provide the output buffer and
 150   may optionally provide the input buffer for optimization. For decompression,
 151   the application must provide the input buffer and may optionally provide
 152   the output buffer for optimization.
 153
 154      Compression can be done in a single step if the buffers are large
 155   enough (for example if an input file is mmap'ed), or can be done by
 156   repeated calls of the compression function.  In the latter case, the
 157   application must provide more input and/or consume the output
 158   (providing more output space) before each call.
 159 */
 160
 161 typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size));
 162 typedef void   (*free_func)  OF((voidpf opaque, voidpf address, uInt nbytes));
 163
 164 struct internal_state;
 165
 166 typedef struct z_stream_s {
 167     Bytef    *next_in;  /* next input byte */
 168     uInt     avail_in;  /* number of bytes available at next_in */
 169     uLong    total_in;  /* total nb of input bytes read so far */
 170
 171     Bytef    *next_out; /* next output byte should be put there */
 172     uInt     avail_out; /* remaining free space at next_out */
 173     uLong    total_out; /* total nb of bytes output so far */
 174
 175     char     *msg;      /* last error message, NULL if no error */
 176     struct internal_state FAR *state; /* not visible by applications */
 177
 178     alloc_func zalloc;  /* used to allocate the internal state */
 179     free_func  zfree;   /* used to free the internal state */
 180     voidp      opaque;  /* private data object passed to zalloc and zfree */
 181
 182     Byte     data_type; /* best guess about the data type: ascii or binary */
 183
 184 } z_stream;
 185
 186 /*
 187    The application must update next_in and avail_in when avail_in has
 188    dropped to zero. It must update next_out and avail_out when avail_out
 189    has dropped to zero. The application must initialize zalloc, zfree and
 190    opaque before calling the init function. All other fields are set by the
 191    compression library and must not be updated by the application.
 192
 193    The opaque value provided by the application will be passed as the first
 194    parameter for calls of zalloc and zfree. This can be useful for custom
 195    memory management. The compression library attaches no meaning to the
 196    opaque value.
 197
 198    zalloc must return Z_NULL if there is not enough memory for the object.
 199    On 16-bit systems, the functions zalloc and zfree must be able to allocate
 200    exactly 65536 bytes, but will not be required to allocate more than this
 201    if the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS,
 202    pointers returned by zalloc for objects of exactly 65536 bytes *must*
 203    have their offset normalized to zero. The default allocation function
 204    provided by this library ensures this (see zutil.c). To reduce memory
 205    requirements and avoid any allocation of 64K objects, at the expense of
 206    compression ratio, compile the library with -DMAX_WBITS=14 (see zconf.h).
 207
 208    The fields total_in and total_out can be used for statistics or
 209    progress reports. After compression, total_in holds the total size of
 210    the uncompressed data and may be saved for use in the decompressor
 211    (particularly if the decompressor wants to decompress everything in
 212    a single step).
 213 */
 214
 215                         /* constants */
 216
 217 #define Z_NO_FLUSH      0
 218 #define Z_PARTIAL_FLUSH 1
 219 #define Z_FULL_FLUSH    2
 220 #define Z_SYNC_FLUSH    3 /* experimental: partial_flush + byte align */
 221 #define Z_FINISH        4
 222 #define Z_PACKET_FLUSH  5
 223 /* See deflate() below for the usage of these constants */
 224
 225 #define Z_OK            0
 226 #define Z_STREAM_END    1
 227 #define Z_ERRNO        (-1)
 228 #define Z_STREAM_ERROR (-2)
 229 #define Z_DATA_ERROR   (-3)
 230 #define Z_MEM_ERROR    (-4)
 231 #define Z_BUF_ERROR    (-5)
 232 /* error codes for the compression/decompression functions */
 233
 234 #define Z_BEST_SPEED             1
 235 #define Z_BEST_COMPRESSION       9
 236 #define Z_DEFAULT_COMPRESSION  (-1)
 237 /* compression levels */
 238
 239 #define Z_FILTERED            1
 240 #define Z_HUFFMAN_ONLY        2
 241 #define Z_DEFAULT_STRATEGY    0
 242
 243 #define Z_BINARY   0
 244 #define Z_ASCII    1
 245 #define Z_UNKNOWN  2
 246 /* Used to set the data_type field */
 247
 248 #define Z_NULL  0  /* for initializing zalloc, zfree, opaque */
 249
 250 extern char *zlib_version;
 251 /* The application can compare zlib_version and ZLIB_VERSION for consistency.
 252    If the first character differs, the library code actually used is
 253    not compatible with the zlib.h header file used by the application.
 254  */
 255
 256                         /* basic functions */
 257
 258 extern int deflateInit OF((z_stream *strm, int level));
 259 /*
 260      Initializes the internal stream state for compression. The fields
 261    zalloc, zfree and opaque must be initialized before by the caller.
 262    If zalloc and zfree are set to Z_NULL, deflateInit updates them to
 263    use default allocation functions.
 264
 265      The compression level must be Z_DEFAULT_COMPRESSION, or between 1 and 9:
 266    1 gives best speed, 9 gives best compression. Z_DEFAULT_COMPRESSION requests
 267    a default compromise between speed and compression (currently equivalent
 268    to level 6).
 269
 270      deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not
 271    enough memory, Z_STREAM_ERROR if level is not a valid compression level.
 272    msg is set to null if there is no error message.  deflateInit does not
 273    perform any compression: this will be done by deflate().
 274 */
 275
 276
 277 extern int deflate OF((z_stream *strm, int flush));
 278 /*
 279   Performs one or both of the following actions:
 280
 281   - Compress more input starting at next_in and update next_in and avail_in
 282     accordingly. If not all input can be processed (because there is not
 283     enough room in the output buffer), next_in and avail_in are updated and
 284     processing will resume at this point for the next call of deflate().
 285
 286   - Provide more output starting at next_out and update next_out and avail_out
 287     accordingly. This action is forced if the parameter flush is non zero.
 288     Forcing flush frequently degrades the compression ratio, so this parameter
 289     should be set only when necessary (in interactive applications).
 290     Some output may be provided even if flush is not set.
 291
 292   Before the call of deflate(), the application should ensure that at least
 293   one of the actions is possible, by providing more input and/or consuming
 294   more output, and updating avail_in or avail_out accordingly; avail_out
 295   should never be zero before the call. The application can consume the
 296   compressed output when it wants, for example when the output buffer is full
 297   (avail_out == 0), or after each call of deflate().
 298
 299     If the parameter flush is set to Z_PARTIAL_FLUSH, the current compression
 300   block is terminated and flushed to the output buffer so that the
 301   decompressor can get all input data available so far. For method 9, a future
 302   variant on method 8, the current block will be flushed but not terminated.
 303   If flush is set to Z_FULL_FLUSH, the compression block is terminated, a
 304   special marker is output and the compression dictionary is discarded; this
 305   is useful to allow the decompressor to synchronize if one compressed block
 306   has been damaged (see inflateSync below).  Flushing degrades compression and
 307   so should be used only when necessary.  Using Z_FULL_FLUSH too often can
 308   seriously degrade the compression. If deflate returns with avail_out == 0,
 309   this function must be called again with the same value of the flush
 310   parameter and more output space (updated avail_out), until the flush is
 311   complete (deflate returns with non-zero avail_out).
 312
 313     If the parameter flush is set to Z_PACKET_FLUSH, the compression
 314   block is terminated, and a zero-length stored block is output,
 315   omitting the length bytes (the effect of this is that the 3-bit type
 316   code 000 for a stored block is output, and the output is then
 317   byte-aligned).  This is designed for use at the end of a PPP packet.
 318   In addition, if the current compression block contains all the data
 319   since the last Z_PACKET_FLUSH, it is never output as a stored block.
 320   If the current compression block output as a static or dynamic block
 321   would not be at least `minCompression' bytes smaller than the
 322   original data, then nothing is output for that block.  (The type
 323   code for the zero-length stored block is still output, resulting in
 324   a single zero byte being output for the whole packet.)
 325   `MinCompression' is a parameter to deflateInit2, or 0 if deflateInit
 326   is used.
 327
 328     If the parameter flush is set to Z_FINISH, all pending input is processed,
 329   all pending output is flushed and deflate returns with Z_STREAM_END if there
 330   was enough output space; if deflate returns with Z_OK, this function must be
 331   called again with Z_FINISH and more output space (updated avail_out) but no
 332   more input data, until it returns with Z_STREAM_END or an error. After
 333   deflate has returned Z_STREAM_END, the only possible operations on the
 334   stream are deflateReset or deflateEnd.
 335
 336     Z_FINISH can be used immediately after deflateInit if all the compression
 337   is to be done in a single step. In this case, avail_out must be at least
 338   0.1% larger than avail_in plus 12 bytes.  If deflate does not return
 339   Z_STREAM_END, then it must be called again as described above.
 340
 341     deflate() may update data_type if it can make a good guess about
 342   the input data type (Z_ASCII or Z_BINARY). In doubt, the data is considered
 343   binary. This field is only for information purposes and does not affect
 344   the compression algorithm in any manner.
 345
 346     deflate() returns Z_OK if some progress has been made (more input
 347   processed or more output produced), Z_STREAM_END if all input has been
 348   consumed and all output has been produced (only when flush is set to
 349   Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example
 350   if next_in or next_out was NULL), Z_BUF_ERROR if no progress is possible.
 351 */
 352
 353
 354 extern int deflateEnd OF((z_stream *strm));
 355 /*
 356      All dynamically allocated data structures for this stream are freed.
 357    This function discards any unprocessed input and does not flush any
 358    pending output.
 359
 360      deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the
 361    stream state was inconsistent. In the error case, msg may be set
 362    but then points to a static string (which must not be deallocated).
 363 */
 364
 365
 366 extern int inflateInit OF((z_stream *strm));
 367 /*
 368      Initializes the internal stream state for decompression. The fields
 369    zalloc and zfree must be initialized before by the caller.  If zalloc and
 370    zfree are set to Z_NULL, inflateInit updates them to use default allocation
 371    functions.
 372
 373      inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not
 374    enough memory.  msg is set to null if there is no error message.
 375    inflateInit does not perform any decompression: this will be done by
 376    inflate().
 377 */
 378
 379
 380 #if defined(__FreeBSD__) && (defined(KERNEL) || defined(_KERNEL))
 381 #define inflate inflate_ppp     /* FreeBSD already has an inflate :-( */
 382 #endif
 383
 384 extern int inflate OF((z_stream *strm, int flush));
 385 /*
 386   Performs one or both of the following actions:
 387
 388   - Decompress more input starting at next_in and update next_in and avail_in
 389     accordingly. If not all input can be processed (because there is not
 390     enough room in the output buffer), next_in is updated and processing
 391     will resume at this point for the next call of inflate().
 392
 393   - Provide more output starting at next_out and update next_out and avail_out
 394     accordingly.  inflate() always provides as much output as possible
 395     (until there is no more input data or no more space in the output buffer).
 396
 397   Before the call of inflate(), the application should ensure that at least
 398   one of the actions is possible, by providing more input and/or consuming
 399   more output, and updating the next_* and avail_* values accordingly.
 400   The application can consume the uncompressed output when it wants, for
 401   example when the output buffer is full (avail_out == 0), or after each
 402   call of inflate().
 403
 404     If the parameter flush is set to Z_PARTIAL_FLUSH or Z_PACKET_FLUSH,
 405   inflate flushes as much output as possible to the output buffer. The
 406   flushing behavior of inflate is not specified for values of the flush
 407   parameter other than Z_PARTIAL_FLUSH, Z_PACKET_FLUSH or Z_FINISH, but the
 408   current implementation actually flushes as much output as possible
 409   anyway.  For Z_PACKET_FLUSH, inflate checks that once all the input data
 410   has been consumed, it is expecting to see the length field of a stored
 411   block; if not, it returns Z_DATA_ERROR.
 412
 413     inflate() should normally be called until it returns Z_STREAM_END or an
 414   error. However if all decompression is to be performed in a single step
 415   (a single call of inflate), the parameter flush should be set to
 416   Z_FINISH. In this case all pending input is processed and all pending
 417   output is flushed; avail_out must be large enough to hold all the
 418   uncompressed data. (The size of the uncompressed data may have been saved
 419   by the compressor for this purpose.) The next operation on this stream must
 420   be inflateEnd to deallocate the decompression state. The use of Z_FINISH
 421   is never required, but can be used to inform inflate that a faster routine
 422   may be used for the single inflate() call.
 423
 424     inflate() returns Z_OK if some progress has been made (more input
 425   processed or more output produced), Z_STREAM_END if the end of the
 426   compressed data has been reached and all uncompressed output has been
 427   produced, Z_DATA_ERROR if the input data was corrupted, Z_STREAM_ERROR if
 428   the stream structure was inconsistent (for example if next_in or next_out
 429   was NULL), Z_MEM_ERROR if there was not enough memory, Z_BUF_ERROR if no
 430   progress is possible or if there was not enough room in the output buffer
 431   when Z_FINISH is used. In the Z_DATA_ERROR case, the application may then
 432   call inflateSync to look for a good compression block.  */
 433
 434
 435 extern int inflateEnd OF((z_stream *strm));
 436 /*
 437      All dynamically allocated data structures for this stream are freed.
 438    This function discards any unprocessed input and does not flush any
 439    pending output.
 440
 441      inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state
 442    was inconsistent. In the error case, msg may be set but then points to a
 443    static string (which must not be deallocated).
 444 */
 445
 446                         /* advanced functions */
 447
 448 /*
 449     The following functions are needed only in some special applications.
 450 */
 451
 452 extern int deflateInit2 OF((z_stream *strm,
 453                             int  level,
 454                             int  method,
 455                             int  windowBits,
 456                             int  memLevel,
 457                             int  strategy,
 458                             int  minCompression));
 459 /*
 460      This is another version of deflateInit with more compression options. The
 461    fields next_in, zalloc and zfree must be initialized before by the caller.
 462
 463      The method parameter is the compression method. It must be 8 in this
 464    version of the library. (Method 9 will allow a 64K history buffer and
 465    partial block flushes.)
 466
 467      The windowBits parameter is the base two logarithm of the window size
 468    (the size of the history buffer).  It should be in the range 8..15 for this
 469    version of the library (the value 16 will be allowed for method 9). Larger
 470    values of this parameter result in better compression at the expense of
 471    memory usage. The default value is 15 if deflateInit is used instead.
 472
 473     The memLevel parameter specifies how much memory should be allocated
 474    for the internal compression state. memLevel=1 uses minimum memory but
 475    is slow and reduces compression ratio; memLevel=9 uses maximum memory
 476    for optimal speed. The default value is 8. See zconf.h for total memory
 477    usage as a function of windowBits and memLevel.
 478
 479      The strategy parameter is used to tune the compression algorithm. Use
 480    the value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data
 481    produced by a filter (or predictor), or Z_HUFFMAN_ONLY to force Huffman
 482    encoding only (no string match).  Filtered data consists mostly of small
 483    values with a somewhat random distribution. In this case, the
 484    compression algorithm is tuned to compress them better. The strategy
 485    parameter only affects the compression ratio but not the correctness of
 486    the compressed output even if it is not set appropriately.
 487
 488      The minCompression parameter specifies the minimum reduction in size
 489    required for a compressed block to be output when Z_PACKET_FLUSH is
 490    used (see the description of deflate above).
 491
 492      If next_in is not null, the library will use this buffer to hold also
 493    some history information; the buffer must either hold the entire input
 494    data, or have at least 1<<(windowBits+1) bytes and be writable. If next_in
 495    is null, the library will allocate its own history buffer (and leave next_in
 496    null). next_out need not be provided here but must be provided by the
 497    application for the next call of deflate().
 498
 499      If the history buffer is provided by the application, next_in must
 500    must never be changed by the application since the compressor maintains
 501    information inside this buffer from call to call; the application
 502    must provide more input only by increasing avail_in. next_in is always
 503    reset by the library in this case.
 504
 505       deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was
 506    not enough memory, Z_STREAM_ERROR if a parameter is invalid (such as
 507    an invalid method). msg is set to null if there is no error message.
 508    deflateInit2 does not perform any compression: this will be done by
 509    deflate().
 510 */
 511
 512 extern int deflateCopy OF((z_stream *dest,
 513                            z_stream *source));
 514 /*
 515      Sets the destination stream as a complete copy of the source stream.  If
 516    the source stream is using an application-supplied history buffer, a new
 517    buffer is allocated for the destination stream.  The compressed output
 518    buffer is always application-supplied. It's the responsibility of the
 519    application to provide the correct values of next_out and avail_out for the
 520    next call of deflate.
 521
 522      This function is useful when several compression strategies will be
 523    tried, for example when there are several ways of pre-processing the input
 524    data with a filter. The streams that will be discarded should then be freed
 525    by calling deflateEnd.  Note that deflateCopy duplicates the internal
 526    compression state which can be quite large, so this strategy is slow and
 527    can consume lots of memory.
 528
 529       deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not
 530    enough memory, Z_STREAM_ERROR if the source stream state was inconsistent
 531    (such as zalloc being NULL). msg is left unchanged in both source and
 532    destination.
 533 */
 534
 535 extern int deflateReset OF((z_stream *strm));
 536 /*
 537      This function is equivalent to deflateEnd followed by deflateInit,
 538    but does not free and reallocate all the internal compression state.
 539    The stream will keep the same compression level and any other attributes
 540    that may have been set by deflateInit2.
 541
 542       deflateReset 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
 546 extern int inflateInit2 OF((z_stream *strm,
 547                             int  windowBits));
 548 /*
 549      This is another version of inflateInit with more compression options. The
 550    fields next_out, zalloc and zfree must be initialized before by the caller.
 551
 552      The windowBits parameter is the base two logarithm of the maximum window
 553    size (the size of the history buffer).  It should be in the range 8..15 for
 554    this version of the library (the value 16 will be allowed soon). The
 555    default value is 15 if inflateInit is used instead. If a compressed stream
 556    with a larger window size is given as input, inflate() will return with
 557    the error code Z_DATA_ERROR instead of trying to allocate a larger window.
 558
 559      If next_out is not null, the library will use this buffer for the history
 560    buffer; the buffer must either be large enough to hold the entire output
 561    data, or have at least 1<<windowBits bytes.  If next_out is null, the
 562    library will allocate its own buffer (and leave next_out null). next_in
 563    need not be provided here but must be provided by the application for the
 564    next call of inflate().
 565
 566      If the history buffer is provided by the application, next_out must
 567    never be changed by the application since the decompressor maintains
 568    history information inside this buffer from call to call; the application
 569    can only reset next_out to the beginning of the history buffer when
 570    avail_out is zero and all output has been consumed.
 571
 572       inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was
 573    not enough memory, Z_STREAM_ERROR if a parameter is invalid (such as
 574    windowBits < 8). msg is set to null if there is no error message.
 575    inflateInit2 does not perform any decompression: this will be done by
 576    inflate().
 577 */
 578
 579 extern int inflateSync OF((z_stream *strm));
 580 /*
 581     Skips invalid compressed data until the special marker (see deflate()
 582   above) can be found, or until all available input is skipped. No output
 583   is provided.
 584
 585     inflateSync returns Z_OK if the special marker has been found, Z_BUF_ERROR
 586   if no more input was provided, Z_DATA_ERROR if no marker has been found,
 587   or Z_STREAM_ERROR if the stream structure was inconsistent. In the success
 588   case, the application may save the current current value of total_in which
 589   indicates where valid compressed data was found. In the error case, the
 590   application may repeatedly call inflateSync, providing more input each time,
 591   until success or end of the input data.
 592 */
 593
 594 extern int inflateReset OF((z_stream *strm));
 595 /*
 596      This function is equivalent to inflateEnd followed by inflateInit,
 597    but does not free and reallocate all the internal decompression state.
 598    The stream will keep attributes that may have been set by inflateInit2.
 599
 600       inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
 601    stream state was inconsistent (such as zalloc or state being NULL).
 602 */
 603
 604 extern int inflateIncomp OF((z_stream *strm));
 605 /*
 606      This function adds the data at next_in (avail_in bytes) to the output
 607    history without performing any output.  There must be no pending output,
 608    and the decompressor must be expecting to see the start of a block.
 609    Calling this function is equivalent to decompressing a stored block
 610    containing the data at next_in (except that the data is not output).
 611 */
 612
 613                         /* checksum functions */
 614
 615 /*
 616      This function is not related to compression but is exported
 617    anyway because it might be useful in applications using the
 618    compression library.
 619 */
 620
 621 extern uLong adler32 OF((uLong adler, Bytef *buf, uInt len));
 622
 623 /*
 624      Update a running Adler-32 checksum with the bytes buf[0..len-1] and
 625    return the updated checksum. If buf is NULL, this function returns
 626    the required initial value for the checksum.
 627    An Adler-32 checksum is almost as reliable as a CRC32 but can be computed
 628    much faster. Usage example:
 629
 630      uLong adler = adler32(0L, Z_NULL, 0);
 631
 632      while (read_buffer(buffer, length) != EOF) {
 633        adler = adler32(adler, buffer, length);
 634      }
 635      if (adler != original_adler) error();
 636 */
 637
 638 #ifndef _Z_UTIL_H
 639     struct internal_state {int dummy;}; /* hack for buggy compilers */
 640 #endif
 641
 642 #endif /* _ZLIB_H */