~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to src/3rdparty/zlib/zlib.h

  • Committer: Bazaar Package Importer
  • Author(s): Adam Conrad
  • Date: 2005-08-24 04:09:09 UTC
  • Revision ID: james.westby@ubuntu.com-20050824040909-xmxe9jfr4a0w5671
Tags: upstream-4.0.0
ImportĀ upstreamĀ versionĀ 4.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/* zlib.h -- interface of the 'zlib' general purpose compression library
 
2
  version 1.2.2, October 3rd, 2004
 
3
 
 
4
  Copyright (C) 1995-2004 Jean-loup Gailly and Mark Adler
 
5
 
 
6
  This software is provided 'as-is', without any express or implied
 
7
  warranty.  In no event will the authors be held liable for any damages
 
8
  arising from the use of this software.
 
9
 
 
10
  Permission is granted to anyone to use this software for any purpose,
 
11
  including commercial applications, and to alter it and redistribute it
 
12
  freely, subject to the following restrictions:
 
13
 
 
14
  1. The origin of this software must not be misrepresented; you must not
 
15
     claim that you wrote the original software. If you use this software
 
16
     in a product, an acknowledgment in the product documentation would be
 
17
     appreciated but is not required.
 
18
  2. Altered source versions must be plainly marked as such, and must not be
 
19
     misrepresented as being the original software.
 
20
  3. This notice may not be removed or altered from any source distribution.
 
21
 
 
22
  Jean-loup Gailly        Mark Adler
 
23
  jloup@gzip.org          madler@alumni.caltech.edu
 
24
 
 
25
 
 
26
  The data format used by the zlib library is described by RFCs (Request for
 
27
  Comments) 1950 to 1952 in the files http://www.ietf.org/rfc/rfc1950.txt
 
28
  (zlib format), rfc1951.txt (deflate format) and rfc1952.txt (gzip format).
 
29
*/
 
30
 
 
31
#ifndef ZLIB_H
 
32
#define ZLIB_H
 
33
 
 
34
#include "zconf.h"
 
35
 
 
36
#ifdef __cplusplus
 
37
extern "C" {
 
38
#endif
 
39
 
 
40
#define ZLIB_VERSION "1.2.2"
 
41
#define ZLIB_VERNUM 0x1220
 
42
 
 
43
#ifdef QT_MAKEDLL
 
44
#define Q_ZEXPORT __declspec(dllexport)
 
45
#else
 
46
#if defined(QT_DLL) && !defined(QT_PLUGIN)
 
47
#define Q_ZEXPORT __declspec(dllimport)
 
48
#else
 
49
#define Q_ZEXPORT ZEXPORT
 
50
#endif
 
51
#endif
 
52
#ifdef Q_OS_TEMP
 
53
#include <qfunctions_wce.h>
 
54
#endif
 
55
 
 
56
/*
 
57
     The 'zlib' compression library provides in-memory compression and
 
58
  decompression functions, including integrity checks of the uncompressed
 
59
  data.  This version of the library supports only one compression method
 
60
  (deflation) but other algorithms will be added later and will have the same
 
61
  stream interface.
 
62
 
 
63
     Compression can be done in a single step if the buffers are large
 
64
  enough (for example if an input file is mmap'ed), or can be done by
 
65
  repeated calls of the compression function.  In the latter case, the
 
66
  application must provide more input and/or consume the output
 
67
  (providing more output space) before each call.
 
68
 
 
69
     The compressed data format used by default by the in-memory functions is
 
70
  the zlib format, which is a zlib wrapper documented in RFC 1950, wrapped
 
71
  around a deflate stream, which is itself documented in RFC 1951.
 
72
 
 
73
     The library also supports reading and writing files in gzip (.gz) format
 
74
  with an interface similar to that of stdio using the functions that start
 
75
  with "gz".  The gzip format is different from the zlib format.  gzip is a
 
76
  gzip wrapper, documented in RFC 1952, wrapped around a deflate stream.
 
77
 
 
78
     This library can optionally read and write gzip streams in memory as well.
 
79
 
 
80
     The zlib format was designed to be compact and fast for use in memory
 
81
  and on communications channels.  The gzip format was designed for single-
 
82
  file compression on file systems, has a larger header than zlib to maintain
 
83
  directory information, and uses a different, slower check method than zlib.
 
84
 
 
85
     The library does not install any signal handler. The decoder checks
 
86
  the consistency of the compressed data, so the library should never
 
87
  crash even in case of corrupted input.
 
88
*/
 
89
 
 
90
typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size));
 
91
typedef void   (*free_func)  OF((voidpf opaque, voidpf address));
 
92
 
 
93
struct internal_state;
 
94
 
 
95
typedef struct z_stream_s {
 
96
    Bytef    *next_in;  /* next input byte */
 
97
    uInt     avail_in;  /* number of bytes available at next_in */
 
98
    uLong    total_in;  /* total nb of input bytes read so far */
 
99
 
 
100
    Bytef    *next_out; /* next output byte should be put there */
 
101
    uInt     avail_out; /* remaining free space at next_out */
 
102
    uLong    total_out; /* total nb of bytes output so far */
 
103
 
 
104
    char     *msg;      /* last error message, NULL if no error */
 
105
    struct internal_state FAR *state; /* not visible by applications */
 
106
 
 
107
    alloc_func zalloc;  /* used to allocate the internal state */
 
108
    free_func  zfree;   /* used to free the internal state */
 
109
    voidpf     opaque;  /* private data object passed to zalloc and zfree */
 
110
 
 
111
    int     data_type;  /* best guess about the data type: ascii or binary */
 
112
    uLong   adler;      /* adler32 value of the uncompressed data */
 
113
    uLong   reserved;   /* reserved for future use */
 
114
} z_stream;
 
115
 
 
116
typedef z_stream FAR *z_streamp;
 
117
 
 
118
/*
 
119
   The application must update next_in and avail_in when avail_in has
 
120
   dropped to zero. It must update next_out and avail_out when avail_out
 
121
   has dropped to zero. The application must initialize zalloc, zfree and
 
122
   opaque before calling the init function. All other fields are set by the
 
123
   compression library and must not be updated by the application.
 
124
 
 
125
   The opaque value provided by the application will be passed as the first
 
126
   parameter for calls of zalloc and zfree. This can be useful for custom
 
127
   memory management. The compression library attaches no meaning to the
 
128
   opaque value.
 
129
 
 
130
   zalloc must return Z_NULL if there is not enough memory for the object.
 
131
   If zlib is used in a multi-threaded application, zalloc and zfree must be
 
132
   thread safe.
 
133
 
 
134
   On 16-bit systems, the functions zalloc and zfree must be able to allocate
 
135
   exactly 65536 bytes, but will not be required to allocate more than this
 
136
   if the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS,
 
137
   pointers returned by zalloc for objects of exactly 65536 bytes *must*
 
138
   have their offset normalized to zero. The default allocation function
 
139
   provided by this library ensures this (see zutil.c). To reduce memory
 
140
   requirements and avoid any allocation of 64K objects, at the expense of
 
141
   compression ratio, compile the library with -DMAX_WBITS=14 (see zconf.h).
 
142
 
 
143
   The fields total_in and total_out can be used for statistics or
 
144
   progress reports. After compression, total_in holds the total size of
 
145
   the uncompressed data and may be saved for use in the decompressor
 
146
   (particularly if the decompressor wants to decompress everything in
 
147
   a single step).
 
148
*/
 
149
 
 
150
                        /* constants */
 
151
 
 
152
#define Z_NO_FLUSH      0
 
153
#define Z_PARTIAL_FLUSH 1 /* will be removed, use Z_SYNC_FLUSH instead */
 
154
#define Z_SYNC_FLUSH    2
 
155
#define Z_FULL_FLUSH    3
 
156
#define Z_FINISH        4
 
157
#define Z_BLOCK         5
 
158
/* Allowed flush values; see deflate() and inflate() below for details */
 
159
 
 
160
#define Z_OK            0
 
