projects/ldc: lphobos/etc/c/zlib.d annotate

annotate lphobos/etc/c/zlib.d @ 837:331a176c1f4f

Removed error on naked, not fully complete, but I'll be doing more work on it during this Christmas, and some things do work. Fixed taking delegate of final class method. see mini/delegate3.d.

author	Tomas Lindquist Olsen <tomas.l.olsen@gmail.com>
date	Tue, 09 Dec 2008 14:07:30 +0100
parents	373489eeaf90
children

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

Mercurial > projects > ldc

annotate lphobos/etc/c/zlib.d @ 837:331a176c1f4f