RetroArch
zlib.h
Go to the documentation of this file.
1 #ifndef _COMPAT_ZLIB_H
2 #define _COMPAT_ZLIB_H
3 
4 #ifdef WANT_ZLIB
5 
6 #ifdef RARCH_INTERNAL
7 #include "zconf.h.in"
8 #endif
9 
10 /* zlib.h -- interface of the 'zlib' general purpose compression library
11  version 1.2.8, April 28th, 2013
12 
13  Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler
14 
15  This software is provided 'as-is', without any express or implied
16  warranty. In no event will the authors be held liable for any damages
17  arising from the use of this software.
18 
19  Permission is granted to anyone to use this software for any purpose,
20  including commercial applications, and to alter it and redistribute it
21  freely, subject to the following restrictions:
22 
23  1. The origin of this software must not be misrepresented; you must not
24  claim that you wrote the original software. If you use this software
25  in a product, an acknowledgment in the product documentation would be
26  appreciated but is not required.
27  2. Altered source versions must be plainly marked as such, and must not be
28  misrepresented as being the original software.
29  3. This notice may not be removed or altered from any source distribution.
30 
31  Jean-loup Gailly Mark Adler
32  jloup@gzip.org madler@alumni.caltech.edu
33 
34 
35  The data format used by the zlib library is described by RFCs (Request for
36  Comments) 1950 to 1952 in the files http://tools.ietf.org/html/rfc1950
37  (zlib format), rfc1951 (deflate format) and rfc1952 (gzip format).
38 */
39 
40 #ifndef ZLIB_H
41 #define ZLIB_H
42 
43 #include <stdint.h>
44 #include "zconf.h"
45 
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49 
50 #define ZLIB_VERSION "1.2.8"
51 #define ZLIB_VERNUM 0x1280
52 #define ZLIB_VER_MAJOR 1
53 #define ZLIB_VER_MINOR 2
54 #define ZLIB_VER_REVISION 8
55 #define ZLIB_VER_SUBREVISION 0
56 
57 /*
58  The 'zlib' compression library provides in-memory compression and
59  decompression functions, including integrity checks of the uncompressed data.
60  This version of the library supports only one compression method (deflation)
61  but other algorithms will be added later and will have the same stream
62  interface.
63 
64  Compression can be done in a single step if the buffers are large enough,
65  or can be done by repeated calls of the compression function. In the latter
66  case, the 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 crash
87  even in case of corrupted input.
88 */
89 
90 typedef voidpf (*alloc_func) (voidpf opaque, uInt items, uInt size);
91 typedef void (*free_func) (voidpf opaque, voidpf address);
92 
93 struct internal_state;
94 
95 typedef struct z_stream_s {
96  z_const Bytef *next_in; /* next input byte */
97  uInt avail_in; /* number of bytes available at next_in */
98  uLong total_in; /* total number 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 number of bytes output so far */
103 
104  z_const char *msg; /* last error message, NULL if no error */
105  void *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: binary or text */
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  gzip header information passed to and from zlib routines. See RFC 1952
120  for more details on the meanings of these fields.
121 */
122 typedef struct gz_header_s {
123  int text; /* true if compressed data believed to be text */
124  uLong time; /* modification time */
125  int xflags; /* extra flags (not used when writing a gzip file) */
126  int os; /* operating system */
127  Bytef *extra; /* pointer to extra field or Z_NULL if none */
128  uInt extra_len; /* extra field length (valid if extra != Z_NULL) */
129  uInt extra_max; /* space at extra (only when reading header) */
130  Bytef *name; /* pointer to zero-terminated file name or Z_NULL */
131  uInt name_max; /* space at name (only when reading header) */
132  Bytef *comment; /* pointer to zero-terminated comment or Z_NULL */
133  uInt comm_max; /* space at comment (only when reading header) */
134  int hcrc; /* true if there was or will be a header crc */
135  int done; /* true when done reading gzip header (not used
136  when writing a gzip file) */
137 } gz_header;
138 
139 typedef gz_header FAR *gz_headerp;
140 
141 /*
142  The application must update next_in and avail_in when avail_in has dropped
143  to zero. It must update next_out and avail_out when avail_out has dropped
144  to zero. The application must initialize zalloc, zfree and opaque before
145  calling the init function. All other fields are set by the compression
146  library and must not be updated by the application.
147 
148  The opaque value provided by the application will be passed as the first
149  parameter for calls of zalloc and zfree. This can be useful for custom
150  memory management. The compression library attaches no meaning to the
151  opaque value.
152 
153  zalloc must return Z_NULL if there is not enough memory for the object.
154  If zlib is used in a multi-threaded application, zalloc and zfree must be
155  thread safe.
156 
157  On 16-bit systems, the functions zalloc and zfree must be able to allocate
158  exactly 65536 bytes, but will not be required to allocate more than this if
159  the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS, pointers
160  returned by zalloc for objects of exactly 65536 bytes *must* have their
161  offset normalized to zero. The default allocation function provided by this
162  library ensures this (see zutil.c). To reduce memory requirements and avoid
163  any allocation of 64K objects, at the expense of compression ratio, compile
164  the library with -DMAX_WBITS=14 (see zconf.h).
165 
166  The fields total_in and total_out can be used for statistics or progress
167  reports. After compression, total_in holds the total size of the
168  uncompressed data and may be saved for use in the decompressor (particularly
169  if the decompressor wants to decompress everything in a single step).
170 */
171 
172  /* constants */
173 
174 #define Z_NO_FLUSH 0
175 #define Z_PARTIAL_FLUSH 1
176 #define Z_SYNC_FLUSH 2
177 #define Z_FULL_FLUSH 3
178 #define Z_FINISH 4
179 #define Z_BLOCK 5
180 #define Z_TREES 6
181 /* Allowed flush values; see deflate() and inflate() below for details */
182 
183 #define Z_OK 0
184 #define Z_STREAM_END 1
185 #define Z_NEED_DICT 2
186 #define Z_ERRNO (-1)
187 #define Z_STREAM_ERROR (-2)
188 #define Z_DATA_ERROR (-3)
189 #define Z_MEM_ERROR (-4)
190 #define Z_BUF_ERROR (-5)
191 #define Z_VERSION_ERROR (-6)
192 /* Return codes for the compression/decompression functions. Negative values
193  * are errors, positive values are used for special but normal events.
194  */
195 
196 #define Z_NO_COMPRESSION 0
197 #define Z_BEST_SPEED 1
198 #define Z_BEST_COMPRESSION 9
199 #define Z_DEFAULT_COMPRESSION (-1)
200 /* compression levels */
201 
202 #define Z_FILTERED 1
203 #define Z_HUFFMAN_ONLY 2
204 #define Z_RLE 3
205 #define Z_FIXED 4
206 #define Z_DEFAULT_STRATEGY 0
207 /* compression strategy; see deflateInit2() below for details */
208 
209 #define Z_BINARY 0
210 #define Z_TEXT 1
211 #define Z_ASCII Z_TEXT /* for compatibility with 1.2.2 and earlier */
212 #define Z_UNKNOWN 2
213 /* Possible values of the data_type field (though see inflate()) */
214 
215 #define Z_DEFLATED 8
216 /* The deflate compression method (the only one supported in this version) */
217 
218 #define Z_NULL 0 /* for initializing zalloc, zfree, opaque */
219 
220 #define zlib_version zlibVersion()
221 /* for compatibility with versions < 1.0.2 */
222 
223 
224  /* basic functions */
225 
226  const char * zlibVersion (void);
227 /* The application can compare zlibVersion and ZLIB_VERSION for consistency.
228  If the first character differs, the library code actually used is not
229  compatible with the zlib.h header file used by the application. This check
230  is automatically made by deflateInit and inflateInit.
231  */
232 
233 /*
234  int deflateInit (z_streamp strm, int level);
235 
236  Initializes the internal stream state for compression. The fields
237  zalloc, zfree and opaque must be initialized before by the caller. If
238  zalloc and zfree are set to Z_NULL, deflateInit updates them to use default
239  allocation functions.
240 
241  The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9:
242  1 gives best speed, 9 gives best compression, 0 gives no compression at all
243  (the input data is simply copied a block at a time). Z_DEFAULT_COMPRESSION
244  requests a default compromise between speed and compression (currently
245  equivalent to level 6).
246 
247  deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough
248  memory, Z_STREAM_ERROR if level is not a valid compression level, or
249  Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible
250  with the version assumed by the caller (ZLIB_VERSION). msg is set to null
251  if there is no error message. deflateInit does not perform any compression:
252  this will be done by deflate().
253 */
254 
255 
256  int deflate (z_streamp strm, int flush);
257 /*
258  deflate compresses as much data as possible, and stops when the input
259  buffer becomes empty or the output buffer becomes full. It may introduce
260  some output latency (reading input without producing any output) except when
261  forced to flush.
262 
263  The detailed semantics are as follows. deflate performs one or both of the
264  following actions:
265 
266  - Compress more input starting at next_in and update next_in and avail_in
267  accordingly. If not all input can be processed (because there is not
268  enough room in the output buffer), next_in and avail_in are updated and
269  processing will resume at this point for the next call of deflate().
270 
271  - Provide more output starting at next_out and update next_out and avail_out
272  accordingly. This action is forced if the parameter flush is non zero.
273  Forcing flush frequently degrades the compression ratio, so this parameter
274  should be set only when necessary (in interactive applications). Some
275  output may be provided even if flush is not set.
276 
277  Before the call of deflate(), the application should ensure that at least
278  one of the actions is possible, by providing more input and/or consuming more
279  output, and updating avail_in or avail_out accordingly; avail_out should
280  never be zero before the call. The application can consume the compressed
281  output when it wants, for example when the output buffer is full (avail_out
282  == 0), or after each call of deflate(). If deflate returns Z_OK and with
283  zero avail_out, it must be called again after making room in the output
284  buffer because there might be more output pending.
285 
286  Normally the parameter flush is set to Z_NO_FLUSH, which allows deflate to
287  decide how much data to accumulate before producing output, in order to
288  maximize compression.
289 
290  If the parameter flush is set to Z_SYNC_FLUSH, all pending output is
291  flushed to the output buffer and the output is aligned on a byte boundary, so
292  that the decompressor can get all input data available so far. (In
293  particular avail_in is zero after the call if enough output space has been
294  provided before the call.) Flushing may degrade compression for some
295  compression algorithms and so it should be used only when necessary. This
296  completes the current deflate block and follows it with an empty stored block
297  that is three bits plus filler bits to the next byte, followed by four bytes
298  (00 00 ff ff).
299 
300  If flush is set to Z_PARTIAL_FLUSH, all pending output is flushed to the
301  output buffer, but the output is not aligned to a byte boundary. All of the
302  input data so far will be available to the decompressor, as for Z_SYNC_FLUSH.
303  This completes the current deflate block and follows it with an empty fixed
304  codes block that is 10 bits long. This assures that enough bytes are output
305  in order for the decompressor to finish the block before the empty fixed code
306  block.
307 
308  If flush is set to Z_BLOCK, a deflate block is completed and emitted, as
309  for Z_SYNC_FLUSH, but the output is not aligned on a byte boundary, and up to
310  seven bits of the current block are held to be written as the next byte after
311  the next deflate block is completed. In this case, the decompressor may not
312  be provided enough bits at this point in order to complete decompression of
313  the data provided so far to the compressor. It may need to wait for the next
314  block to be emitted. This is for advanced applications that need to control
315  the emission of deflate blocks.
316 
317  If flush is set to Z_FULL_FLUSH, all output is flushed as with
318  Z_SYNC_FLUSH, and the compression state is reset so that decompression can
319  restart from this point if previous compressed data has been damaged or if
320  random access is desired. Using Z_FULL_FLUSH too often can seriously degrade
321  compression.
322 
323  If deflate returns with avail_out == 0, this function must be called again
324  with the same value of the flush parameter and more output space (updated
325  avail_out), until the flush is complete (deflate returns with non-zero
326  avail_out). In the case of a Z_FULL_FLUSH or Z_SYNC_FLUSH, make sure that
327  avail_out is greater than six to avoid repeated flush markers due to
328  avail_out == 0 on return.
329 
330  If the parameter flush is set to Z_FINISH, pending input is processed,
331  pending output is flushed and deflate returns with Z_STREAM_END if there was
332  enough output space; if deflate returns with Z_OK, this function must be
333  called again with Z_FINISH and more output space (updated avail_out) but no
334  more input data, until it returns with Z_STREAM_END or an error. After
335  deflate has returned Z_STREAM_END, the only possible operations on the stream
336  are deflateReset or deflateEnd.
337 
338  Z_FINISH can be used immediately after deflateInit if all the compression
339  is to be done in a single step. In this case, avail_out must be at least the
340  value returned by deflateBound (see below). Then deflate is guaranteed to
341  return Z_STREAM_END. If not enough output space is provided, deflate will
342  not return Z_STREAM_END, and it must be called again as described above.
343 
344  deflate() sets strm->adler to the adler32 checksum of all input read
345  so far (that is, total_in bytes).
346 
347  deflate() may update strm->data_type if it can make a good guess about
348  the input data type (Z_BINARY or Z_TEXT). In doubt, the data is considered
349  binary. This field is only for information purposes and does not affect the
350  compression algorithm in any manner.
351 
352  deflate() returns Z_OK if some progress has been made (more input
353  processed or more output produced), Z_STREAM_END if all input has been
354  consumed and all output has been produced (only when flush is set to
355  Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example
356  if next_in or next_out was Z_NULL), Z_BUF_ERROR if no progress is possible
357  (for example avail_in or avail_out was zero). Note that Z_BUF_ERROR is not
358  fatal, and deflate() can be called again with more input and more output
359  space to continue compressing.
360 */
361 
362 
363  int deflateEnd (z_streamp strm);
364 /*
365  All dynamically allocated data structures for this stream are freed.
366  This function discards any unprocessed input and does not flush any pending
367  output.
368 
369  deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the
370  stream state was inconsistent, Z_DATA_ERROR if the stream was freed
371  prematurely (some input or output was discarded). In the error case, msg
372  may be set but then points to a static string (which must not be
373  deallocated).
374 */
375 
376 
377 /*
378  int inflateInit (z_streamp strm);
379 
380  Initializes the internal stream state for decompression. The fields
381  next_in, avail_in, zalloc, zfree and opaque must be initialized before by
382  the caller. If next_in is not Z_NULL and avail_in is large enough (the
383  exact value depends on the compression method), inflateInit determines the
384  compression method from the zlib header and allocates all data structures
385  accordingly; otherwise the allocation will be deferred to the first call of
386  inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them to
387  use default allocation functions.
388 
389  inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough
390  memory, Z_VERSION_ERROR if the zlib library version is incompatible with the
391  version assumed by the caller, or Z_STREAM_ERROR if the parameters are
392  invalid, such as a null pointer to the structure. msg is set to null if
393  there is no error message. inflateInit does not perform any decompression
394  apart from possibly reading the zlib header if present: actual decompression
395  will be done by inflate(). (So next_in and avail_in may be modified, but
396  next_out and avail_out are unused and unchanged.) The current implementation
397  of inflateInit() does not process any header information -- that is deferred
398  until inflate() is called.
399 */
400 
401 
402  int inflate (z_streamp strm, int flush);
403 /*
404  inflate decompresses as much data as possible, and stops when the input
405  buffer becomes empty or the output buffer becomes full. It may introduce
406  some output latency (reading input without producing any output) except when
407  forced to flush.
408 
409  The detailed semantics are as follows. inflate performs one or both of the
410  following actions:
411 
412  - Decompress more input starting at next_in and update next_in and avail_in
413  accordingly. If not all input can be processed (because there is not
414  enough room in the output buffer), next_in is updated and processing will
415  resume at this point for the next call of inflate().
416 
417  - Provide more output starting at next_out and update next_out and avail_out
418  accordingly. inflate() provides as much output as possible, until there is
419  no more input data or no more space in the output buffer (see below about
420  the flush parameter).
421 
422  Before the call of inflate(), the application should ensure that at least
423  one of the actions is possible, by providing more input and/or consuming more
424  output, and updating the next_* and avail_* values accordingly. The
425  application can consume the uncompressed output when it wants, for example
426  when the output buffer is full (avail_out == 0), or after each call of
427  inflate(). If inflate returns Z_OK and with zero avail_out, it must be
428  called again after making room in the output buffer because there might be
429  more output pending.
430 
431  The flush parameter of inflate() can be Z_NO_FLUSH, Z_SYNC_FLUSH, Z_FINISH,
432  Z_BLOCK, or Z_TREES. Z_SYNC_FLUSH requests that inflate() flush as much
433  output as possible to the output buffer. Z_BLOCK requests that inflate()
434  stop if and when it gets to the next deflate block boundary. When decoding
435  the zlib or gzip format, this will cause inflate() to return immediately
436  after the header and before the first block. When doing a raw inflate,
437  inflate() will go ahead and process the first block, and will return when it
438  gets to the end of that block, or when it runs out of data.
439 
440  The Z_BLOCK option assists in appending to or combining deflate streams.
441  Also to assist in this, on return inflate() will set strm->data_type to the
442  number of unused bits in the last byte taken from strm->next_in, plus 64 if
443  inflate() is currently decoding the last block in the deflate stream, plus
444  128 if inflate() returned immediately after decoding an end-of-block code or
445  decoding the complete header up to just before the first byte of the deflate
446  stream. The end-of-block will not be indicated until all of the uncompressed
447  data from that block has been written to strm->next_out. The number of
448  unused bits may in general be greater than seven, except when bit 7 of
449  data_type is set, in which case the number of unused bits will be less than
450  eight. data_type is set as noted here every time inflate() returns for all
451  flush options, and so can be used to determine the amount of currently
452  consumed input in bits.
453 
454  The Z_TREES option behaves as Z_BLOCK does, but it also returns when the
455  end of each deflate block header is reached, before any actual data in that
456  block is decoded. This allows the caller to determine the length of the
457  deflate block header for later use in random access within a deflate block.
458  256 is added to the value of strm->data_type when inflate() returns
459  immediately after reaching the end of the deflate block header.
460 
461  inflate() should normally be called until it returns Z_STREAM_END or an
462  error. However if all decompression is to be performed in a single step (a
463  single call of inflate), the parameter flush should be set to Z_FINISH. In
464  this case all pending input is processed and all pending output is flushed;
465  avail_out must be large enough to hold all of the uncompressed data for the
466  operation to complete. (The size of the uncompressed data may have been
467  saved by the compressor for this purpose.) The use of Z_FINISH is not
468  required to perform an inflation in one step. However it may be used to
469  inform inflate that a faster approach can be used for the single inflate()
470  call. Z_FINISH also informs inflate to not maintain a sliding window if the
471  stream completes, which reduces inflate's memory footprint. If the stream
472  does not complete, either because not all of the stream is provided or not
473  enough output space is provided, then a sliding window will be allocated and
474  inflate() can be called again to continue the operation as if Z_NO_FLUSH had
475  been used.
476 
477  In this implementation, inflate() always flushes as much output as
478  possible to the output buffer, and always uses the faster approach on the
479  first call. So the effects of the flush parameter in this implementation are
480  on the return value of inflate() as noted below, when inflate() returns early
481  when Z_BLOCK or Z_TREES is used, and when inflate() avoids the allocation of
482  memory for a sliding window when Z_FINISH is used.
483 
484  If a preset dictionary is needed after this call (see inflateSetDictionary
485  below), inflate sets strm->adler to the Adler-32 checksum of the dictionary
486  chosen by the compressor and returns Z_NEED_DICT; otherwise it sets
487  strm->adler to the Adler-32 checksum of all output produced so far (that is,
488  total_out bytes) and returns Z_OK, Z_STREAM_END or an error code as described
489  below. At the end of the stream, inflate() checks that its computed adler32
490  checksum is equal to that saved by the compressor and returns Z_STREAM_END
491  only if the checksum is correct.
492 
493  inflate() can decompress and check either zlib-wrapped or gzip-wrapped
494  deflate data. The header type is detected automatically, if requested when
495  initializing with inflateInit2(). Any information contained in the gzip
496  header is not retained, so applications that need that information should
497  instead use raw inflate, see inflateInit2() below, or inflateBack() and
498  perform their own processing of the gzip header and trailer. When processing
499  gzip-wrapped deflate data, strm->adler32 is set to the CRC-32 of the output
500  producted so far. The CRC-32 is checked against the gzip trailer.
501 
502  inflate() returns Z_OK if some progress has been made (more input processed
503  or more output produced), Z_STREAM_END if the end of the compressed data has
504  been reached and all uncompressed output has been produced, Z_NEED_DICT if a
505  preset dictionary is needed at this point, Z_DATA_ERROR if the input data was
506  corrupted (input stream not conforming to the zlib format or incorrect check
507  value), Z_STREAM_ERROR if the stream structure was inconsistent (for example
508  next_in or next_out was Z_NULL), Z_MEM_ERROR if there was not enough memory,
509  Z_BUF_ERROR if no progress is possible or if there was not enough room in the
510  output buffer when Z_FINISH is used. Note that Z_BUF_ERROR is not fatal, and
511  inflate() can be called again with more input and more output space to
512  continue decompressing. If Z_DATA_ERROR is returned, the application may
513  then call inflateSync() to look for a good compression block if a partial
514  recovery of the data is desired.
515 */
516 
517 
518  int inflateEnd (z_streamp strm);
519 /*
520  All dynamically allocated data structures for this stream are freed.
521  This function discards any unprocessed input and does not flush any pending
522  output.
523 
524  inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state
525  was inconsistent. In the error case, msg may be set but then points to a
526  static string (which must not be deallocated).
527 */
528 
529 
530  /* Advanced functions */
531 
532 /*
533  The following functions are needed only in some special applications.
534 */
535 
536 /*
537  int deflateInit2 (z_streamp strm,
538  int level,
539  int method,
540  int windowBits,
541  int memLevel,
542  int strategy);
543 
544  This is another version of deflateInit with more compression options. The
545  fields next_in, zalloc, zfree and opaque must be initialized before by the
546  caller.
547 
548  The method parameter is the compression method. It must be Z_DEFLATED in
549  this version of the library.
550 
551  The windowBits parameter is the base two logarithm of the window size
552  (the size of the history buffer). It should be in the range 8..15 for this
553  version of the library. Larger values of this parameter result in better
554  compression at the expense of memory usage. The default value is 15 if
555  deflateInit is used instead.
556 
557  windowBits can also be -8..-15 for raw deflate. In this case, -windowBits
558  determines the window size. deflate() will then generate raw deflate data
559  with no zlib header or trailer, and will not compute an adler32 check value.
560 
561  windowBits can also be greater than 15 for optional gzip encoding. Add
562  16 to windowBits to write a simple gzip header and trailer around the
563  compressed data instead of a zlib wrapper. The gzip header will have no
564  file name, no extra data, no comment, no modification time (set to zero), no
565  header crc, and the operating system will be set to 255 (unknown). If a
566  gzip stream is being written, strm->adler is a crc32 instead of an adler32.
567 
568  The memLevel parameter specifies how much memory should be allocated
569  for the internal compression state. memLevel=1 uses minimum memory but is
570  slow and reduces compression ratio; memLevel=9 uses maximum memory for
571  optimal speed. The default value is 8. See zconf.h for total memory usage
572  as a function of windowBits and memLevel.
573 
574  The strategy parameter is used to tune the compression algorithm. Use the
575  value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a
576  filter (or predictor), Z_HUFFMAN_ONLY to force Huffman encoding only (no
577  string match), or Z_RLE to limit match distances to one (run-length
578  encoding). Filtered data consists mostly of small values with a somewhat
579  random distribution. In this case, the compression algorithm is tuned to
580  compress them better. The effect of Z_FILTERED is to force more Huffman
581  coding and less string matching; it is somewhat intermediate between
582  Z_DEFAULT_STRATEGY and Z_HUFFMAN_ONLY. Z_RLE is designed to be almost as
583  fast as Z_HUFFMAN_ONLY, but give better compression for PNG image data. The
584  strategy parameter only affects the compression ratio but not the
585  correctness of the compressed output even if it is not set appropriately.
586  Z_FIXED prevents the use of dynamic Huffman codes, allowing for a simpler
587  decoder for special applications.
588 
589  deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
590  memory, Z_STREAM_ERROR if any parameter is invalid (such as an invalid
591  method), or Z_VERSION_ERROR if the zlib library version (zlib_version) is
592  incompatible with the version assumed by the caller (ZLIB_VERSION). msg is
593  set to null if there is no error message. deflateInit2 does not perform any
594  compression: this will be done by deflate().
595 */
596 
597  int deflateSetDictionary (z_streamp strm,
598  const Bytef *dictionary,
599  uInt dictLength);
600 /*
601  Initializes the compression dictionary from the given byte sequence
602  without producing any compressed output. When using the zlib format, this
603  function must be called immediately after deflateInit, deflateInit2 or
604  deflateReset, and before any call of deflate. When doing raw deflate, this
605  function must be called either before any call of deflate, or immediately
606  after the completion of a deflate block, i.e. after all input has been
607  consumed and all output has been delivered when using any of the flush
608  options Z_BLOCK, Z_PARTIAL_FLUSH, Z_SYNC_FLUSH, or Z_FULL_FLUSH. The
609  compressor and decompressor must use exactly the same dictionary (see
610  inflateSetDictionary).
611 
612  The dictionary should consist of strings (byte sequences) that are likely
613  to be encountered later in the data to be compressed, with the most commonly
614  used strings preferably put towards the end of the dictionary. Using a
615  dictionary is most useful when the data to be compressed is short and can be
616  predicted with good accuracy; the data can then be compressed better than
617  with the default empty dictionary.
618 
619  Depending on the size of the compression data structures selected by
620  deflateInit or deflateInit2, a part of the dictionary may in effect be
621  discarded, for example if the dictionary is larger than the window size
622  provided in deflateInit or deflateInit2. Thus the strings most likely to be
623  useful should be put at the end of the dictionary, not at the front. In
624  addition, the current implementation of deflate will use at most the window
625  size minus 262 bytes of the provided dictionary.
626 
627  Upon return of this function, strm->adler is set to the adler32 value
628  of the dictionary; the decompressor may later use this value to determine
629  which dictionary has been used by the compressor. (The adler32 value
630  applies to the whole dictionary even if only a subset of the dictionary is
631  actually used by the compressor.) If a raw deflate was requested, then the
632  adler32 value is not computed and strm->adler is not set.
633 
634  deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a
635  parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is
636  inconsistent (for example if deflate has already been called for this stream
637  or if not at a block boundary for raw deflate). deflateSetDictionary does
638  not perform any compression: this will be done by deflate().
639 */
640 
641  int deflateCopy (z_streamp dest,
642  z_streamp source);
643 /*
644  Sets the destination stream as a complete copy of the source stream.
645 
646  This function can be useful when several compression strategies will be
647  tried, for example when there are several ways of pre-processing the input
648  data with a filter. The streams that will be discarded should then be freed
649  by calling deflateEnd. Note that deflateCopy duplicates the internal
650  compression state which can be quite large, so this strategy is slow and can
651  consume lots of memory.
652 
653  deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not
654  enough memory, Z_STREAM_ERROR if the source stream state was inconsistent
655  (such as zalloc being Z_NULL). msg is left unchanged in both source and
656  destination.
657 */
658 
659  int deflateReset (z_streamp strm);
660 /*
661  This function is equivalent to deflateEnd followed by deflateInit,
662  but does not free and reallocate all the internal compression state. The
663  stream will keep the same compression level and any other attributes that
664  may have been set by deflateInit2.
665 
666  deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
667  stream state was inconsistent (such as zalloc or state being Z_NULL).
668 */
669 
670  int deflateParams (z_streamp strm,
671  int level,
672  int strategy);
673 /*
674  Dynamically update the compression level and compression strategy. The
675  interpretation of level and strategy is as in deflateInit2. This can be
676  used to switch between compression and straight copy of the input data, or
677  to switch to a different kind of input data requiring a different strategy.
678  If the compression level is changed, the input available so far is
679  compressed with the old level (and may be flushed); the new level will take
680  effect only at the next call of deflate().
681 
682  Before the call of deflateParams, the stream state must be set as for
683  a call of deflate(), since the currently available input may have to be
684  compressed and flushed. In particular, strm->avail_out must be non-zero.
685 
686  deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source
687  stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR if
688  strm->avail_out was zero.
689 */
690 
691  int deflateTune (z_streamp strm,
692  int good_length,
693  int max_lazy,
694  int nice_length,
695  int max_chain);
696 /*
697  Fine tune deflate's internal compression parameters. This should only be
698  used by someone who understands the algorithm used by zlib's deflate for
699  searching for the best matching string, and even then only by the most
700  fanatic optimizer trying to squeeze out the last compressed bit for their
701  specific input data. Read the deflate.c source code for the meaning of the
702  max_lazy, good_length, nice_length, and max_chain parameters.
703 
704  deflateTune() can be called after deflateInit() or deflateInit2(), and
705  returns Z_OK on success, or Z_STREAM_ERROR for an invalid deflate stream.
706  */
707 
708  uLong deflateBound (z_streamp strm,
709  uLong sourceLen);
710 /*
711  deflateBound() returns an upper bound on the compressed size after
712  deflation of sourceLen bytes. It must be called after deflateInit() or
713  deflateInit2(), and after deflateSetHeader(), if used. This would be used
714  to allocate an output buffer for deflation in a single pass, and so would be
715  called before deflate(). If that first deflate() call is provided the
716  sourceLen input bytes, an output buffer allocated to the size returned by
717  deflateBound(), and the flush value Z_FINISH, then deflate() is guaranteed
718  to return Z_STREAM_END. Note that it is possible for the compressed size to
719  be larger than the value returned by deflateBound() if flush options other
720  than Z_FINISH or Z_NO_FLUSH are used.
721 */
722 
723  int deflatePending (z_streamp strm,
724  unsigned *pending,
725  int *bits);
726 /*
727  deflatePending() returns the number of bytes and bits of output that have
728  been generated, but not yet provided in the available output. The bytes not
729  provided would be due to the available output space having being consumed.
730  The number of bits of output not provided are between 0 and 7, where they
731  await more bits to join them in order to fill out a full byte. If pending
732  or bits are Z_NULL, then those values are not set.
733 
734  deflatePending returns Z_OK if success, or Z_STREAM_ERROR if the source
735  stream state was inconsistent.
736  */
737 
738  int deflatePrime (z_streamp strm,
739  int bits,
740  int value);
741 /*
742  deflatePrime() inserts bits in the deflate output stream. The intent
743  is that this function is used to start off the deflate output with the bits
744  leftover from a previous deflate stream when appending to it. As such, this
745  function can only be used for raw deflate, and must be used before the first
746  deflate() call after a deflateInit2() or deflateReset(). bits must be less
747  than or equal to 16, and that many of the least significant bits of value
748  will be inserted in the output.
749 
750  deflatePrime returns Z_OK if success, Z_BUF_ERROR if there was not enough
751  room in the internal buffer to insert the bits, or Z_STREAM_ERROR if the
752  source stream state was inconsistent.
753 */
754 
755  int deflateSetHeader (z_streamp strm,
756  gz_headerp head);
757 /*
758  deflateSetHeader() provides gzip header information for when a gzip
759  stream is requested by deflateInit2(). deflateSetHeader() may be called
760  after deflateInit2() or deflateReset() and before the first call of
761  deflate(). The text, time, os, extra field, name, and comment information
762  in the provided gz_header structure are written to the gzip header (xflag is
763  ignored -- the extra flags are set according to the compression level). The
764  caller must assure that, if not Z_NULL, name and comment are terminated with
765  a zero byte, and that if extra is not Z_NULL, that extra_len bytes are
766  available there. If hcrc is true, a gzip header crc is included. Note that
767  the current versions of the command-line version of gzip (up through version
768  1.3.x) do not support header crc's, and will report that it is a "multi-part
769  gzip file" and give up.
770 
771  If deflateSetHeader is not used, the default gzip header has text false,
772  the time set to zero, and os set to 255, with no extra, name, or comment
773  fields. The gzip header is returned to the default state by deflateReset().
774 
775  deflateSetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source
776  stream state was inconsistent.
777 */
778 
779 /*
780  int inflateInit2 (z_streamp strm,
781  int windowBits);
782 
783  This is another version of inflateInit with an extra parameter. The
784  fields next_in, avail_in, zalloc, zfree and opaque must be initialized
785  before by the caller.
786 
787  The windowBits parameter is the base two logarithm of the maximum window
788  size (the size of the history buffer). It should be in the range 8..15 for
789  this version of the library. The default value is 15 if inflateInit is used
790  instead. windowBits must be greater than or equal to the windowBits value
791  provided to deflateInit2() while compressing, or it must be equal to 15 if
792  deflateInit2() was not used. If a compressed stream with a larger window
793  size is given as input, inflate() will return with the error code
794  Z_DATA_ERROR instead of trying to allocate a larger window.
795 
796  windowBits can also be zero to request that inflate use the window size in
797  the zlib header of the compressed stream.
798 
799  windowBits can also be -8..-15 for raw inflate. In this case, -windowBits
800  determines the window size. inflate() will then process raw deflate data,
801  not looking for a zlib or gzip header, not generating a check value, and not
802  looking for any check values for comparison at the end of the stream. This
803  is for use with other formats that use the deflate compressed data format
804  such as zip. Those formats provide their own check values. If a custom
805  format is developed using the raw deflate format for compressed data, it is
806  recommended that a check value such as an adler32 or a crc32 be applied to
807  the uncompressed data as is done in the zlib, gzip, and zip formats. For
808  most applications, the zlib format should be used as is. Note that comments
809  above on the use in deflateInit2() applies to the magnitude of windowBits.
810 
811  windowBits can also be greater than 15 for optional gzip decoding. Add
812  32 to windowBits to enable zlib and gzip decoding with automatic header
813  detection, or add 16 to decode only the gzip format (the zlib format will
814  return a Z_DATA_ERROR). If a gzip stream is being decoded, strm->adler is a
815  crc32 instead of an adler32.
816 
817  inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
818  memory, Z_VERSION_ERROR if the zlib library version is incompatible with the
819  version assumed by the caller, or Z_STREAM_ERROR if the parameters are
820  invalid, such as a null pointer to the structure. msg is set to null if
821  there is no error message. inflateInit2 does not perform any decompression
822  apart from possibly reading the zlib header if present: actual decompression
823  will be done by inflate(). (So next_in and avail_in may be modified, but
824  next_out and avail_out are unused and unchanged.) The current implementation
825  of inflateInit2() does not process any header information -- that is
826  deferred until inflate() is called.
827 */
828 
829  int inflateSetDictionary (z_streamp strm,
830  const Bytef *dictionary,
831  uInt dictLength);
832 /*
833  Initializes the decompression dictionary from the given uncompressed byte
834  sequence. This function must be called immediately after a call of inflate,
835  if that call returned Z_NEED_DICT. The dictionary chosen by the compressor
836  can be determined from the adler32 value returned by that call of inflate.
837  The compressor and decompressor must use exactly the same dictionary (see
838  deflateSetDictionary). For raw inflate, this function can be called at any
839  time to set the dictionary. If the provided dictionary is smaller than the
840  window and there is already data in the window, then the provided dictionary
841  will amend what's there. The application must insure that the dictionary
842  that was used for compression is provided.
843 
844  inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a
845  parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is
846  inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the
847  expected one (incorrect adler32 value). inflateSetDictionary does not
848  perform any decompression: this will be done by subsequent calls of
849  inflate().
850 */
851 
852  int inflateGetDictionary (z_streamp strm,
853  Bytef *dictionary,
854  uInt *dictLength);
855 /*
856  Returns the sliding dictionary being maintained by inflate. dictLength is
857  set to the number of bytes in the dictionary, and that many bytes are copied
858  to dictionary. dictionary must have enough space, where 32768 bytes is
859  always enough. If inflateGetDictionary() is called with dictionary equal to
860  Z_NULL, then only the dictionary length is returned, and nothing is copied.
861  Similary, if dictLength is Z_NULL, then it is not set.
862 
863  inflateGetDictionary returns Z_OK on success, or Z_STREAM_ERROR if the
864  stream state is inconsistent.
865 */
866 
867  int inflateSync (z_streamp strm);
868 /*
869  Skips invalid compressed data until a possible full flush point (see above
870  for the description of deflate with Z_FULL_FLUSH) can be found, or until all
871  available input is skipped. No output is provided.
872 
873  inflateSync searches for a 00 00 FF FF pattern in the compressed data.
874  All full flush points have this pattern, but not all occurrences of this
875  pattern are full flush points.
876 
877  inflateSync returns Z_OK if a possible full flush point has been found,
878  Z_BUF_ERROR if no more input was provided, Z_DATA_ERROR if no flush point
879  has been found, or Z_STREAM_ERROR if the stream structure was inconsistent.
880  In the success case, the application may save the current current value of
881  total_in which indicates where valid compressed data was found. In the
882  error case, the application may repeatedly call inflateSync, providing more
883  input each time, until success or end of the input data.
884 */
885 
886  int inflateCopy (z_streamp dest,
887  z_streamp source);
888 /*
889  Sets the destination stream as a complete copy of the source stream.
890 
891  This function can be useful when randomly accessing a large stream. The
892  first pass through the stream can periodically record the inflate state,
893  allowing restarting inflate at those points when randomly accessing the
894  stream.
895 
896  inflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not
897  enough memory, Z_STREAM_ERROR if the source stream state was inconsistent
898  (such as zalloc being Z_NULL). msg is left unchanged in both source and
899  destination.
900 */
901 
902  int inflateReset (z_streamp strm);
903 /*
904  This function is equivalent to inflateEnd followed by inflateInit,
905  but does not free and reallocate all the internal decompression state. The
906  stream will keep attributes that may have been set by inflateInit2.
907 
908  inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
909  stream state was inconsistent (such as zalloc or state being Z_NULL).
910 */
911 
912  int inflateReset2 (z_streamp strm,
913  int windowBits);
914 /*
915  This function is the same as inflateReset, but it also permits changing
916  the wrap and window size requests. The windowBits parameter is interpreted
917  the same as it is for inflateInit2.
918 
919  inflateReset2 returns Z_OK if success, or Z_STREAM_ERROR if the source
920  stream state was inconsistent (such as zalloc or state being Z_NULL), or if
921  the windowBits parameter is invalid.
922 */
923 
924  int inflatePrime (z_streamp strm,
925  int bits,
926  int value);
927 /*
928  This function inserts bits in the inflate input stream. The intent is
929  that this function is used to start inflating at a bit position in the
930  middle of a byte. The provided bits will be used before any bytes are used
931  from next_in. This function should only be used with raw inflate, and
932  should be used before the first inflate() call after inflateInit2() or
933  inflateReset(). bits must be less than or equal to 16, and that many of the
934  least significant bits of value will be inserted in the input.
935 
936  If bits is negative, then the input stream bit buffer is emptied. Then
937  inflatePrime() can be called again to put bits in the buffer. This is used
938  to clear out bits leftover after feeding inflate a block description prior
939  to feeding inflate codes.
940 
941  inflatePrime returns Z_OK if success, or Z_STREAM_ERROR if the source
942  stream state was inconsistent.
943 */
944 
945  long inflateMark (z_streamp strm);
946 /*
947  This function returns two values, one in the lower 16 bits of the return
948  value, and the other in the remaining upper bits, obtained by shifting the
949  return value down 16 bits. If the upper value is -1 and the lower value is
950  zero, then inflate() is currently decoding information outside of a block.
951  If the upper value is -1 and the lower value is non-zero, then inflate is in
952  the middle of a stored block, with the lower value equaling the number of
953  bytes from the input remaining to copy. If the upper value is not -1, then
954  it is the number of bits back from the current bit position in the input of
955  the code (literal or length/distance pair) currently being processed. In
956  that case the lower value is the number of bytes already emitted for that
957  code.
958 
959  A code is being processed if inflate is waiting for more input to complete
960  decoding of the code, or if it has completed decoding but is waiting for
961  more output space to write the literal or match data.
962 
963  inflateMark() is used to mark locations in the input data for random
964  access, which may be at bit positions, and to note those cases where the
965  output of a code may span boundaries of random access blocks. The current
966  location in the input stream can be determined from avail_in and data_type
967  as noted in the description for the Z_BLOCK flush parameter for inflate.
968 
969  inflateMark returns the value noted above or -1 << 16 if the provided
970  source stream state was inconsistent.
971 */
972 
973  int inflateGetHeader (z_streamp strm,
974  gz_headerp head);
975 /*
976  inflateGetHeader() requests that gzip header information be stored in the
977  provided gz_header structure. inflateGetHeader() may be called after
978  inflateInit2() or inflateReset(), and before the first call of inflate().
979  As inflate() processes the gzip stream, head->done is zero until the header
980  is completed, at which time head->done is set to one. If a zlib stream is
981  being decoded, then head->done is set to -1 to indicate that there will be
982  no gzip header information forthcoming. Note that Z_BLOCK or Z_TREES can be
983  used to force inflate() to return immediately after header processing is
984  complete and before any actual data is decompressed.
985 
986  The text, time, xflags, and os fields are filled in with the gzip header
987  contents. hcrc is set to true if there is a header CRC. (The header CRC
988  was valid if done is set to one.) If extra is not Z_NULL, then extra_max
989  contains the maximum number of bytes to write to extra. Once done is true,
990  extra_len contains the actual extra field length, and extra contains the
991  extra field, or that field truncated if extra_max is less than extra_len.
992  If name is not Z_NULL, then up to name_max characters are written there,
993  terminated with a zero unless the length is greater than name_max. If
994  comment is not Z_NULL, then up to comm_max characters are written there,
995  terminated with a zero unless the length is greater than comm_max. When any
996  of extra, name, or comment are not Z_NULL and the respective field is not
997  present in the header, then that field is set to Z_NULL to signal its
998  absence. This allows the use of deflateSetHeader() with the returned
999  structure to duplicate the header. However if those fields are set to
1000  allocated memory, then the application will need to save those pointers
1001  elsewhere so that they can be eventually freed.
1002 
1003  If inflateGetHeader is not used, then the header information is simply
1004  discarded. The header is always checked for validity, including the header
1005  CRC if present. inflateReset() will reset the process to discard the header
1006  information. The application would need to call inflateGetHeader() again to
1007  retrieve the header from the next gzip stream.
1008 
1009  inflateGetHeader returns Z_OK if success, or Z_STREAM_ERROR if the source
1010  stream state was inconsistent.
1011 */
1012 
1013 /*
1014  int inflateBackInit (z_streamp strm, int windowBits,
1015  unsigned char FAR *window);
1016 
1017  Initialize the internal stream state for decompression using inflateBack()
1018  calls. The fields zalloc, zfree and opaque in strm must be initialized
1019  before the call. If zalloc and zfree are Z_NULL, then the default library-
1020  derived memory allocation routines are used. windowBits is the base two
1021  logarithm of the window size, in the range 8..15. window is a caller
1022  supplied buffer of that size. Except for special applications where it is
1023  assured that deflate was used with small window sizes, windowBits must be 15
1024  and a 32K byte window must be supplied to be able to decompress general
1025  deflate streams.
1026 
1027  See inflateBack() for the usage of these routines.
1028 
1029  inflateBackInit will return Z_OK on success, Z_STREAM_ERROR if any of
1030  the parameters are invalid, Z_MEM_ERROR if the internal state could not be
1031  allocated, or Z_VERSION_ERROR if the version of the library does not match
1032  the version of the header file.
1033 */
1034 
1035 typedef unsigned (*in_func) (void FAR *,
1036  z_const unsigned char FAR * FAR *);
1037 typedef int (*out_func) (void FAR *, unsigned char FAR *, unsigned);
1038 
1039  int inflateBack (z_streamp strm,
1040  in_func in, void FAR *in_desc,
1041  out_func out, void FAR *out_desc);
1042 /*
1043  inflateBack() does a raw inflate with a single call using a call-back
1044  interface for input and output. This is potentially more efficient than
1045  inflate() for file i/o applications, in that it avoids copying between the
1046  output and the sliding window by simply making the window itself the output
1047  buffer. inflate() can be faster on modern CPUs when used with large
1048  buffers. inflateBack() trusts the application to not change the output
1049  buffer passed by the output function, at least until inflateBack() returns.
1050 
1051  inflateBackInit() must be called first to allocate the internal state
1052  and to initialize the state with the user-provided window buffer.
1053  inflateBack() may then be used multiple times to inflate a complete, raw
1054  deflate stream with each call. inflateBackEnd() is then called to free the
1055  allocated state.
1056 
1057  A raw deflate stream is one with no zlib or gzip header or trailer.
1058  This routine would normally be used in a utility that reads zip or gzip
1059  files and writes out uncompressed files. The utility would decode the
1060  header and process the trailer on its own, hence this routine expects only
1061  the raw deflate stream to decompress. This is different from the normal
1062  behavior of inflate(), which expects either a zlib or gzip header and
1063  trailer around the deflate stream.
1064 
1065  inflateBack() uses two subroutines supplied by the caller that are then
1066  called by inflateBack() for input and output. inflateBack() calls those
1067  routines until it reads a complete deflate stream and writes out all of the
1068  uncompressed data, or until it encounters an error. The function's
1069  parameters and return types are defined above in the in_func and out_func
1070  typedefs. inflateBack() will call in(in_desc, &buf) which should return the
1071  number of bytes of provided input, and a pointer to that input in buf. If
1072  there is no input available, in() must return zero--buf is ignored in that
1073  case--and inflateBack() will return a buffer error. inflateBack() will call
1074  out(out_desc, buf, len) to write the uncompressed data buf[0..len-1]. out()
1075  should return zero on success, or non-zero on failure. If out() returns
1076  non-zero, inflateBack() will return with an error. Neither in() nor out()
1077  are permitted to change the contents of the window provided to
1078  inflateBackInit(), which is also the buffer that out() uses to write from.
1079  The length written by out() will be at most the window size. Any non-zero
1080  amount of input may be provided by in().
1081 
1082  For convenience, inflateBack() can be provided input on the first call by
1083  setting strm->next_in and strm->avail_in. If that input is exhausted, then
1084  in() will be called. Therefore strm->next_in must be initialized before
1085  calling inflateBack(). If strm->next_in is Z_NULL, then in() will be called
1086  immediately for input. If strm->next_in is not Z_NULL, then strm->avail_in
1087  must also be initialized, and then if strm->avail_in is not zero, input will
1088  initially be taken from strm->next_in[0 .. strm->avail_in - 1].
1089 
1090  The in_desc and out_desc parameters of inflateBack() is passed as the
1091  first parameter of in() and out() respectively when they are called. These
1092  descriptors can be optionally used to pass any information that the caller-
1093  supplied in() and out() functions need to do their job.
1094 
1095  On return, inflateBack() will set strm->next_in and strm->avail_in to
1096  pass back any unused input that was provided by the last in() call. The
1097  return values of inflateBack() can be Z_STREAM_END on success, Z_BUF_ERROR
1098  if in() or out() returned an error, Z_DATA_ERROR if there was a format error
1099  in the deflate stream (in which case strm->msg is set to indicate the nature
1100  of the error), or Z_STREAM_ERROR if the stream was not properly initialized.
1101  In the case of Z_BUF_ERROR, an input or output error can be distinguished
1102  using strm->next_in which will be Z_NULL only if in() returned an error. If
1103  strm->next_in is not Z_NULL, then the Z_BUF_ERROR was due to out() returning
1104  non-zero. (in() will always be called before out(), so strm->next_in is
1105  assured to be defined if out() returns non-zero.) Note that inflateBack()
1106  cannot return Z_OK.
1107 */
1108 
1109  int inflateBackEnd (z_streamp strm);
1110 /*
1111  All memory allocated by inflateBackInit() is freed.
1112 
1113  inflateBackEnd() returns Z_OK on success, or Z_STREAM_ERROR if the stream
1114  state was inconsistent.
1115 */
1116 
1117  uLong zlibCompileFlags (void);
1118 /* Return flags indicating compile-time options.
1119 
1120  Type sizes, two bits each, 00 = 16 bits, 01 = 32, 10 = 64, 11 = other:
1121  1.0: size of uInt
1122  3.2: size of uLong
1123  5.4: size of voidpf (pointer)
1124  7.6: size of z_off_t
1125 
1126  Compiler, assembler, and debug options:
1127  8: DEBUG
1128  9: ASMV or ASMINF -- use ASM code
1129  10: ZLIB_WINAPI -- exported functions use the WINAPI calling convention
1130  11: 0 (reserved)
1131 
1132  One-time table building (smaller code, but not thread-safe if true):
1133  12: BUILDFIXED -- build static block decoding tables when needed
1134  13: DYNAMIC_CRC_TABLE -- build CRC calculation tables when needed
1135  14,15: 0 (reserved)
1136 
1137  Library content (indicates missing functionality):
1138  16: NO_GZCOMPRESS -- gz* functions cannot compress (to avoid linking
1139  deflate code when not needed)
1140  17: NO_GZIP -- deflate can't write gzip streams, and inflate can't detect
1141  and decode gzip streams (to avoid linking crc code)
1142  18-19: 0 (reserved)
1143 
1144  Operation variations (changes in library functionality):
1145  20: PKZIP_BUG_WORKAROUND -- slightly more permissive inflate
1146  21: FASTEST -- deflate algorithm with only one, lowest compression level
1147  22,23: 0 (reserved)
1148 
1149  The sprintf variant used by gzprintf (zero is best):
1150  24: 0 = vs*, 1 = s* -- 1 means limited to 20 arguments after the format
1151  25: 0 = *nprintf, 1 = *printf -- 1 means gzprintf() not secure!
1152  26: 0 = returns value, 1 = void -- 1 means inferred string length returned
1153 
1154  Remainder:
1155  27-31: 0 (reserved)
1156  */
1157 
1158 #ifndef Z_SOLO
1159 
1160  /* utility functions */
1161 
1162 /*
1163  The following utility functions are implemented on top of the basic
1164  stream-oriented functions. To simplify the interface, some default options
1165  are assumed (compression level and memory usage, standard memory allocation
1166  functions). The source code of these utility functions can be modified if
1167  you need special options.
1168 */
1169 
1170  int compress (Bytef *dest, uLongf *destLen,
1171  const Bytef *source, uLong sourceLen);
1172 /*
1173  Compresses the source buffer into the destination buffer. sourceLen is
1174  the byte length of the source buffer. Upon entry, destLen is the total size
1175  of the destination buffer, which must be at least the value returned by
1176  compressBound(sourceLen). Upon exit, destLen is the actual size of the
1177  compressed buffer.
1178 
1179  compress returns Z_OK if success, Z_MEM_ERROR if there was not
1180  enough memory, Z_BUF_ERROR if there was not enough room in the output
1181  buffer.
1182 */
1183 
1184  int compress2 (Bytef *dest, uLongf *destLen,
1185  const Bytef *source, uLong sourceLen,
1186  int level);
1187 /*
1188  Compresses the source buffer into the destination buffer. The level
1189  parameter has the same meaning as in deflateInit. sourceLen is the byte
1190  length of the source buffer. Upon entry, destLen is the total size of the
1191  destination buffer, which must be at least the value returned by
1192  compressBound(sourceLen). Upon exit, destLen is the actual size of the
1193  compressed buffer.
1194 
1195  compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
1196  memory, Z_BUF_ERROR if there was not enough room in the output buffer,
1197  Z_STREAM_ERROR if the level parameter is invalid.
1198 */
1199 
1200  uLong compressBound (uLong sourceLen);
1201 /*
1202  compressBound() returns an upper bound on the compressed size after
1203  compress() or compress2() on sourceLen bytes. It would be used before a
1204  compress() or compress2() call to allocate the destination buffer.
1205 */
1206 
1207  int uncompress (unsigned char *dest, uint32_t *destLen,
1208  const unsigned char *source, uint32_t sourceLen);
1209 /*
1210  Decompresses the source buffer into the destination buffer. sourceLen is
1211  the byte length of the source buffer. Upon entry, destLen is the total size
1212  of the destination buffer, which must be large enough to hold the entire
1213  uncompressed data. (The size of the uncompressed data must have been saved
1214  previously by the compressor and transmitted to the decompressor by some
1215  mechanism outside the scope of this compression library.) Upon exit, destLen
1216  is the actual size of the uncompressed buffer.
1217 
1218  uncompress returns Z_OK if success, Z_MEM_ERROR if there was not
1219  enough memory, Z_BUF_ERROR if there was not enough room in the output
1220  buffer, or Z_DATA_ERROR if the input data was corrupted or incomplete. In
1221  the case where there is not enough room, uncompress() will fill the output
1222  buffer with the uncompressed data up to that point.
1223 */
1224 
1225  /* gzip file access functions */
1226 
1227 /*
1228  This library supports reading and writing files in gzip (.gz) format with
1229  an interface similar to that of stdio, using the functions that start with
1230  "gz". The gzip format is different from the zlib format. gzip is a gzip
1231  wrapper, documented in RFC 1952, wrapped around a deflate stream.
1232 */
1233 
1234 typedef struct gzFile_s *gzFile; /* semi-opaque gzip file descriptor */
1235 
1236 /*
1237  gzFile gzopen (const char *path, const char *mode);
1238 
1239  Opens a gzip (.gz) file for reading or writing. The mode parameter is as
1240  in fopen ("rb" or "wb") but can also include a compression level ("wb9") or
1241  a strategy: 'f' for filtered data as in "wb6f", 'h' for Huffman-only
1242  compression as in "wb1h", 'R' for run-length encoding as in "wb1R", or 'F'
1243  for fixed code compression as in "wb9F". (See the description of
1244  deflateInit2 for more information about the strategy parameter.) 'T' will
1245  request transparent writing or appending with no compression and not using
1246  the gzip format.
1247 
1248  "a" can be used instead of "w" to request that the gzip stream that will
1249  be written be appended to the file. "+" will result in an error, since
1250  reading and writing to the same gzip file is not supported. The addition of
1251  "x" when writing will create the file exclusively, which fails if the file
1252  already exists. On systems that support it, the addition of "e" when
1253  reading or writing will set the flag to close the file on an execve() call.
1254 
1255  These functions, as well as gzip, will read and decode a sequence of gzip
1256  streams in a file. The append function of gzopen() can be used to create
1257  such a file. (Also see gzflush() for another way to do this.) When
1258  appending, gzopen does not test whether the file begins with a gzip stream,
1259  nor does it look for the end of the gzip streams to begin appending. gzopen
1260  will simply append a gzip stream to the existing file.
1261 
1262  gzopen can be used to read a file which is not in gzip format; in this
1263  case gzread will directly read from the file without decompression. When
1264  reading, this will be detected automatically by looking for the magic two-
1265  byte gzip header.
1266 
1267  gzopen returns NULL if the file could not be opened, if there was
1268  insufficient memory to allocate the gzFile state, or if an invalid mode was
1269  specified (an 'r', 'w', or 'a' was not provided, or '+' was provided).
1270  errno can be checked to determine if the reason gzopen failed was that the
1271  file could not be opened.
1272 */
1273 
1274  gzFile gzdopen (int fd, const char *mode);
1275 /*
1276  gzdopen associates a gzFile with the file descriptor fd. File descriptors
1277  are obtained from calls like open, dup, creat, pipe or fileno (if the file
1278  has been previously opened with fopen). The mode parameter is as in gzopen.
1279 
1280  The next call of gzclose on the returned gzFile will also close the file
1281  descriptor fd, just like fclose(fdopen(fd, mode)) closes the file descriptor
1282  fd. If you want to keep fd open, use fd = dup(fd_keep); gz = gzdopen(fd,
1283  mode);. The duplicated descriptor should be saved to avoid a leak, since
1284  gzdopen does not close fd if it fails. If you are using fileno() to get the
1285  file descriptor from a FILE *, then you will have to use dup() to avoid
1286  double-close()ing the file descriptor. Both gzclose() and fclose() will
1287  close the associated file descriptor, so they need to have different file
1288  descriptors.
1289 
1290  gzdopen returns NULL if there was insufficient memory to allocate the
1291  gzFile state, if an invalid mode was specified (an 'r', 'w', or 'a' was not
1292  provided, or '+' was provided), or if fd is -1. The file descriptor is not
1293  used until the next gz* read, write, seek, or close operation, so gzdopen
1294  will not detect if fd is invalid (unless fd is -1).
1295 */
1296 
1297  int gzbuffer (gzFile file, unsigned size);
1298 /*
1299  Set the internal buffer size used by this library's functions. The
1300  default buffer size is 8192 bytes. This function must be called after
1301  gzopen() or gzdopen(), and before any other calls that read or write the
1302  file. The buffer memory allocation is always deferred to the first read or
1303  write. Two buffers are allocated, either both of the specified size when
1304  writing, or one of the specified size and the other twice that size when
1305  reading. A larger buffer size of, for example, 64K or 128K bytes will
1306  noticeably increase the speed of decompression (reading).
1307 
1308  The new buffer size also affects the maximum length for gzprintf().
1309 
1310  gzbuffer() returns 0 on success, or -1 on failure, such as being called
1311  too late.
1312 */
1313 
1314  int gzsetparams (gzFile file, int level, int strategy);
1315 /*
1316  Dynamically update the compression level or strategy. See the description
1317  of deflateInit2 for the meaning of these parameters.
1318 
1319  gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not
1320  opened for writing.
1321 */
1322 
1323  int gzread (gzFile file, voidp buf, unsigned len);
1324 /*
1325  Reads the given number of uncompressed bytes from the compressed file. If
1326  the input file is not in gzip format, gzread copies the given number of
1327  bytes into the buffer directly from the file.
1328 
1329  After reaching the end of a gzip stream in the input, gzread will continue
1330  to read, looking for another gzip stream. Any number of gzip streams may be
1331  concatenated in the input file, and will all be decompressed by gzread().
1332  If something other than a gzip stream is encountered after a gzip stream,
1333  that remaining trailing garbage is ignored (and no error is returned).
1334 
1335  gzread can be used to read a gzip file that is being concurrently written.
1336  Upon reaching the end of the input, gzread will return with the available
1337  data. If the error code returned by gzerror is Z_OK or Z_BUF_ERROR, then
1338  gzclearerr can be used to clear the end of file indicator in order to permit
1339  gzread to be tried again. Z_OK indicates that a gzip stream was completed
1340  on the last gzread. Z_BUF_ERROR indicates that the input file ended in the
1341  middle of a gzip stream. Note that gzread does not return -1 in the event
1342  of an incomplete gzip stream. This error is deferred until gzclose(), which
1343  will return Z_BUF_ERROR if the last gzread ended in the middle of a gzip
1344  stream. Alternatively, gzerror can be used before gzclose to detect this
1345  case.
1346 
1347  gzread returns the number of uncompressed bytes actually read, less than
1348  len for end of file, or -1 for error.
1349 */
1350 
1351  int gzwrite (gzFile file,
1352  voidpc buf, unsigned len);
1353 /*
1354  Writes the given number of uncompressed bytes into the compressed file.
1355  gzwrite returns the number of uncompressed bytes written or 0 in case of
1356  error.
1357 */
1358 
1359  int gzprintf Z_ARG((gzFile file, const char *format, ...));
1360 /*
1361  Converts, formats, and writes the arguments to the compressed file under
1362  control of the format string, as in fprintf. gzprintf returns the number of
1363  uncompressed bytes actually written, or 0 in case of error. The number of
1364  uncompressed bytes written is limited to 8191, or one less than the buffer
1365  size given to gzbuffer(). The caller should assure that this limit is not
1366  exceeded. If it is exceeded, then gzprintf() will return an error (0) with
1367  nothing written. In this case, there may also be a buffer overflow with
1368  unpredictable consequences, which is possible only if zlib was compiled with
1369  the insecure functions sprintf() or vsprintf() because the secure snprintf()
1370  or vsnprintf() functions were not available. This can be determined using
1371  zlibCompileFlags().
1372 */
1373 
1374  int gzputs (gzFile file, const char *s);
1375 /*
1376  Writes the given null-terminated string to the compressed file, excluding
1377  the terminating null character.
1378 
1379  gzputs returns the number of characters written, or -1 in case of error.
1380 */
1381 
1382  char * gzgets (gzFile file, char *buf, int len);
1383 /*
1384  Reads bytes from the compressed file until len-1 characters are read, or a
1385  newline character is read and transferred to buf, or an end-of-file
1386  condition is encountered. If any characters are read or if len == 1, the
1387  string is terminated with a null character. If no characters are read due
1388  to an end-of-file or len < 1, then the buffer is left untouched.
1389 
1390  gzgets returns buf which is a null-terminated string, or it returns NULL
1391  for end-of-file or in case of error. If there was an error, the contents at
1392  buf are indeterminate.
1393 */
1394 
1395  int gzputc (gzFile file, int c);
1396 /*
1397  Writes c, converted to an unsigned char, into the compressed file. gzputc
1398  returns the value that was written, or -1 in case of error.
1399 */
1400 
1401  int gzgetc (gzFile file);
1402 /*
1403  Reads one byte from the compressed file. gzgetc returns this byte or -1
1404  in case of end of file or error. This is implemented as a macro for speed.
1405  As such, it does not do all of the checking the other functions do. I.e.
1406  it does not check to see if file is NULL, nor whether the structure file
1407  points to has been clobbered or not.
1408 */
1409 
1410  int gzungetc (int c, gzFile file);
1411 /*
1412  Push one character back onto the stream to be read as the first character
1413  on the next read. At least one character of push-back is allowed.
1414  gzungetc() returns the character pushed, or -1 on failure. gzungetc() will
1415  fail if c is -1, and may fail if a character has been pushed but not read
1416  yet. If gzungetc is used immediately after gzopen or gzdopen, at least the
1417  output buffer size of pushed characters is allowed. (See gzbuffer above.)
1418  The pushed character will be discarded if the stream is repositioned with
1419  gzseek() or gzrewind().
1420 */
1421 
1422  int gzflush (gzFile file, int flush);
1423 /*
1424  Flushes all pending output into the compressed file. The parameter flush
1425  is as in the deflate() function. The return value is the zlib error number
1426  (see function gzerror below). gzflush is only permitted when writing.
1427 
1428  If the flush parameter is Z_FINISH, the remaining data is written and the
1429  gzip stream is completed in the output. If gzwrite() is called again, a new
1430  gzip stream will be started in the output. gzread() is able to read such
1431  concatented gzip streams.
1432 
1433  gzflush should be called only when strictly necessary because it will
1434  degrade compression if called too often.
1435 */
1436 
1437 /*
1438  z_off_t gzseek (gzFile file,
1439  z_off_t offset, int whence);
1440 
1441  Sets the starting position for the next gzread or gzwrite on the given
1442  compressed file. The offset represents a number of bytes in the
1443  uncompressed data stream. The whence parameter is defined as in lseek(2);
1444  the value SEEK_END is not supported.
1445 
1446  If the file is opened for reading, this function is emulated but can be
1447  extremely slow. If the file is opened for writing, only forward seeks are
1448  supported; gzseek then compresses a sequence of zeroes up to the new
1449  starting position.
1450 
1451  gzseek returns the resulting offset location as measured in bytes from
1452  the beginning of the uncompressed stream, or -1 in case of error, in
1453  particular if the file is opened for writing and the new starting position
1454  would be before the current position.
1455 */
1456 
1457  int gzrewind (gzFile file);
1458 /*
1459  Rewinds the given file. This function is supported only for reading.
1460 
1461  gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET)
1462 */
1463 
1464 /*
1465  z_off_t gztell (gzFile file);
1466 
1467  Returns the starting position for the next gzread or gzwrite on the given
1468  compressed file. This position represents a number of bytes in the
1469  uncompressed data stream, and is zero when starting, even if appending or
1470  reading a gzip stream from the middle of a file using gzdopen().
1471 
1472  gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR)
1473 */
1474 
1475 /*
1476  z_off_t gzoffset (gzFile file);
1477 
1478  Returns the current offset in the file being read or written. This offset
1479  includes the count of bytes that precede the gzip stream, for example when
1480  appending or when using gzdopen() for reading. When reading, the offset
1481  does not include as yet unused buffered input. This information can be used
1482  for a progress indicator. On error, gzoffset() returns -1.
1483 */
1484 
1485  int gzeof (gzFile file);
1486 /*
1487  Returns true (1) if the end-of-file indicator has been set while reading,
1488  false (0) otherwise. Note that the end-of-file indicator is set only if the
1489  read tried to go past the end of the input, but came up short. Therefore,
1490  just like feof(), gzeof() may return false even if there is no more data to
1491  read, in the event that the last read request was for the exact number of
1492  bytes remaining in the input file. This will happen if the input file size
1493  is an exact multiple of the buffer size.
1494 
1495  If gzeof() returns true, then the read functions will return no more data,
1496  unless the end-of-file indicator is reset by gzclearerr() and the input file
1497  has grown since the previous end of file was detected.
1498 */
1499 
1500  int gzdirect (gzFile file);
1501 /*
1502  Returns true (1) if file is being copied directly while reading, or false
1503  (0) if file is a gzip stream being decompressed.
1504 
1505  If the input file is empty, gzdirect() will return true, since the input
1506  does not contain a gzip stream.
1507 
1508  If gzdirect() is used immediately after gzopen() or gzdopen() it will
1509  cause buffers to be allocated to allow reading the file to determine if it
1510  is a gzip file. Therefore if gzbuffer() is used, it should be called before
1511  gzdirect().
1512 
1513  When writing, gzdirect() returns true (1) if transparent writing was
1514  requested ("wT" for the gzopen() mode), or false (0) otherwise. (Note:
1515  gzdirect() is not needed when writing. Transparent writing must be
1516  explicitly requested, so the application already knows the answer. When
1517  linking statically, using gzdirect() will include all of the zlib code for
1518  gzip file reading and decompression, which may not be desired.)
1519 */
1520 
1521  int gzclose (gzFile file);
1522 /*
1523  Flushes all pending output if necessary, closes the compressed file and
1524  deallocates the (de)compression state. Note that once file is closed, you
1525  cannot call gzerror with file, since its structures have been deallocated.
1526  gzclose must not be called more than once on the same file, just as free
1527  must not be called more than once on the same allocation.
1528 
1529  gzclose will return Z_STREAM_ERROR if file is not valid, Z_ERRNO on a
1530  file operation error, Z_MEM_ERROR if out of memory, Z_BUF_ERROR if the
1531  last read ended in the middle of a gzip stream, or Z_OK on success.
1532 */
1533 
1534  int gzclose_r (gzFile file);
1535  int gzclose_w (gzFile file);
1536 /*
1537  Same as gzclose(), but gzclose_r() is only for use when reading, and
1538  gzclose_w() is only for use when writing or appending. The advantage to
1539  using these instead of gzclose() is that they avoid linking in zlib
1540  compression or decompression code that is not used when only reading or only
1541  writing respectively. If gzclose() is used, then both compression and
1542  decompression code will be included the application when linking to a static
1543  zlib library.
1544 */
1545 
1546  const char * gzerror (gzFile file, int *errnum);
1547 /*
1548  Returns the error message for the last error which occurred on the given
1549  compressed file. errnum is set to zlib error number. If an error occurred
1550  in the file system and not in the compression library, errnum is set to
1551  Z_ERRNO and the application may consult errno to get the exact error code.
1552 
1553  The application must not modify the returned string. Future calls to
1554  this function may invalidate the previously returned string. If file is
1555  closed, then the string previously returned by gzerror will no longer be
1556  available.
1557 
1558  gzerror() should be used to distinguish errors from end-of-file for those
1559  functions above that do not distinguish those cases in their return values.
1560 */
1561 
1562  void gzclearerr (gzFile file);
1563 /*
1564  Clears the error and end-of-file flags for file. This is analogous to the
1565  clearerr() function in stdio. This is useful for continuing to read a gzip
1566  file that is being written concurrently.
1567 */
1568 
1569 #endif /* !Z_SOLO */
1570 
1571  /* checksum functions */
1572 
1573 /*
1574  These functions are not related to compression but are exported
1575  anyway because they might be useful in applications using the compression
1576  library.
1577 */
1578 
1579 uint32_t adler32 (uint32_t adler, const uint8_t *buf, size_t len);
1580 /*
1581  Update a running Adler-32 checksum with the bytes buf[0..len-1] and
1582  return the updated checksum. If buf is Z_NULL, this function returns the
1583  required initial value for the checksum.
1584 
1585  An Adler-32 checksum is almost as reliable as a CRC32 but can be computed
1586  much faster.
1587 
1588  Usage example:
1589 
1590  uLong adler = adler32(0L, Z_NULL, 0);
1591 
1592  while (read_buffer(buffer, length) != EOF) {
1593  adler = adler32(adler, buffer, length);
1594  }
1595  if (adler != original_adler) error();
1596 */
1597 
1598 /*
1599  uLong adler32_combine (uLong adler1, uLong adler2,
1600  z_off_t len2);
1601 
1602  Combine two Adler-32 checksums into one. For two sequences of bytes, seq1
1603  and seq2 with lengths len1 and len2, Adler-32 checksums were calculated for
1604  each, adler1 and adler2. adler32_combine() returns the Adler-32 checksum of
1605  seq1 and seq2 concatenated, requiring only adler1, adler2, and len2. Note
1606  that the z_off_t type (like off_t) is a signed integer. If len2 is
1607  negative, the result has no meaning or utility.
1608 */
1609 
1610  uLong crc32 (uLong crc, const Bytef *buf, uInt len);
1611 /*
1612  Update a running CRC-32 with the bytes buf[0..len-1] and return the
1613  updated CRC-32. If buf is Z_NULL, this function returns the required
1614  initial value for the crc. Pre- and post-conditioning (one's complement) is
1615  performed within this function so it shouldn't be done by the application.
1616 
1617  Usage example:
1618 
1619  uLong crc = crc32(0L, Z_NULL, 0);
1620 
1621  while (read_buffer(buffer, length) != EOF) {
1622  crc = crc32(crc, buffer, length);
1623  }
1624  if (crc != original_crc) error();
1625 */
1626 
1627 /*
1628  uLong crc32_combine (uLong crc1, uLong crc2, z_off_t len2);
1629 
1630  Combine two CRC-32 check values into one. For two sequences of bytes,
1631  seq1 and seq2 with lengths len1 and len2, CRC-32 check values were
1632  calculated for each, crc1 and crc2. crc32_combine() returns the CRC-32
1633  check value of seq1 and seq2 concatenated, requiring only crc1, crc2, and
1634  len2.
1635 */
1636 
1637 
1638  /* various hacks, don't look :) */
1639 
1640 /* deflateInit and inflateInit are macros to allow checking the zlib version
1641  * and the compiler's view of z_stream:
1642  */
1643  int deflateInit_ (z_streamp strm, int level,
1644  const char *version, int stream_size);
1645  int inflateInit_ (z_streamp strm,
1646  const char *version, int stream_size);
1647  int deflateInit2_ (z_streamp strm, int level, int method,
1648  int windowBits, int memLevel,
1649  int strategy, const char *version,
1650  int stream_size);
1651  int inflateInit2_ (z_streamp strm, int windowBits,
1652  const char *version, int stream_size);
1653  int inflateBackInit_ (z_streamp strm, int windowBits,
1654  unsigned char FAR *window,
1655  const char *version,
1656  int stream_size);
1657 #define deflateInit(strm, level) \
1658  deflateInit_((strm), (level), ZLIB_VERSION, (int)sizeof(z_stream))
1659 #define inflateInit(strm) \
1660  inflateInit_((strm), ZLIB_VERSION, (int)sizeof(z_stream))
1661 #define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \
1662  deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\
1663  (strategy), ZLIB_VERSION, (int)sizeof(z_stream))
1664 #define inflateInit2(strm, windowBits) \
1665  inflateInit2_((strm), (windowBits), ZLIB_VERSION, \
1666  (int)sizeof(z_stream))
1667 #define inflateBackInit(strm, windowBits, window) \
1668  inflateBackInit_((strm), (windowBits), (window), \
1669  ZLIB_VERSION, (int)sizeof(z_stream))
1670 
1671 #ifndef Z_SOLO
1672 
1673 /* gzgetc() macro and its supporting function and exposed data structure. Note
1674  * that the real internal state is much larger than the exposed structure.
1675  * This abbreviated structure exposes just enough for the gzgetc() macro. The
1676  * user should not mess with these exposed elements, since their names or
1677  * behavior could change in the future, perhaps even capriciously. They can
1678  * only be used by the gzgetc() macro. You have been warned.
1679  */
1680  int gzgetc_ (gzFile file); /* backward compatibility */
1681 #ifdef Z_PREFIX_SET
1682 # undef z_gzgetc
1683 # define z_gzgetc(g) \
1684  ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g))
1685 #else
1686 # define gzgetc(g) \
1687  ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g))
1688 #endif
1689 
1690 /* provide 64-bit offset functions if _LARGEFILE64_SOURCE defined, and/or
1691  * change the regular functions to 64 bits if _FILE_OFFSET_BITS is 64 (if
1692  * both are true, the application gets the *64 functions, and the regular
1693  * functions are changed to 64 bits) -- in case these are set on systems
1694  * without large file support, _LFS64_LARGEFILE must also be true
1695  */
1696 #ifdef Z_LARGE64
1697  gzFile gzopen64 (const char *, const char *);
1698  z_off64_t gzseek64 (gzFile, z_off64_t, int);
1699  z_off64_t gztell64 (gzFile);
1700  z_off64_t gzoffset64 (gzFile);
1701  uLong adler32_combine64 (uLong, uLong, z_off64_t);
1702  uLong crc32_combine64 (uLong, uLong, z_off64_t);
1703 #endif
1704 
1705 #if !defined(ZLIB_INTERNAL) && defined(Z_WANT64)
1706 # ifdef Z_PREFIX_SET
1707 # define z_gzopen z_gzopen64
1708 # define z_gzseek z_gzseek64
1709 # define z_gztell z_gztell64
1710 # define z_gzoffset z_gzoffset64
1711 # define z_adler32_combine z_adler32_combine64
1712 # define z_crc32_combine z_crc32_combine64
1713 # else
1714 # define gzopen gzopen64
1715 # define gzseek gzseek64
1716 # define gztell gztell64
1717 # define gzoffset gzoffset64
1718 # define adler32_combine adler32_combine64
1719 # define crc32_combine crc32_combine64
1720 # endif
1721 # ifndef Z_LARGE64
1722  gzFile gzopen64 (const char *, const char *);
1723  z_off_t gzseek64 (gzFile, z_off_t, int);
1724  z_off_t gztell64 (gzFile);
1725  z_off_t gzoffset64 (gzFile);
1726  uLong adler32_combine64 (uLong, uLong, z_off_t);
1727  uLong crc32_combine64 (uLong, uLong, z_off_t);
1728 # endif
1729 #else
1730  gzFile gzopen (const char *, const char *);
1731  z_off_t gzseek (gzFile, z_off_t, int);
1732  z_off_t gztell (gzFile);
1733  z_off_t gzoffset (gzFile);
1734  uLong adler32_combine (uLong, uLong, z_off_t);
1735  uLong crc32_combine (uLong, uLong, z_off_t);
1736 #endif
1737 
1738 #else /* Z_SOLO */
1739 
1740  uLong adler32_combine (uLong, uLong, z_off_t);
1741  uLong crc32_combine (uLong, uLong, z_off_t);
1742 
1743 #endif /* !Z_SOLO */
1744 
1745 /* hack for buggy compilers */
1746 #if !defined(ZUTIL_H) && !defined(NO_DUMMY_DECL)
1747  struct internal_state {int dummy;};
1748 #endif
1749 
1750 /* undocumented functions */
1751  const char * zError (int);
1752  int inflateSyncPoint (z_streamp);
1753 
1754 const uint32_t * get_crc_table(void);
1755  int inflateUndermine (z_streamp, int);
1756  int inflateResetKeep (z_streamp);
1757  int deflateResetKeep (z_streamp);
1758 #if defined(_WIN32) && !defined(Z_SOLO)
1759  gzFile gzopen_w (const wchar_t *path,
1760  const char *mode);
1761 #endif
1762 #if defined(STDC) || defined(Z_HAVE_STDARG_H)
1763 # ifndef Z_SOLO
1764  int gzvprintf Z_ARG((gzFile file,
1765  const char *format,
1766  va_list va));
1767 # endif
1768 #endif
1769 
1770 #ifdef __cplusplus
1771 }
1772 #endif
1773 
1774 #endif /* ZLIB_H */
1775 
1776 #else
1777 #include <zlib.h>
1778 #endif
1779 
1780 #endif
int gzflush(gzFile file, int flush)
Definition: gzwrite.c:445
int deflatePending(z_streamp strm, unsigned *pending, int *bits)
Definition: deflate.c:436
GLuint const GLchar * name
Definition: glext.h:6671
gzFile gzopen(const char *path, const char *mode)
Definition: gzlib.c:267
Byte FAR Bytef
Definition: zconf.h:340
uLong FAR uLongf
Definition: zconf.h:345
uLong compressBound(uLong sourceLen)
Definition: compress.c:66
int gzsetparams(gzFile file, int level, int strategy)
Definition: gzwrite.c:474
GLenum mode
Definition: glext.h:6857
int gzungetc(int c, gzFile file)
Definition: gzread.c:408
int gzeof(gzFile file)
Definition: gzlib.c:475
Definition: gzfile.h:5
#define z_const
Definition: zconf.h:224
z_off64_t gzoffset64(gzFile file)
Definition: gzlib.c:448
const char * zError(int err)
Definition: zutil.c:131
GLenum GLuint GLenum GLsizei const GLchar * buf
Definition: glext.h:8418
int inflateSync(z_streamp strm)
Definition: inflate.c:1359
Byte * voidp
Definition: zconf.h:354
uLong deflateBound(z_streamp strm, uLong sourceLen)
Definition: deflate.c:539
int deflateInit_(z_streamp strm, int level, const char *version, int stream_size)
Definition: deflate.c:204
long inflateMark(z_streamp strm)
Definition: inflate.c:1479
GLuint address
Definition: glext.h:10300
z_off_t gzseek(gzFile file, z_off_t offset, int whence)
Definition: gzlib.c:417
GLsizei const GLchar ** path
Definition: glext.h:7901
GLenum GLsizei len
Definition: glext.h:7389
z_off64_t gzseek64(gzFile file, z_off64_t offset, int whence)
Definition: gzlib.c:344
GLsizeiptr size
Definition: glext.h:6559
uint32_t adler32(uint32_t adler, const uint8_t *buf, size_t len)
Definition: adler32.c:49
GLdouble s
Definition: glext.h:6390
struct passwd out
Definition: missing_libc_functions.c:51
typedef void(__stdcall *PFN_DESTRUCTION_CALLBACK)(void *pData)
int inflateSyncPoint(z_streamp strm)
Definition: inflate.c:1409
int inflateGetHeader(z_streamp strm, gz_headerp head)
Definition: inflate.c:1313
gzFile gzopen64(const char *path, const char *mode)
Definition: gzlib.c:272
int inflateCopy(z_streamp dest, z_streamp source)
Definition: inflate.c:1418
int inflateResetKeep(z_streamp strm)
Definition: inflate.c:117
const GLubyte * c
Definition: glext.h:9812
int gzputs(gzFile file, const char *str)
Definition: gzwrite.c:282
int dummy
Definition: lstrlib.c:1125
int inflateBackInit_(z_streamp strm, int windowBits, unsigned char FAR *window, const char *version, int stream_size)
Definition: infback.c:28
Byte FAR * voidpf
Definition: zconf.h:353
int deflateInit2_(z_streamp strm, int level, int method, int windowBits, int memLevel, int strategy, const char *version, int stream_size)
Definition: deflate.c:212
int inflateEnd(z_streamp strm)
Definition: inflate.c:1248
int gzgetc(gzFile file)
Definition: gzread.c:375
int gzclose(gzFile file)
Definition: gzclose.c:14
z_off_t gztell(gzFile file)
Definition: gzlib.c:440
uLong zlibCompileFlags(void)
Definition: zutil.c:31
int inflate(z_streamp strm, int flush)
Definition: inflate.c:601
int inflateBack(z_streamp strm, in_func in, void FAR *in_desc, out_func out, void FAR *out_desc)
Definition: infback.c:244
version
Definition: setup.py:6
int inflateInit2_(z_streamp strm, int windowBits, const char *version, int stream_size)
Definition: inflate.c:190
Byte const * voidpc
Definition: zconf.h:352
GLint level
Definition: glext.h:6293
char * gzgets(gzFile file, char *buf, int len)
Definition: gzread.c:465
char reserved[128]
Definition: scefiber.c:17
const char * gzerror(gzFile file, int *errnum)
Definition: gzlib.c:490
static const unsigned char msg[]
Definition: ccm.c:375
z_off_t gzoffset(gzFile file)
Definition: gzlib.c:469
int compress2(Bytef *dest, uLongf *destLen, const Bytef *source, uLong sourceLen, int level)
Definition: compress.c:22
static uint64_t state[MAX_PADS]
Definition: xenon360_input.c:33
time_t time(time_t *timer)
const uint32_t * get_crc_table(void)
Definition: libz-crc32.c:85
GLuint in
Definition: glext.h:10523
gzFile gzdopen(int fd, const char *mode)
Definition: gzlib.c:277
int deflateCopy(z_streamp dest, z_streamp source)
Definition: deflate.c:981
void gzclearerr(gzFile file)
Definition: gzlib.c:508
int inflateUndermine(z_streamp strm, int subvert)
Definition: inflate.c:1463
const char * zlibVersion(void)
Definition: zutil.c:26
int gzbuffer(gzFile file, unsigned size)
Definition: gzlib.c:301
#define stream_size
Definition: ps3_defines.h:295
int inflatePrime(z_streamp strm, int bits, int value)
Definition: inflate.c:233
#define z_off_t
Definition: zconf.h:444
int deflatePrime(z_streamp strm, int bits, int value)
Definition: deflate.c:448
int inflateSetDictionary(z_streamp strm, const Bytef *dictionary, uInt dictLength)
Definition: inflate.c:1281
int deflateSetDictionary(z_streamp strm, const Bytef *dictionary, uInt dictLength)
Definition: deflate.c:314
Definition: nk_menu.h:45
int inflateBackEnd(z_streamp strm)
Definition: infback.c:620
int deflateResetKeep(z_streamp strm)
Definition: deflate.c:380
int inflateInit_(z_streamp strm, const char *version, int stream_size)
Definition: inflate.c:228
#define free_func
Definition: ps3_defines.h:288
GLsizei GLsizei GLchar * source
Definition: glext.h:6688
int gzgetc_(gzFile file)
Definition: gzread.c:403
int uncompress(unsigned char *dest, uint32_t *destLen, const unsigned char *source, uint32_t sourceLen)
Definition: uncompr.c:24
int deflateReset(z_streamp strm)
Definition: deflate.c:414
GLenum GLint GLenum GLsizei GLsizei GLsizei GLint GLsizei const GLvoid * bits
Definition: glext.h:11836
int deflateParams(z_streamp strm, int level, int strategy)
Definition: deflate.c:471
GLint GLint GLsizei GLsizei GLsizei GLint GLenum format
Definition: glext.h:6293
int gzclose_r(gzFile file)
Definition: gzread.c:543
int gzvprintf(gzFile file, const char *format, va_list va)
int gzclose_w(gzFile file)
Definition: gzwrite.c:512
int deflateTune(z_streamp strm, int good_length, int max_lazy, int nice_length, int max_chain)
Definition: deflate.c:509
int gzdirect(gzFile file)
Definition: gzread.c:525
z_off64_t gztell64(gzFile file)
Definition: gzlib.c:425
int deflateSetHeader(z_streamp strm, gz_headerp head)
Definition: deflate.c:425
unsigned long crc32(unsigned long crc, const unsigned char *buf, unsigned int len)
Definition: libz-crc32.c:70
#define FAR
Definition: zconf.h:327
#define Z_ARG(args)
Definition: zconf.h:277
GLsizei const GLfloat * value
Definition: glext.h:6709
int compress(Bytef *dest, uLongf *destLen, const Bytef *source, uLong sourceLen)
Definition: compress.c:57
unsigned int uInt
Definition: zconf.h:333
vu8 head
Definition: keyboard.c:426
int deflate(z_streamp strm, int flush)
Definition: deflate.c:633
int gzrewind(gzFile file)
Definition: gzlib.c:323
int gzread(gzFile file, voidp buf, unsigned len)
Definition: gzread.c:279
Definition: civetweb.c:1024
unsigned long uLong
Definition: zconf.h:334
int gzwrite(gzFile file, voidpc buf, unsigned len)
Definition: gzwrite.c:161
int deflateEnd(z_streamp strm)
Definition: deflate.c:945
int inflateGetDictionary(z_streamp strm, Bytef *dictionary, uInt *dictLength)
Definition: inflate.c:1261
int inflateReset2(z_streamp strm, int windowBits)
Definition: inflate.c:153
#define z_off64_t
Definition: gzguts.h:138
unsigned char uint8_t
Definition: stdint.h:124
unsigned int uint32_t
Definition: stdint.h:126
int inflateReset(z_streamp strm)
Definition: inflate.c:141
int gzprintf(gzFile file, const char *format, int a1, int a2, int a3, int a4, int a5, int a6, int a7, int a8, int a9, int a10, int a11, int a12, int a13, int a14, int a15, int a16, int a17, int a18, int a19, int a20)
Definition: gzwrite.c:371
int gzputc(gzFile file, int c)
Definition: gzwrite.c:237