161
#define Z_STREAM_END    1
 
162
#define Z_NEED_DICT     2
 
163
#define Z_ERRNO        (-1)
 
164
#define Z_STREAM_ERROR (-2)
 
165
#define Z_DATA_ERROR   (-3)
 
166
#define Z_MEM_ERROR    (-4)
 
167
#define Z_BUF_ERROR    (-5)
 
168
#define Z_VERSION_ERROR (-6)
 
169
/* Return codes for the compression/decompression functions. Negative
 
170
 * values are errors, positive values are used for special but normal events.
 
171
 */
 
172
 
 
173
#define Z_NO_COMPRESSION         0
 
174
#define Z_BEST_SPEED             1
 
175
#define Z_BEST_COMPRESSION       9
 
176
#define Z_DEFAULT_COMPRESSION  (-1)
 
177
/* compression levels */
 
178
 
 
179
#define Z_FILTERED            1
 
180
#define Z_HUFFMAN_ONLY        2
 
181
#define Z_RLE                 3
 
182
#define Z_DEFAULT_STRATEGY    0
 
183
/* compression strategy; see deflateInit2() below for details */
 
184
 
 
185
#define Z_BINARY   0
 
186
#define Z_ASCII    1
 
187
#define Z_UNKNOWN  2
 
188
/* Possible values of the data_type field (though see inflate()) */
 
189
 
 
190
#define Z_DEFLATED   8
 
191
/* The deflate compression method (the only one supported in this version) */
 
192
 
 
193
#define Z_NULL  0  /* for initializing zalloc, zfree, opaque */
 
194
 
 
195
#define zlib_version zlibVersion()
 
196
/* for compatibility with versions < 1.0.2 */
 
197
 
 
198
                        /* basic functions */
 
199
 
 
200
ZEXTERN Q_ZEXPORT const char * zlibVersion OF((void));
 
201
/* The application can compare zlibVersion and ZLIB_VERSION for consistency.
 
202
   If the first character differs, the library code actually used is
 
203
   not compatible with the zlib.h header file used by the application.
 
204
   This check is automatically made by deflateInit and inflateInit.
 
205
 */
 
206
 
 
207
/*
 
208
ZEXTERN int ZEXPORT deflateInit OF((z_streamp strm, int level));
 
209
 
 
210
     Initializes the internal stream state for compression. The fields
 
211
   zalloc, zfree and opaque must be initialized before by the caller.
 
212
   If zalloc and zfree are set to Z_NULL, deflateInit updates them to
 
213
   use default allocation functions.
 
214
 
 
215
     The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9:
 
216
   1 gives best speed, 9 gives best compression, 0 gives no compression at
 
217
   all (the input data is simply copied a block at a time).
 
218
   Z_DEFAULT_COMPRESSION requests a default compromise between speed and
 
219
   compression (currently equivalent to level 6).
 
220
 
 
221
     deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not
 
222
   enough memory, Z_STREAM_ERROR if level is not a valid compression level,
 
223
   Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible
 
224
   with the version assumed by the caller (ZLIB_VERSION).
 
225
   msg is set to null if there is no error message.  deflateInit does not
 
226
   perform any compression: this will be done by deflate().
 
227
*/
 
228
 
 
229
 
 
230
ZEXTERN int Q_ZEXPORT deflate OF((z_streamp strm, int flush));
 
231
/*
 
232
    deflate compresses as much data as possible, and stops when the input
 
233
  buffer becomes empty or the output buffer becomes full. It may introduce some
 
234
  output latency (reading input without producing any output) except when
 
235
  forced to flush.
 
236
 
 
237
    The detailed semantics are as follows. deflate performs one or both of the
 
238
  following actions:
 
239
 
 
240
  - Compress more input starting at next_in and update next_in and avail_in
 
241
    accordingly. If not all input can be processed (because there is not
 
242
    enough room in the output buffer), next_in and avail_in are updated and
 
243
    processing will resume at this point for the next call of deflate().
 
244
 
 
245
  - Provide more output starting at next_out and update next_out and avail_out
 
246
    accordingly. This action is forced if the parameter flush is non zero.
 
247
    Forcing flush frequently degrades the compression ratio, so this parameter
 
248
    should be set only when necessary (in interactive applications).
 
249
    Some output may be provided even if flush is not set.
 
250
 
 
251
  Before the call of deflate(), the application should ensure that at least
 
252
  one of the actions is possible, by providing more input and/or consuming
 
253
  more output, and updating avail_in or avail_out accordingly; avail_out
 
254
  should never be zero before the call. The application can consume the
 
255
  compressed output when it wants, for example when the output buffer is full
 
256
  (avail_out == 0), or after each call of deflate(). If deflate returns Z_OK
 
257
  and with zero avail_out, it must be called again after making room in the
 
258
  output buffer because there might be more output pending.
 
259
 
 
260
    If the parameter flush is set to Z_SYNC_FLUSH, all pending output is
 
261
  flushed to the output buffer and the output is aligned on a byte boundary, so
 
262
  that the decompressor can get all input data available so far. (In particular
 
263
  avail_in is zero after the call if enough output space has been provided
 
264
  before the call.)  Flushing may degrade compression for some compression
 
265
  algorithms and so it should be used only when necessary.
 
266
 
 
267
    If flush is set to Z_FULL_FLUSH, all output is flushed as with
 
268
  Z_SYNC_FLUSH, and the compression state is reset so that decompression can
 
269
  restart from this point if previous compressed data has been damaged or if
 
270
  random access is desired. Using Z_FULL_FLUSH too often can seriously degrade
 
271
  the compression.
 
272
 
 
273
    If deflate returns with avail_out == 0, this function must be called again
 
274
  with the same value of the flush parameter and more output space (updated
 
275
  avail_out), until the flush is complete (deflate returns with non-zero
 
276
  avail_out). In the case of a Z_FULL_FLUSH or Z_SYNC_FLUSH, make sure that
 
277
  avail_out is greater than six to avoid repeated flush markers due to
 
278
  avail_out == 0 on return.
 
279
 
 
280
    If the parameter flush is set to Z_FINISH, pending input is processed,
 
281
  pending output is flushed and deflate returns with Z_STREAM_END if there
 
282
  was enough output space; if deflate returns with Z_OK, this function must be
 
283
  called again with Z_FINISH and more output space (updated avail_out) but no
 
284
  more input data, until it returns with Z_STREAM_END or an error. After
 
285
  deflate has returned Z_STREAM_END, the only possible operations on the
 
286
  stream are deflateReset or deflateEnd.
 
287
 
 
288
    Z_FINISH can be used immediately after deflateInit if all the compression
 
289
  is to be done in a single step. In this case, avail_out must be at least
 
290
  the value returned by deflateBound (see below). If deflate does not return
 
291
  Z_STREAM_END, then it must be called again as described above.
 
292
 
 
293
    deflate() sets strm->adler to the adler32 checksum of all input read
 
294
  so far (that is, total_in bytes).
 
295
 
 
296
    deflate() may update data_type if it can make a good guess about
 
297
  the input data type (Z_ASCII or Z_BINARY). In doubt, the data is considered
 
298
  binary. This field is only for information purposes and does not affect
 
299
  the compression algorithm in any manner.
 
300
 
 
301
    deflate() returns Z_OK if some progress has been made (more input
 
302
  processed or more output produced), Z_STREAM_END if all input has been
 
303
  consumed and all output has been produced (only when flush is set to
 
304
  Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example
 
305
  if next_in or next_out was NULL), Z_BUF_ERROR if no progress is possible
 
306
  (for example avail_in or avail_out was zero). Note that Z_BUF_ERROR is not
 
307
  fatal, and deflate() can be called again with more input and more output
 
308
  space to continue compressing.
 
309
*/
 
310
 
 
311
 
 
312
ZEXTERN int Q_ZEXPORT deflateEnd OF((z_streamp strm));
 
313
/*
 
314
     All dynamically allocated data structures for this stream are freed.
 
315
   This function discards any unprocessed input and does not flush any
 
316
   pending output.
 
317
 
 
318
     deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the
 
319
   stream state was inconsistent, Z_DATA_ERROR if the stream was freed
 
320
   prematurely (some input or output was discarded). In the error case,
 
321
   msg may be set but then points to a static string (which must not be
 
322
   deallocated).
 
323
*/
 
324
 
 
325
 
 
326
/*
 
327
ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm));
 
328
 
 
329
     Initializes the internal stream state for decompression. The fields
 
330
   next_in, avail_in, zalloc, zfree and opaque must be initialized before by
 
331
   the caller. If next_in is not Z_NULL and avail_in is large enough (the exact
 
332
   value depends on the compression method), inflateInit determines the
 
333
   compression method from the zlib header and allocates all data structures
 
334
   accordingly; otherwise the allocation will be deferred to the first call of
 
335
   inflate.  If zalloc and zfree are set to Z_NULL, inflateInit updates them to
 
336
   use default allocation functions.
 
337
 
 
338
     inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough
 
339
   memory, Z_VERSION_ERROR if the zlib library version is incompatible with the
 
340
   version assumed by the caller.  msg is set to null if there is no error
 
341
   message. inflateInit does not perform any decompression apart from reading
 
342
   the zlib header if present: this will be done by inflate().  (So next_in and
 
343
   avail_in may be modified, but next_out and avail_out are unchanged.)
 
344
*/
 
345
 
 
346
 
 
347
ZEXTERN int Q_ZEXPORT inflate OF((z_streamp strm, int flush));
 
348
/*
 
349
    inflate decompresses as much data as possible, and stops when the input
 
350
  buffer becomes empty or the output buffer becomes full. It may introduce
 
351
  some output latency (reading input without producing any output) except when
 
352
  forced to flush.
 
353
 
 
354
  The detailed semantics are as follows. inflate performs one or both of the
 
355
  following actions:
 
356
 
 
357
  - Decompress more input starting at next_in and update next_in and avail_in
 
358
    accordingly. If not all input can be processed (because there is not
 
359
    enough room in the output buffer), next_in is updated and processing
 
360
    will resume at this point for the next call of inflate().
 
361
 
 
362
  - Provide more output starting at next_out and update next_out and avail_out
 
363
    accordingly.  inflate() provides as much output as possible, until there
 
364
    is no more input data or no more space in the output buffer (see below
 
365
    about the flush parameter).
 
366
 
 
367
  Before the call of inflate(), the application should ensure that at least
 
368
  one of the actions is possible, by providing more input and/or consuming
 
369
  more output, and updating the next_* and avail_* values accordingly.
 
370
  The application can consume the uncompressed output when it wants, for
 
371
  example when the output buffer is full (avail_out == 0), or after each
 
372
  call of inflate(). If inflate returns Z_OK and with zero avail_out, it
 
373
  must be called again after making room in the output buffer because there
 
374
  might be more output pending.
 
375
 
 
376
    The flush parameter of inflate() can be Z_NO_FLUSH, Z_SYNC_FLUSH,
 
377
  Z_FINISH, or Z_BLOCK. Z_SYNC_FLUSH requests that inflate() flush as much
 
378
  output as possible to the output buffer. Z_BLOCK requests that inflate() stop
 
379
  if and when it get to the next deflate block boundary. When decoding the zlib
 
380
  or gzip format, this will cause inflate() to return immediately after the
 
381
  header and before the first block. When doing a raw inflate, inflate() will
 
382
  go ahead and process the first block, and will return when it gets to the end
 
383
  of that block, or when it runs out of data.
 
384
 
 
385
    The Z_BLOCK option assists in appending to or combining deflate streams.
 
386
  Also to assist in this, on return inflate() will set strm->data_type to the
 
387
  number of unused bits in the last byte taken from strm->next_in, plus 64
 
388
  if inflate() is currently decoding the last block in the deflate stream,
 
389
  plus 128 if inflate() returned immediately after decoding an end-of-block
 
390
  code or decoding the complete header up to just before the first byte of the
 
391
  deflate stream. The end-of-block will not be indicated until all of the
 
392
  uncompressed data from that block has been written to strm->next_out.  The
 
393
  number of unused bits may in general be greater than seven, except when
 
394
  bit 7 of data_type is set, in which case the number of unused bits will be
 
395
  less than eight.
 
396
 
 
397
    inflate() should normally be called until it returns Z_STREAM_END or an
 
398
  error. However if all decompression is to be performed in a single step
 
399
  (a single call of inflate), the parameter flush should be set to
 
400
  Z_FINISH. In this case all pending input is processed and all pending
 
401
  output is flushed; avail_out must be large enough to hold all the
 
402
  uncompressed data. (The size of the uncompressed data may have been saved
 
403
  by the compressor for this purpose.) The next operation on this stream must
 
404
  be inflateEnd to deallocate the decompression state. The use of Z_FINISH
 
405
  is never required, but can be used to inform inflate that a faster approach
 
406
  may be used for the single inflate() call.
 
407
 
 
408
     In this implementation, inflate() always flushes as much output as
 
409
  possible to the output buffer, and always uses the faster approach on the
 
410
  first call. So the only effect of the flush parameter in this implementation
 
411
  is on the return value of inflate(), as noted below, or when it returns early
 
412
  because Z_BLOCK is used.
 
413
 
 
414
     If a preset dictionary is needed after this call (see inflateSetDictionary
 
415
  below), inflate sets strm->adler to the adler32 checksum of the dictionary
 
416
  chosen by the compressor and returns Z_NEED_DICT; otherwise it sets
 
417
  strm->adler to the adler32 checksum of all output produced so far (that is,
 
418
  total_out bytes) and returns Z_OK, Z_STREAM_END or an error code as described
 
419
  below. At the end of the stream, inflate() checks that its computed adler32
 
420
  checksum is equal to that saved by the compressor and returns Z_STREAM_END
 
421
  only if the checksum is correct.
 
422
 
 
423
    inflate() will decompress and check either zlib-wrapped or gzip-wrapped
 
424
  deflate data.  The header type is detected automatically.  Any information
 
425
  contained in the gzip header is not retained, so applications that need that
 
426
  information should instead use raw inflate, see inflateInit2() below, or
 
427
  inflateBack() and perform their own processing of the gzip header and
 
428
  trailer.
 
429
 
 
430
    inflate() returns Z_OK if some progress has been made (more input processed
 
431
  or more output produced), Z_STREAM_END if the end of the compressed data has
 
432
  been reached and all uncompressed output has been produced, Z_NEED_DICT if a
 
433
  preset dictionary is needed at this point, Z_DATA_ERROR if the input data was
 
434
  corrupted (input stream not conforming to the zlib format or incorrect check
 
435
  value), Z_STREAM_ERROR if the stream structure was inconsistent (for example
 
436
  if next_in or next_out was NULL), Z_MEM_ERROR if there was not enough memory,
 
437
  Z_BUF_ERROR if no progress is possible or if there was not enough room in the
 
438
  output buffer when Z_FINISH is used. Note that Z_BUF_ERROR is not fatal, and
 
439
  inflate() can be called again with more input and more output space to
 
440
  continue decompressing. If Z_DATA_ERROR is returned, the application may then
 
441
  call inflateSync() to look for a good compression block if a partial recovery
 
442
  of the data is desired.
 
443
*/
 
444
 
 
445
 
 
446
ZEXTERN int Q_ZEXPORT inflateEnd OF((z_streamp strm));
 
447
/*
 
448
     All dynamically allocated data structures for this stream are freed.
 
449
   This function discards any unprocessed input and does not flush any
 
450
   pending output.
 
451
 
 
452
     inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state
 
453
   was inconsistent. In the error case, msg may be set but then points to a
 
454
   static string (which must not be deallocated).
 
455
*/
 
456
 
 
457
                        /* Advanced functions */
 
458
 
 
459
/*
 
460
    The following functions are needed only in some special applications.
 
461
*/
 
462
 
 
463
/*
 
464
ZEXTERN int ZEXPORT deflateInit2 OF((z_streamp strm,
 
465
                                     int  level,
 
466
                                     int  method,
 
467
                                     int  windowBits,
 
468
                                     int  memLevel,
 
469
                                     int  strategy));
 
470
 
 
471
     This is another version of deflateInit with more compression options. The
 
472
   fields next_in, zalloc, zfree and opaque must be initialized before by
 
473
   the caller.
 
474
 
 
475
     The method parameter is the compression method. It must be Z_DEFLATED in
 
476
   this version of the library.
 
477
 
 
478
     The windowBits parameter is the base two logarithm of the window size
 
479
   (the size of the history buffer). It should be in the range 8..15 for this
 
480
   version of the library. Larger values of this parameter result in better
 
481
   compression at the expense of memory usage. The default value is 15 if
 
482
   deflateInit is used instead.
 
483
 
 
484
     windowBits can also be -8..-15 for raw deflate. In this case, -windowBits
 
485
   determines the window size. deflate() will then generate raw deflate data
 
486
   with no zlib header or trailer, and will not compute an adler32 check value.
 
487
 
 
488
     windowBits can also be greater than 15 for optional gzip encoding. Add
 
489
   16 to windowBits to write a simple gzip header and trailer around the
 
490
   compressed data instead of a zlib wrapper. The gzip header will have no
 
491
   file name, no extra data, no comment, no modification time (set to zero),
 
492
   no header crc, and the operating system will be set to 255 (unknown).  If a
 
493
   gzip stream is being written, strm->adler is a crc32 instead of an adler32.
 
494
 
 
495
     The memLevel parameter specifies how much memory should be allocated
 
496
   for the internal compression state. memLevel=1 uses minimum memory but
 
497
   is slow and reduces compression ratio; memLevel=9 uses maximum memory
 
498
   for optimal speed. The default value is 8. See zconf.h for total memory
 
499
   usage as a function of windowBits and memLevel.
 
500
 
 
501
     The strategy parameter is used to tune the compression algorithm. Use the
 
502
   value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a
 
503
   filter (or predictor), Z_HUFFMAN_ONLY to force Huffman encoding only (no
 
504
   string match), or Z_RLE to limit match distances to one (run-length
 
505
   encoding). Filtered data consists mostly of small values with a somewhat
 
506
   random distribution. In this case, the compression algorithm is tuned to
 
507
   compress them better. The effect of Z_FILTERED is to force more Huffman
 
508
   coding and less string matching; it is somewhat intermediate between
 
509
   Z_DEFAULT and Z_HUFFMAN_ONLY. Z_RLE is designed to be almost as fast as
 
510
   Z_HUFFMAN_ONLY, but give better compression for PNG image data. The strategy
 
511
   parameter only affects the compression ratio but not the correctness of the
 
512
   compressed output even if it is not set appropriately.
 
513
 
 
514
      deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
 
515
   memory, Z_STREAM_ERROR if a parameter is invalid (such as an invalid
 
516
   method). msg is set to null if there is no error message.  deflateInit2 does
 
517
   not perform any compression: this will be done by deflate().
 
518
*/
 
519
 
 
520
ZEXTERN int Q_ZEXPORT deflateSetDictionary OF((z_streamp strm,
 
521
                                             const Bytef *dictionary,
 
522
                                             uInt  dictLength));
 
523
/*
 
524
     Initializes the compression dictionary from the given byte sequence
 
525
   without producing any compressed output. This function must be called
 
526
   immediately after deflateInit, deflateInit2 or deflateReset, before any
 
527
   call of deflate. The compressor and decompressor must use exactly the same
 
528
   dictionary (see inflateSetDictionary).
 
529
 
 
530
     The dictionary should consist of strings (byte sequences) that are likely
 
531
   to be encountered later in the data to be compressed, with the most commonly
 
532
   used strings preferably put towards the end of the dictionary. Using a
 
533
   dictionary is most useful when the data to be compressed is short and can be
 
534
   predicted with good accuracy; the data can then be compressed better than
 
535
   with the default empty dictionary.
 
536
 
 
537
     Depending on the size of the compression data structures selected by
 
538
   deflateInit or deflateInit2, a part of the dictionary may in effect be
 
539
   discarded, for example if the dictionary is larger than the window size in
 
540
   deflate or deflate2. Thus the strings most likely to be useful should be
 
541
   put at the end of the dictionary, not at the front.
 
542
 
 
543
     Upon return of this function, strm->adler is set to the adler32 value
 
544
   of the dictionary; the decompressor may later use this value to determine
 
545
   which dictionary has been used by the compressor. (The adler32 value
 
546
   applies to the whole dictionary even if only a subset of the dictionary is
 
547
   actually used by the compressor.) If a raw deflate was requested, then the
 
548
   adler32 value is not computed and strm->adler is not set.
 
549
 
 
550
     deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a
 
551
   parameter is invalid (such as NULL dictionary) or the stream state is
 
552
   inconsistent (for example if deflate has already been called for this stream
 
553
   or if the compression method is bsort). deflateSetDictionary does not
 
554
   perform any compression: this will be done by deflate().
 
555
*/
 
556
 
 
557
ZEXTERN int Q_ZEXPORT deflateCopy OF((z_streamp dest,
 
558
                                    z_streamp source));
 
559
/*
 
560
     Sets the destination stream as a complete copy of the source stream.
 
561
 
 
562
     This function can be useful when several compression strategies will be
 
563
   tried, for example when there are several ways of pre-processing the input
 
564
   data with a filter. The streams that will be discarded should then be freed
 
565
   by calling deflateEnd.  Note that deflateCopy duplicates the internal
 
566
   compression state which can be quite large, so this strategy is slow and
 
567
   can consume lots of memory.
 
568
 
 
569
     deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not
 
570
   enough memory, Z_STREAM_ERROR if the source stream state was inconsistent
 
571
   (such as zalloc being NULL). msg is left unchanged in both source and
 
572
   destination.
 
573
*/
 
574
 
 
575
ZEXTERN int Q_ZEXPORT deflateReset OF((z_streamp strm));
 
576
/*
 
577
     This function is equivalent to deflateEnd followed by deflateInit,
 
578
   but does not free and reallocate all the internal compression state.
 
579
   The stream will keep the same compression level and any other attributes
 
580
   that may have been set by deflateInit2.
 
581
 
 
582
      deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
 
583
   stream state was inconsistent (such as zalloc or state being NULL).
 
584
*/
 
585
 
 
586
ZEXTERN int Q_ZEXPORT deflateParams OF((z_streamp strm,
 
587
                                      int level,
 
588
                                      int strategy));
 
589
/*
 
590
     Dynamically update the compression level and compression strategy.  The
 
591
   interpretation of level and strategy is as in deflateInit2.  This can be
 
592
   used to switch between compression and straight copy of the input data, or
 
593
   to switch to a different kind of input data requiring a different
 
594
   strategy. If the compression level is changed, the input available so far
 
595
   is compressed with the old level (and may be flushed); the new level will
 
596
   take effect only at the next call of deflate().
 
597
 
 
598
     Before the call of deflateParams, the stream state must be set as for
 
599
   a call of deflate(), since the currently available input may have to
 
600
   be compressed and flushed. In particular, strm->avail_out must be non-zero.
 
601
 
 
602
     deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source
 
603
   stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR
 
604
   if strm->avail_out was zero.
 
605
*/
 
606
 
 
607
ZEXTERN uLong ZEXPORT deflateBound OF((z_streamp strm,
 
608
                                       uLong sourceLen));
 
609
/*
 
610
     deflateBound() returns an upper bound on the compressed size after
 
611
   deflation of sourceLen bytes.  It must be called after deflateInit()
 
612
   or deflateInit2().  This would be used to allocate an output buffer
 
613
   for deflation in a single pass, and so would be called before deflate().
 
614
*/
 
615
 
 
616
ZEXTERN int ZEXPORT deflatePrime OF((z_streamp strm,
 
617
                                     int bits,
 
618
                                     int value));
 
619
/*
 
620
     deflatePrime() inserts bits in the deflate output stream.  The intent
 
621
  is that this function is used to start off the deflate output with the
 
622
  bits leftover from a previous deflate stream when appending to it.  As such,
 
623
  this function can only be used for raw deflate, and must be used before the
 
624
  first deflate() call after a deflateInit2() or deflateReset().  bits must be
 
625
  less than or equal to 16, and that many of the least significant bits of
 
626
  value will be inserted in the output.
 
627
 
 
628
      deflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source
 
629
   stream state was inconsistent.
 
630
*/
 
631
 
 
632
/*
 
633
ZEXTERN int ZEXPORT inflateInit2 OF((z_streamp strm,
 
634
                                     int  windowBits));
 
635
 
 
636
     This is another version of inflateInit with an extra parameter. The
 
637
   fields next_in, avail_in, zalloc, zfree and opaque must be initialized
 
638
   before by the caller.
 
639
 
 
640
     The windowBits parameter is the base two logarithm of the maximum window
 
641
   size (the size of the history buffer).  It should be in the range 8..15 for
 
642
   this version of the library. The default value is 15 if inflateInit is used
 
643
   instead. windowBits must be greater than or equal to the windowBits value
 
644
   provided to deflateInit2() while compressing, or it must be equal to 15 if
 
645
   deflateInit2() was not used. If a compressed stream with a larger window
 
646
   size is given as input, inflate() will return with the error code
 
647
   Z_DATA_ERROR instead of trying to allocate a larger window.
 
648
 
 
649
     windowBits can also be -8..-15 for raw inflate. In this case, -windowBits
 
650
   determines the window size. inflate() will then process raw deflate data,
 
651
   not looking for a zlib or gzip header, not generating a check value, and not
 
652
   looking for any check values for comparison at the end of the stream. This
 
653
   is for use with other formats that use the deflate compressed data format
 
654
   such as zip.  Those formats provide their own check values. If a custom
 
655
   format is developed using the raw deflate format for compressed data, it is
 
656
   recommended that a check value such as an adler32 or a crc32 be applied to
 
657
   the uncompressed data as is done in the zlib, gzip, and zip formats.  For
 
658
   most applications, the zlib format should be used as is. Note that comments
 
659
   above on the use in deflateInit2() applies to the magnitude of windowBits.
 
660
 
 
661
     windowBits can also be greater than 15 for optional gzip decoding. Add
 
662
   32 to windowBits to enable zlib and gzip decoding with automatic header
 
663
   detection, or add 16 to decode only the gzip format (the zlib format will
 
664
   return a Z_DATA_ERROR.  If a gzip stream is being decoded, strm->adler is
 
665
   a crc32 instead of an adler32.
 
666
 
 
667
     inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
 
668
   memory, Z_STREAM_ERROR if a parameter is invalid (such as a negative
 
669
   memLevel). msg is set to null if there is no error message.  inflateInit2
 
670
   does not perform any decompression apart from reading the zlib header if
 
671
   present: this will be done by inflate(). (So next_in and avail_in may be
 
672
   modified, but next_out and avail_out are unchanged.)
 
673
*/
 
674
 
 
675
ZEXTERN int Q_ZEXPORT inflateSetDictionary OF((z_streamp strm,
 
676
                                             const Bytef *dictionary,
 
677
                                             uInt  dictLength));
 
678
/*
 
679
     Initializes the decompression dictionary from the given uncompressed byte
 
680
   sequence. This function must be called immediately after a call of inflate
 
681
   if this call returned Z_NEED_DICT. The dictionary chosen by the compressor
 
682
   can be determined from the adler32 value returned by this call of
 
683
   inflate. The compressor and decompressor must use exactly the same
 
684
   dictionary (see deflateSetDictionary).
 
685
 
 
686
     inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a
 
687
   parameter is invalid (such as NULL dictionary) or the stream state is
 
688
   inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the
 
689
   expected one (incorrect adler32 value). inflateSetDictionary does not
 
690
   perform any decompression: this will be done by subsequent calls of
 
691
   inflate().
 
692
*/
 
693
 
 
694
ZEXTERN int Q_ZEXPORT inflateSync OF((z_streamp strm));
 
695
/*
 
696
    Skips invalid compressed data until a full flush point (see above the
 
697
  description of deflate with Z_FULL_FLUSH) can be found, or until all
 
698
  available input is skipped. No output is provided.
 
699
 
 
700
    inflateSync returns Z_OK if a full flush point has been found, Z_BUF_ERROR
 
701
  if no more input was provided, Z_DATA_ERROR if no flush point has been found,
 
702
  or Z_STREAM_ERROR if the stream structure was inconsistent. In the success
 
703
  case, the application may save the current current value of total_in which
 
704
  indicates where valid compressed data was found. In the error case, the
 
705
  application may repeatedly call inflateSync, providing more input each time,
 
706
  until success or end of the input data.
 
707
*/
 
708
 
 
709
ZEXTERN int ZEXPORT inflateCopy OF((z_streamp dest,
 
710
                                    z_streamp source));
 
711
/*
 
712
     Sets the destination stream as a complete copy of the source stream.
 
713
 
 
714
     This function can be useful when randomly accessing a large stream.  The
 
715
   first pass through the stream can periodically record the inflate state,
 
716
   allowing restarting inflate at those points when randomly accessing the
 
717
   stream.
 
718
 
 
719
     inflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not
 
720
   enough memory, Z_STREAM_ERROR if the source stream state was inconsistent
 
721
   (such as zalloc being NULL). msg is left unchanged in both source and
 
722
   destination.
 
723
*/
 
724
 
 
725
ZEXTERN int Q_ZEXPORT inflateReset OF((z_streamp strm));
 
726
/*
 
727
     This function is equivalent to inflateEnd followed by inflateInit,
 
728
   but does not free and reallocate all the internal decompression state.
 
729
   The stream will keep attributes that may have been set by inflateInit2.
 
730
 
 
731
      inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
 
732
   stream state was inconsistent (such as zalloc or state being NULL).
 
733
*/
 
734
 
 
735
/*
 
736
ZEXTERN int ZEXPORT inflateBackInit OF((z_stream FAR *strm, int windowBits,
 
737
                                        unsigned char FAR *window));
 
738
 
 
739
     Initialize the internal stream state for decompression using inflateBack()
 
740
   calls.  The fields zalloc, zfree and opaque in strm must be initialized
 
741
   before the call.  If zalloc and zfree are Z_NULL, then the default library-
 
742
   derived memory allocation routines are used.  windowBits is the base two
 
743
   logarithm of the window size, in the range 8..15.  window is a caller
 
744
   supplied buffer of that size.  Except for special applications where it is
 
745
   assured that deflate was used with small window sizes, windowBits must be 15
 
746
   and a 32K byte window must be supplied to be able to decompress general
 
747
   deflate streams.
 
748
 
 
749
     See inflateBack() for the usage of these routines.
 
750
 
 
751
     inflateBackInit will return Z_OK on success, Z_STREAM_ERROR if any of
 
752
   the paramaters are invalid, Z_MEM_ERROR if the internal state could not
 
753
   be allocated, or Z_VERSION_ERROR if the version of the library does not
 
754
   match the version of the header file.
 
755
*/
 
756
 
 
757
typedef unsigned (*in_func) OF((void FAR *, unsigned char FAR * FAR *));
 
758
typedef int (*out_func) OF((void FAR *, unsigned char FAR *, unsigned));
 
759
 
 
760
ZEXTERN int ZEXPORT inflateBack OF((z_stream FAR *strm,
 
761
                                    in_func in, void FAR *in_desc,
 
762
                                    out_func out, void FAR *out_desc));
 
763
/*
 
764
     inflateBack() does a raw inflate with a single call using a call-back
 
765
   interface for input and output.  This is more efficient than inflate() for
 
766
   file i/o applications in that it avoids copying between the output and the
 
767
   sliding window by simply making the window itself the output buffer.  This
 
768
   function trusts the application to not change the output buffer passed by
 
769
   the output function, at least until inflateBack() returns.
 
770
 
 
771
     inflateBackInit() must be called first to allocate the internal state
 
772
   and to initialize the state with the user-provided window buffer.
 
773
   inflateBack() may then be used multiple times to inflate a complete, raw
 
774
   deflate stream with each call.  inflateBackEnd() is then called to free
 
775
   the allocated state.
 
776
 
 
777
     A raw deflate stream is one with no zlib or gzip header or trailer.
 
778
   This routine would normally be used in a utility that reads zip or gzip
 
779
   files and writes out uncompressed files.  The utility would decode the
 
780
   header and process the trailer on its own, hence this routine expects
 
781
   only the raw deflate stream to decompress.  This is different from the
 
782
   normal behavior of inflate(), which expects either a zlib or gzip header and
 
783
   trailer around the deflate stream.
 
784
 
 
785
     inflateBack() uses two subroutines supplied by the caller that are then
 
786
   called by inflateBack() for input and output.  inflateBack() calls those
 
787
   routines until it reads a complete deflate stream and writes out all of the
 
788
   uncompressed data, or until it encounters an error.  The function's
 
789
   parameters and return types are defined above in the in_func and out_func
 
790
   typedefs.  inflateBack() will call in(in_desc, &buf) which should return the
 
791
   number of bytes of provided input, and a pointer to that input in buf.  If
 
792
   there is no input available, in() must return zero--buf is ignored in that
 
793
   case--and inflateBack() will return a buffer error.  inflateBack() will call
 
794
   out(out_desc, buf, len) to write the uncompressed data buf[0..len-1].  out()
 
795
   should return zero on success, or non-zero on failure.  If out() returns
 
796
   non-zero, inflateBack() will return with an error.  Neither in() nor out()
 
797
   are permitted to change the contents of the window provided to
 
798
   inflateBackInit(), which is also the buffer that out() uses to write from.
 
799
   The length written by out() will be at most the window size.  Any non-zero
 
800
   amount of input may be provided by in().
 
801
 
 
802
     For convenience, inflateBack() can be provided input on the first call by
 
803
   setting strm->next_in and strm->avail_in.  If that input is exhausted, then
 
804
   in() will be called.  Therefore strm->next_in must be initialized before
 
805
   calling inflateBack().  If strm->next_in is Z_NULL, then in() will be called
 
806
   immediately for input.  If strm->next_in is not Z_NULL, then strm->avail_in
 
807
   must also be initialized, and then if strm->avail_in is not zero, input will
 
808
   initially be taken from strm->next_in[0 .. strm->avail_in - 1].
 
809
 
 
810
     The in_desc and out_desc parameters of inflateBack() is passed as the
 
811
   first parameter of in() and out() respectively when they are called.  These
 
812
   descriptors can be optionally used to pass any information that the caller-
 
813
   supplied in() and out() functions need to do their job.
 
814
 
 
815
     On return, inflateBack() will set strm->next_in and strm->avail_in to
 
816
   pass back any unused input that was provided by the last in() call.  The
 
817
   return values of inflateBack() can be Z_STREAM_END on success, Z_BUF_ERROR
 
818
   if in() or out() returned an error, Z_DATA_ERROR if there was a format
 
819
   error in the deflate stream (in which case strm->msg is set to indicate the
 
820
   nature of the error), or Z_STREAM_ERROR if the stream was not properly
 
821
   initialized.  In the case of Z_BUF_ERROR, an input or output error can be
 
822
   distinguished using strm->next_in which will be Z_NULL only if in() returned
 
823
   an error.  If strm->next is not Z_NULL, then the Z_BUF_ERROR was due to
 
824
   out() returning non-zero.  (in() will always be called before out(), so
 
825
   strm->next_in is assured to be defined if out() returns non-zero.)  Note
 
826
   that inflateBack() cannot return Z_OK.
 
827
*/
 
828
 
 
829
ZEXTERN int ZEXPORT inflateBackEnd OF((z_stream FAR *strm));
 
830
/*
 
831
     All memory allocated by inflateBackInit() is freed.
 
832
 
 
833
     inflateBackEnd() returns Z_OK on success, or Z_STREAM_ERROR if the stream
 
834
   state was inconsistent.
 
835
*/
 
836
 
 
837
ZEXTERN uLong ZEXPORT zlibCompileFlags OF((void));
 
838
/* Return flags indicating compile-time options.
 
839
 
 
840
    Type sizes, two bits each, 00 = 16 bits, 01 = 32, 10 = 64, 11 = other:
 
841
     1.0: size of uInt
 
842
     3.2: size of uLong
 
843
     5.4: size of voidpf (pointer)
 
844
     7.6: size of z_off_t
 
845
 
 
846
    Compiler, assembler, and debug options:
 
847
     8: DEBUG
 
848
     9: ASMV or ASMINF -- use ASM code
 
849
     10: ZLIB_WINAPI -- exported functions use the WINAPI calling convention
 
850
     11: 0 (reserved)
 
851
 
 
852
    One-time table building (smaller code, but not thread-safe if true):
 
853
     12: BUILDFIXED -- build static block decoding tables when needed
 
854
     13: DYNAMIC_CRC_TABLE -- build CRC calculation tables when needed
 
855
     14,15: 0 (reserved)
 
856
 
 
857
    Library content (indicates missing functionality):
 
858
     16: NO_GZCOMPRESS -- gz* functions cannot compress (to avoid linking
 
859
                          deflate code when not needed)
 
860
     17: NO_GZIP -- deflate can't write gzip streams, and inflate can't detect
 
861
                    and decode gzip streams (to avoid linking crc code)
 
862
     18-19: 0 (reserved)
 
863
 
 
864
    Operation variations (changes in library functionality):
 
865
     20: PKZIP_BUG_WORKAROUND -- slightly more permissive inflate
 
866
     21: FASTEST -- deflate algorithm with only one, lowest compression level
 
867
     22,23: 0 (reserved)
 
868
 
 
869
    The sprintf variant used by gzprintf (zero is best):
 
870
     24: 0 = vs*, 1 = s* -- 1 means limited to 20 arguments after the format
 
871
     25: 0 = *nprintf, 1 = *printf -- 1 means gzprintf() not secure!
 
872
     26: 0 = returns value, 1 = void -- 1 means inferred string length returned
 
873
 
 
874
    Remainder:
 
875
     27-31: 0 (reserved)
 
876
 */
 
877
 
 
878
 
 
879
                        /* utility functions */
 
880
 
 
881
/*
 
882
     The following utility functions are implemented on top of the
 
883
   basic stream-oriented functions. To simplify the interface, some
 
884
   default options are assumed (compression level and memory usage,
 
885
   standard memory allocation functions). The source code of these
 
886
   utility functions can easily be modified if you need special options.
 
887
*/
 
888
 
 
889
ZEXTERN int Q_ZEXPORT compress OF((Bytef *dest,   uLongf *destLen,
 
890
                                 const Bytef *source, uLong sourceLen));
 
891
/*
 
892
     Compresses the source buffer into the destination buffer.  sourceLen is
 
893
   the byte length of the source buffer. Upon entry, destLen is the total
 
894
   size of the destination buffer, which must be at least the value returned
 
895
   by compressBound(sourceLen). Upon exit, destLen is the actual size of the
 
896
   compressed buffer.
 
897
     This function can be used to compress a whole file at once if the
 
898
   input file is mmap'ed.
 
899
     compress returns Z_OK if success, Z_MEM_ERROR if there was not
 
900
   enough memory, Z_BUF_ERROR if there was not enough room in the output
 
901
   buffer.
 
902
*/
 
903
 
 
904
ZEXTERN int Q_ZEXPORT compress2 OF((Bytef *dest,   uLongf *destLen,
 
905
                                  const Bytef *source, uLong sourceLen,
 
906
                                  int level));
 
907
/*
 
908
     Compresses the source buffer into the destination buffer. The level
 
909
   parameter has the same meaning as in deflateInit.  sourceLen is the byte
 
910
   length of the source buffer. Upon entry, destLen is the total size of the
 
911
   destination buffer, which must be at least the value returned by
 
912
   compressBound(sourceLen). Upon exit, destLen is the actual size of the
 
913
   compressed buffer.
 
914
 
 
915
     compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
 
916
   memory, Z_BUF_ERROR if there was not enough room in the output buffer,
 
917
   Z_STREAM_ERROR if the level parameter is invalid.
 
918
*/
 
919
 
 
920
ZEXTERN uLong ZEXPORT compressBound OF((uLong sourceLen));
 
921
/*
 
922
     compressBound() returns an upper bound on the compressed size after
 
923
   compress() or compress2() on sourceLen bytes.  It would be used before
 
924
   a compress() or compress2() call to allocate the destination buffer.
 
925
*/
 
926
 
 
927
ZEXTERN int Q_ZEXPORT uncompress OF((Bytef *dest,   uLongf *destLen,
 
928
                                   const Bytef *source, uLong sourceLen));
 
929
/*
 
930
     Decompresses the source buffer into the destination buffer.  sourceLen is
 
931
   the byte length of the source buffer. Upon entry, destLen is the total
 
932
   size of the destination buffer, which must be large enough to hold the
 
933
   entire uncompressed data. (The size of the uncompressed data must have
 
934
   been saved previously by the compressor and transmitted to the decompressor
 
935
   by some mechanism outside the scope of this compression library.)
 
936
   Upon exit, destLen is the actual size of the compressed buffer.
 
937
     This function can be used to decompress a whole file at once if the
 
938
   input file is mmap'ed.
 
939
 
 
940
     uncompress returns Z_OK if success, Z_MEM_ERROR if there was not
 
941
   enough memory, Z_BUF_ERROR if there was not enough room in the output
 
942
   buffer, or Z_DATA_ERROR if the input data was corrupted or incomplete.
 
943
*/
 
944
 
 
945
 
 
946
typedef voidp gzFile;
 
947
 
 
948
ZEXTERN gzFile Q_ZEXPORT gzopen  OF((const char *path, const char *mode));
 
949
/*
 
950
     Opens a gzip (.gz) file for reading or writing. The mode parameter
 
951
   is as in fopen ("rb" or "wb") but can also include a compression level
 
952
   ("wb9") or a strategy: 'f' for filtered data as in "wb6f", 'h' for
 
953
   Huffman only compression as in "wb1h", or 'R' for run-length encoding
 
954
   as in "wb1R". (See the description of deflateInit2 for more information
 
955
   about the strategy parameter.)
 
956
 
 
957
     gzopen can be used to read a file which is not in gzip format; in this
 
958
   case gzread will directly read from the file without decompression.
 
959
 
 
960
     gzopen returns NULL if the file could not be opened or if there was
 
961
   insufficient memory to allocate the (de)compression state; errno
 
962
   can be checked to distinguish the two cases (if errno is zero, the
 
963
   zlib error is Z_MEM_ERROR).  */
 
964
 
 
965
ZEXTERN gzFile Q_ZEXPORT gzdopen  OF((int fd, const char *mode));
 
966
/*
 
967
     gzdopen() associates a gzFile with the file descriptor fd.  File
 
968
   descriptors are obtained from calls like open, dup, creat, pipe or
 
969
   fileno (in the file has been previously opened with fopen).
 
970
   The mode parameter is as in gzopen.
 
971
     The next call of gzclose on the returned gzFile will also close the
 
972
   file descriptor fd, just like fclose(fdopen(fd), mode) closes the file
 
973
   descriptor fd. If you want to keep fd open, use gzdopen(dup(fd), mode).
 
974
     gzdopen returns NULL if there was insufficient memory to allocate
 
975
   the (de)compression state.
 
976
*/
 
977
 
 
978
ZEXTERN int Q_ZEXPORT gzsetparams OF((gzFile file, int level, int strategy));
 
979
/*
 
980
     Dynamically update the compression level or strategy. See the description
 
981
   of deflateInit2 for the meaning of these parameters.
 
982
     gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not
 
983
   opened for writing.
 
984
*/
 
985
 
 
986
ZEXTERN int Q_ZEXPORT    gzread  OF((gzFile file, voidp buf, unsigned len));
 
987
/*
 
988
     Reads the given number of uncompressed bytes from the compressed file.
 
989
   If the input file was not in gzip format, gzread copies the given number
 
990
   of bytes into the buffer.
 
991
     gzread returns the number of uncompressed bytes actually read (0 for
 
992
   end of file, -1 for error). */
 
993
 
 
994
ZEXTERN int Q_ZEXPORT    gzwrite OF((gzFile file,
 
995
                                   voidpc buf, unsigned len));
 
996
/*
 
997
     Writes the given number of uncompressed bytes into the compressed file.
 
998
   gzwrite returns the number of uncompressed bytes actually written
 
999
   (0 in case of error).
 
1000
*/
 
1001
 
 
1002
ZEXTERN int ZEXPORTVA   gzprintf OF((gzFile file, const char *format, ...));
 
1003
/*
 
1004
     Converts, formats, and writes the args to the compressed file under
 
1005
   control of the format string, as in fprintf. gzprintf returns the number of
 
1006
   uncompressed bytes actually written (0 in case of error).  The number of
 
1007
   uncompressed bytes written is limited to 4095. The caller should assure that
 
1008
   this limit is not exceeded. If it is exceeded, then gzprintf() will return
 
1009
   return an error (0) with nothing written. In this case, there may also be a
 
1010
   buffer overflow with unpredictable consequences, which is possible only if
 
1011
   zlib was compiled with the insecure functions sprintf() or vsprintf()
 
1012
   because the secure snprintf() or vsnprintf() functions were not available.
 
1013
*/
 
1014
 
 
1015
ZEXTERN int Q_ZEXPORT gzputs OF((gzFile file, const char *s));
 
1016
/*
 
1017
      Writes the given null-terminated string to the compressed file, excluding
 
1018
   the terminating null character.
 
1019
      gzputs returns the number of characters written, or -1 in case of error.
 
1020
*/
 
1021
 
 
1022
ZEXTERN Q_ZEXPORT char * gzgets OF((gzFile file, char *buf, int len));
 
1023
/*
 
1024
      Reads bytes from the compressed file until len-1 characters are read, or
 
1025
   a newline character is read and transferred to buf, or an end-of-file
 
1026
   condition is encountered.  The string is then terminated with a null
 
1027
   character.
 
1028
      gzgets returns buf, or Z_NULL in case of error.
 
1029
*/
 
1030
 
 
1031
ZEXTERN int Q_ZEXPORT    gzputc OF((gzFile file, int c));
 
1032
/*
 
1033
      Writes c, converted to an unsigned char, into the compressed file.
 
1034
   gzputc returns the value that was written, or -1 in case of error.
 
1035
*/
 
1036
 
 
1037
ZEXTERN int Q_ZEXPORT    gzgetc OF((gzFile file));
 
1038
/*
 
1039
      Reads one byte from the compressed file. gzgetc returns this byte
 
1040
   or -1 in case of end of file or error.
 
1041
*/
 
1042
 
 
1043
ZEXTERN int ZEXPORT    gzungetc OF((int c, gzFile file));
 
1044
/*
 
1045
      Push one character back onto the stream to be read again later.
 
1046
   Only one character of push-back is allowed.  gzungetc() returns the
 
1047
   character pushed, or -1 on failure.  gzungetc() will fail if a
 
1048
   character has been pushed but not read yet, or if c is -1. The pushed
 
1049
   character will be discarded if the stream is repositioned with gzseek()
 
1050
   or gzrewind().
 
1051
*/
 
1052
 
 
1053
ZEXTERN int Q_ZEXPORT    gzflush OF((gzFile file, int flush));
 
1054
/*
 
1055
     Flushes all pending output into the compressed file. The parameter
 
1056
   flush is as in the deflate() function. The return value is the zlib
 
1057
   error number (see function gzerror below). gzflush returns Z_OK if
 
1058
   the flush parameter is Z_FINISH and all output could be flushed.
 
1059
     gzflush should be called only when strictly necessary because it can
 
1060
   degrade compression.
 
1061
*/
 
1062
 
 
1063
ZEXTERN z_off_t Q_ZEXPORT    gzseek OF((gzFile file,
 
1064
                                      z_off_t offset, int whence));
 
1065
/*
 
1066
      Sets the starting position for the next gzread or gzwrite on the
 
1067
   given compressed file. The offset represents a number of bytes in the
 
1068
   uncompressed data stream. The whence parameter is defined as in lseek(2);
 
1069
   the value SEEK_END is not supported.
 
1070
     If the file is opened for reading, this function is emulated but can be
 
1071
   extremely slow. If the file is opened for writing, only forward seeks are
 
1072
   supported; gzseek then compresses a sequence of zeroes up to the new
 
1073
   starting position.
 
1074
 
 
1075
      gzseek returns the resulting offset location as measured in bytes from
 
1076
   the beginning of the uncompressed stream, or -1 in case of error, in
 
1077
   particular if the file is opened for writing and the new starting position
 
1078
   would be before the current position.
 
1079
*/
 
1080
 
 
1081
ZEXTERN int Q_ZEXPORT    gzrewind OF((gzFile file));
 
1082
/*
 
1083
     Rewinds the given file. This function is supported only for reading.
 
1084
 
 
1085
   gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET)
 
1086
*/
 
1087
 
 
1088
ZEXTERN z_off_t Q_ZEXPORT    gztell OF((gzFile file));
 
1089
/*
 
1090
     Returns the starting position for the next gzread or gzwrite on the
 
1091
   given compressed file. This position represents a number of bytes in the
 
1092
   uncompressed data stream.
 
1093
 
 
1094
   gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR)
 
1095
*/
 
1096
 
 
1097
ZEXTERN int Q_ZEXPORT gzeof OF((gzFile file));
 
1098
/*
 
1099
     Returns 1 when EOF has previously been detected reading the given
 
1100
   input stream, otherwise zero.
 
1101
*/
 
1102
 
 
1103
ZEXTERN int Q_ZEXPORT    gzclose OF((gzFile file));
 
1104
/*
 
1105
     Flushes all pending output if necessary, closes the compressed file
 
1106
   and deallocates all the (de)compression state. The return value is the zlib
 
1107
   error number (see function gzerror below).
 
1108
*/
 
1109
 
 
1110
ZEXTERN Q_ZEXPORT const char * gzerror OF((gzFile file, int *errnum));
 
1111
/*
 
1112
     Returns the error message for the last error which occurred on the
 
1113
   given compressed file. errnum is set to zlib error number. If an
 
1114
   error occurred in the file system and not in the compression library,
 
1115
   errnum is set to Z_ERRNO and the application may consult errno
 
1116
   to get the exact error code.
 
1117
*/
 
1118
 
 
1119
ZEXTERN void ZEXPORT gzclearerr OF((gzFile file));
 
1120
/*
 
1121
     Clears the error and end-of-file flags for file. This is analogous to the
 
1122
   clearerr() function in stdio. This is useful for continuing to read a gzip
 
1123
   file that is being written concurrently.
 
1124
*/
 
1125
 
 
1126
                        /* checksum functions */
 
1127
 
 
1128
/*
 
1129
     These functions are not related to compression but are exported
 
1130
   anyway because they might be useful in applications using the
 
1131
   compression library.
 
1132
*/
 
1133
 
 
1134
ZEXTERN uLong Q_ZEXPORT adler32 OF((uLong adler, const Bytef *buf, uInt len));
 
1135
 
 
1136
/*
 
1137
     Update a running Adler-32 checksum with the bytes buf[0..len-1] and
 
1138
   return the updated checksum. If buf is NULL, this function returns
 
1139
   the required initial value for the checksum.
 
1140
   An Adler-32 checksum is almost as reliable as a CRC32 but can be computed
 
1141
   much faster. Usage example:
 
1142
 
 
1143
     uLong adler = adler32(0L, Z_NULL, 0);
 
1144
 
 
1145
     while (read_buffer(buffer, length) != EOF) {
 
1146
       adler = adler32(adler, buffer, length);
 
1147
     }
 
1148
     if (adler != original_adler) error();
 
1149
*/
 
1150
 
 
1151
ZEXTERN uLong Q_ZEXPORT crc32   OF((uLong crc, const Bytef *buf, uInt len));
 
1152
/*
 
1153
     Update a running crc with the bytes buf[0..len-1] and return the updated
 
1154
   crc. If buf is NULL, this function returns the required initial value
 
1155
   for the crc. Pre- and post-conditioning (one's complement) is performed
 
1156
   within this function so it shouldn't be done by the application.
 
1157
   Usage example:
 
1158
 
 
1159
     uLong crc = crc32(0L, Z_NULL, 0);
 
1160
 
 
1161
     while (read_buffer(buffer, length) != EOF) {
 
1162
       crc = crc32(crc, buffer, length);
 
1163
     }
 
1164
     if (crc != original_crc) error();
 
1165
*/
 
1166
 
 
1167
 
 
1168
                        /* various hacks, don't look :) */
 
1169
 
 
1170
/* deflateInit and inflateInit are macros to allow checking the zlib version
 
1171
 * and the compiler's view of z_stream:
 
1172
 */
 
1173
ZEXTERN int Q_ZEXPORT deflateInit_ OF((z_streamp strm, int level,
 
1174
                                     const char *version, int stream_size));
 
1175
ZEXTERN int Q_ZEXPORT inflateInit_ OF((z_streamp strm,
 
1176
                                     const char *version, int stream_size));
 
1177
ZEXTERN int Q_ZEXPORT deflateInit2_ OF((z_streamp strm, int  level, int  method,
 
1178
                                      int windowBits, int memLevel,
 
1179
                                      int strategy, const char *version,
 
1180
                                      int stream_size));
 
1181
ZEXTERN int Q_ZEXPORT inflateInit2_ OF((z_streamp strm, int  windowBits,
 
1182
                                      const char *version, int stream_size));
 
1183
ZEXTERN int ZEXPORT inflateBackInit_ OF((z_stream FAR *strm, int windowBits,
 
1184
                                         unsigned char FAR *window,
 
1185
                                         const char *version,
 
1186
                                         int stream_size));
 
1187
#define deflateInit(strm, level) \
 
1188
        deflateInit_((strm), (level),       ZLIB_VERSION, sizeof(z_stream))
 
1189
#define inflateInit(strm) \
 
1190
        inflateInit_((strm),                ZLIB_VERSION, sizeof(z_stream))
 
1191
#define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \
 
1192
        deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\
 
1193
                      (strategy),           ZLIB_VERSION, sizeof(z_stream))
 
1194
#define inflateInit2(strm, windowBits) \
 
1195
        inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))
 
1196
#define inflateBackInit(strm, windowBits, window) \
 
1197
        inflateBackInit_((strm), (windowBits), (window), \
 
1198
        ZLIB_VERSION, sizeof(z_stream))
 
1199
 
 
1200
 
 
1201
#if !defined(ZUTIL_H) && !defined(NO_DUMMY_DECL)
 
1202
    struct internal_state {int dummy;}; /* hack for buggy compilers */
 
1203
#endif
 
1204
 
 
1205
ZEXTERN Q_ZEXPORT const char   * zError           OF((int));
 
1206
ZEXTERN int            Q_ZEXPORT inflateSyncPoint OF((z_streamp z));
 
1207
ZEXTERN Q_ZEXPORT const uLongf * get_crc_table    OF((void));
 
1208
 
 
1209
#ifdef __cplusplus
 
1210
}
 
1211
#endif
 
1212
 
 
1213
#endif /* ZLIB_H */