src/external/gpl3/binutils.old/dist/zlib/zlib.h - diff

Return to zlib.h CVS log

Up to [cvs.NetBSD.org] / src / external / gpl3 / binutils.old / dist / zlib

Please note that diffs are not public domain; they are subject to the copyright notices on the relevant files.

Diff for /src/external/gpl3/binutils.old/dist/zlib/zlib.h between version 1.3 and 1.4

version 1.3, 2018/04/14 15:49:48

version 1.4, 2020/04/03 17:51:19

Line 1

/* zlib.h -- interface of the 'zlib' general purpose compression library

version 1.2.8, April 28th, 2013

version 1.2.11, January 15th, 2017

This software is provided 'as-is', without any express or implied

warranty. In no event will the authors be held liable for any damages

Line 37

extern "C" {

#endif

#define ZLIB_VERSION "1.2.8"

#define ZLIB_VERSION "1.2.11"

#define ZLIB_VERNUM 0x1280

#define ZLIB_VERNUM 0x12b0

#define ZLIB_VER_MAJOR 1

#define ZLIB_VER_MINOR 2

#define ZLIB_VER_REVISION 8

#define ZLIB_VER_REVISION 11

#define ZLIB_VER_SUBREVISION 0

Line 65 extern "C" {

with "gz". The gzip format is different from the zlib format. gzip is a

gzip wrapper, documented in RFC 1952, wrapped around a deflate stream.

This library can optionally read and write gzip streams in memory as well.

This library can optionally read and write gzip and raw deflate streams in

memory as well.

The zlib format was designed to be compact and fast for use in memory

and on communications channels. The gzip format was designed for single-

Line 74 extern "C" {

Line 75 extern "C" {

The library does not install any signal handler. The decoder checks

the consistency of the compressed data, so the library should never crash

even in case of corrupted input.

even in the case of corrupted input.

typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size));

Line 87 typedef struct z_stream_s {

Line 88 typedef struct z_stream_s {

uInt avail_in; /* number of bytes available at next_in */

uLong total_in; /* total number of input bytes read so far */

Bytef *next_out; /* next output byte should be put there */

Bytef *next_out; /* next output byte will go here */

uInt avail_out; /* remaining free space at next_out */

uLong total_out; /* total number of bytes output so far */

Line 98 typedef struct z_stream_s {

Line 99 typedef struct z_stream_s {

free_func zfree; /* used to free the internal state */

voidpf opaque; /* private data object passed to zalloc and zfree */

int data_type; /* best guess about the data type: binary or text */

int data_type; /* best guess about the data type: binary or text

uLong adler; /* adler32 value of the uncompressed data */

for deflate, or the decoding state for inflate */

uLong adler; /* Adler-32 or CRC-32 value of the uncompressed data */

uLong reserved; /* reserved for future use */

} z_stream;

Line 142 typedef gz_header FAR *gz_headerp;

Line 144 typedef gz_header FAR *gz_headerp;

zalloc must return Z_NULL if there is not enough memory for the object.

If zlib is used in a multi-threaded application, zalloc and zfree must be

thread safe.

thread safe. In that case, zlib is thread-safe. When zalloc and zfree are

Z_NULL on entry to the initialization function, they are set to internal

routines that use the standard library functions malloc() and free().

On 16-bit systems, the functions zalloc and zfree must be able to allocate

exactly 65536 bytes, but will not be required to allocate more than this if

Line 155 typedef gz_header FAR *gz_headerp;

Line 159 typedef gz_header FAR *gz_headerp;

The fields total_in and total_out can be used for statistics or progress

reports. After compression, total_in holds the total size of the

uncompressed data and may be saved for use in the decompressor (particularly

uncompressed data and may be saved for use by the decompressor (particularly

if the decompressor wants to decompress everything in a single step).

Line 200 typedef gz_header FAR *gz_headerp;

Line 204 typedef gz_header FAR *gz_headerp;

#define Z_TEXT 1

#define Z_ASCII Z_TEXT /* for compatibility with 1.2.2 and earlier */

#define Z_UNKNOWN 2

/* Possible values of the data_type field (though see inflate()) */

/* Possible values of the data_type field for deflate() */

#define Z_DEFLATED 8

/* The deflate compression method (the only one supported in this version) */

Line 258 ZEXTERN int ZEXPORT deflate OF((z_stream

Line 262 ZEXTERN int ZEXPORT deflate OF((z_stream

enough room in the output buffer), next_in and avail_in are updated and

processing will resume at this point for the next call of deflate().

- Provide more output starting at next_out and update next_out and avail_out

- Generate more output starting at next_out and update next_out and avail_out

accordingly. This action is forced if the parameter flush is non zero.

Forcing flush frequently degrades the compression ratio, so this parameter

should be set only when necessary (in interactive applications). Some

should be set only when necessary. Some output may be provided even if

output may be provided even if flush is not set.

flush is zero.

Before the call of deflate(), the application should ensure that at least

one of the actions is possible, by providing more input and/or consuming more

Line 271 ZEXTERN int ZEXPORT deflate OF((z_stream

Line 275 ZEXTERN int ZEXPORT deflate OF((z_stream

output when it wants, for example when the output buffer is full (avail_out

== 0), or after each call of deflate(). If deflate returns Z_OK and with

zero avail_out, it must be called again after making room in the output

buffer because there might be more output pending.

buffer because there might be more output pending. See deflatePending(),

which can be used if desired to determine whether or not there is more ouput

in that case.

Normally the parameter flush is set to Z_NO_FLUSH, which allows deflate to

decide how much data to accumulate before producing output, in order to

Line 292 ZEXTERN int ZEXPORT deflate OF((z_stream

Line 298 ZEXTERN int ZEXPORT deflate OF((z_stream

input data so far will be available to the decompressor, as for Z_SYNC_FLUSH.

This completes the current deflate block and follows it with an empty fixed

codes block that is 10 bits long. This assures that enough bytes are output

in order for the decompressor to finish the block before the empty fixed code

in order for the decompressor to finish the block before the empty fixed

block.

codes block.

If flush is set to Z_BLOCK, a deflate block is completed and emitted, as

for Z_SYNC_FLUSH, but the output is not aligned on a byte boundary, and up to

Line 319 ZEXTERN int ZEXPORT deflate OF((z_stream

Line 325 ZEXTERN int ZEXPORT deflate OF((z_stream

If the parameter flush is set to Z_FINISH, pending input is processed,

pending output is flushed and deflate returns with Z_STREAM_END if there was

enough output space; if deflate returns with Z_OK, this function must be

enough output space. If deflate returns with Z_OK or Z_BUF_ERROR, this

called again with Z_FINISH and more output space (updated avail_out) but no

function must be called again with Z_FINISH and more output space (updated

more input data, until it returns with Z_STREAM_END or an error. After

avail_out) but no more input data, until it returns with Z_STREAM_END or an

deflate has returned Z_STREAM_END, the only possible operations on the stream

error. After deflate has returned Z_STREAM_END, the only possible operations

are deflateReset or deflateEnd.

on the stream are deflateReset or deflateEnd.

Z_FINISH can be used immediately after deflateInit if all the compression

Z_FINISH can be used in the first deflate call after deflateInit if all the

is to be done in a single step. In this case, avail_out must be at least the

compression is to be done in a single step. In order to complete in one

value returned by deflateBound (see below). Then deflate is guaranteed to

call, avail_out must be at least the value returned by deflateBound (see

return Z_STREAM_END. If not enough output space is provided, deflate will

below). Then deflate is guaranteed to return Z_STREAM_END. If not enough

not return Z_STREAM_END, and it must be called again as described above.

output space is provided, deflate will not return Z_STREAM_END, and it must

be called again as described above.

deflate() sets strm->adler to the adler32 checksum of all input read

so far (that is, total_in bytes).

deflate() sets strm->adler to the Adler-32 checksum of all input read

so far (that is, total_in bytes). If a gzip stream is being generated, then

strm->adler will be the CRC-32 checksum of the input read so far. (See

deflateInit2 below.)

deflate() may update strm->data_type if it can make a good guess about

the input data type (Z_BINARY or Z_TEXT). In doubt, the data is considered

the input data type (Z_BINARY or Z_TEXT). If in doubt, the data is

binary. This field is only for information purposes and does not affect the

considered binary. This field is only for information purposes and does not

compression algorithm in any manner.

affect the compression algorithm in any manner.

deflate() returns Z_OK if some progress has been made (more input

processed or more output produced), Z_STREAM_END if all input has been

consumed and all output has been produced (only when flush is set to

Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example

if next_in or next_out was Z_NULL), Z_BUF_ERROR if no progress is possible

if next_in or next_out was Z_NULL or the state was inadvertently written over

(for example avail_in or avail_out was zero). Note that Z_BUF_ERROR is not

by the application), or Z_BUF_ERROR if no progress is possible (for example

fatal, and deflate() can be called again with more input and more output

avail_in or avail_out was zero). Note that Z_BUF_ERROR is not fatal, and

space to continue compressing.

deflate() can be called again with more input and more output space to

continue compressing.

Line 369 ZEXTERN int ZEXPORT inflateInit OF((z_st

Line 379 ZEXTERN int ZEXPORT inflateInit OF((z_st

Initializes the internal stream state for decompression. The fields

next_in, avail_in, zalloc, zfree and opaque must be initialized before by

the caller. If next_in is not Z_NULL and avail_in is large enough (the

the caller. In the current version of inflate, the provided input is not

exact value depends on the compression method), inflateInit determines the

read or consumed. The allocation of a sliding window will be deferred to

compression method from the zlib header and allocates all data structures

the first call of inflate (if the decompression does not complete on the

accordingly; otherwise the allocation will be deferred to the first call of

first call). If zalloc and zfree are set to Z_NULL, inflateInit updates

inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them to

them to use default allocation functions.

use default allocation functions.

inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough

memory, Z_VERSION_ERROR if the zlib library version is incompatible with the

version assumed by the caller, or Z_STREAM_ERROR if the parameters are

invalid, such as a null pointer to the structure. msg is set to null if

there is no error message. inflateInit does not perform any decompression

there is no error message. inflateInit does not perform any decompression.

apart from possibly reading the zlib header if present: actual decompression

Actual decompression will be done by inflate(). So next_in, and avail_in,

will be done by inflate(). (So next_in and avail_in may be modified, but

next_out, and avail_out are unused and unchanged. The current

next_out and avail_out are unused and unchanged.) The current implementation

implementation of inflateInit() does not process any header information --

of inflateInit() does not process any header information -- that is deferred

that is deferred until inflate() is called.

until inflate() is called.

Line 401 ZEXTERN int ZEXPORT inflate OF((z_stream

Line 409 ZEXTERN int ZEXPORT inflate OF((z_stream

- Decompress more input starting at next_in and update next_in and avail_in

accordingly. If not all input can be processed (because there is not

enough room in the output buffer), next_in is updated and processing will

enough room in the output buffer), then next_in and avail_in are updated

resume at this point for the next call of inflate().

accordingly, and processing will resume at this point for the next call of

inflate().

- Provide more output starting at next_out and update next_out and avail_out

- Generate more output starting at next_out and update next_out and avail_out

accordingly. inflate() provides as much output as possible, until there is

no more input data or no more space in the output buffer (see below about

the flush parameter).

Before the call of inflate(), the application should ensure that at least

one of the actions is possible, by providing more input and/or consuming more

output, and updating the next_* and avail_* values accordingly. The

output, and updating the next_* and avail_* values accordingly. If the

caller of inflate() does not provide both available input and available

output space, it is possible that there will be no progress made. The

application can consume the uncompressed output when it wants, for example

when the output buffer is full (avail_out == 0), or after each call of

inflate(). If inflate returns Z_OK and with zero avail_out, it must be

Line 428 ZEXTERN int ZEXPORT inflate OF((z_stream

Line 439 ZEXTERN int ZEXPORT inflate OF((z_stream

gets to the end of that block, or when it runs out of data.

The Z_BLOCK option assists in appending to or combining deflate streams.

Also to assist in this, on return inflate() will set strm->data_type to the

To assist in this, on return inflate() always sets strm->data_type to the

number of unused bits in the last byte taken from strm->next_in, plus 64 if

inflate() is currently decoding the last block in the deflate stream, plus

128 if inflate() returned immediately after decoding an end-of-block code or

Line 454 ZEXTERN int ZEXPORT inflate OF((z_stream

Line 465 ZEXTERN int ZEXPORT inflate OF((z_stream

this case all pending input is processed and all pending output is flushed;

avail_out must be large enough to hold all of the uncompressed data for the

operation to complete. (The size of the uncompressed data may have been

saved by the compressor for this purpose.) The use of Z_FINISH is not

required to perform an inflation in one step. However it may be used to

inform inflate that a faster approach can be used for the single inflate()

call. Z_FINISH also informs inflate to not maintain a sliding window if the

Line 476 ZEXTERN int ZEXPORT inflate OF((z_stream

Line 487 ZEXTERN int ZEXPORT inflate OF((z_stream

chosen by the compressor and returns Z_NEED_DICT; otherwise it sets

strm->adler to the Adler-32 checksum of all output produced so far (that is,

total_out bytes) and returns Z_OK, Z_STREAM_END or an error code as described

below. At the end of the stream, inflate() checks that its computed adler32

below. At the end of the stream, inflate() checks that its computed Adler-32

checksum is equal to that saved by the compressor and returns Z_STREAM_END

only if the checksum is correct.

inflate() can decompress and check either zlib-wrapped or gzip-wrapped

deflate data. The header type is detected automatically, if requested when

initializing with inflateInit2(). Any information contained in the gzip

header is not retained, so applications that need that information should

header is not retained unless inflateGetHeader() is used. When processing

instead use raw inflate, see inflateInit2() below, or inflateBack() and

perform their own processing of the gzip header and trailer. When processing

gzip-wrapped deflate data, strm->adler32 is set to the CRC-32 of the output

producted so far. The CRC-32 is checked against the gzip trailer.

produced so far. The CRC-32 is checked against the gzip trailer, as is the

uncompressed length, modulo 2^32.

inflate() returns Z_OK if some progress has been made (more input processed

or more output produced), Z_STREAM_END if the end of the compressed data has

been reached and all uncompressed output has been produced, Z_NEED_DICT if a

preset dictionary is needed at this point, Z_DATA_ERROR if the input data was

corrupted (input stream not conforming to the zlib format or incorrect check

value), Z_STREAM_ERROR if the stream structure was inconsistent (for example

value, in which case strm->msg points to a string with a more specific

next_in or next_out was Z_NULL), Z_MEM_ERROR if there was not enough memory,

error), Z_STREAM_ERROR if the stream structure was inconsistent (for example

Z_BUF_ERROR if no progress is possible or if there was not enough room in the

next_in or next_out was Z_NULL, or the state was inadvertently written over

output buffer when Z_FINISH is used. Note that Z_BUF_ERROR is not fatal, and

by the application), Z_MEM_ERROR if there was not enough memory, Z_BUF_ERROR

if no progress was possible or if there was not enough room in the output

buffer when Z_FINISH is used. Note that Z_BUF_ERROR is not fatal, and

inflate() can be called again with more input and more output space to

continue decompressing. If Z_DATA_ERROR is returned, the application may

then call inflateSync() to look for a good compression block if a partial

recovery of the data is desired.

recovery of the data is to be attempted.

Line 511 ZEXTERN int ZEXPORT inflateEnd OF((z_str

Line 523 ZEXTERN int ZEXPORT inflateEnd OF((z_str

This function discards any unprocessed input and does not flush any pending

output.

inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state

inflateEnd returns Z_OK if success, or Z_STREAM_ERROR if the stream state

was inconsistent. In the error case, msg may be set but then points to a

was inconsistent.

static string (which must not be deallocated).

Line 544 ZEXTERN int ZEXPORT deflateInit2 OF((z_s

Line 555 ZEXTERN int ZEXPORT deflateInit2 OF((z_s

compression at the expense of memory usage. The default value is 15 if

deflateInit is used instead.

For the current implementation of deflate(), a windowBits value of 8 (a

window size of 256 bytes) is not supported. As a result, a request for 8

will result in 9 (a 512-byte window). In that case, providing 8 to

inflateInit2() will result in an error when the zlib header with 9 is

checked against the initialization of inflate(). The remedy is to not use 8

with deflateInit2() with this initialization, or at least in that case use 9

with inflateInit2().

windowBits can also be -8..-15 for raw deflate. In this case, -windowBits

determines the window size. deflate() will then generate raw deflate data

with no zlib header or trailer, and will not compute an adler32 check value.

with no zlib header or trailer, and will not compute a check value.

windowBits can also be greater than 15 for optional gzip encoding. Add

16 to windowBits to write a simple gzip header and trailer around the

compressed data instead of a zlib wrapper. The gzip header will have no

file name, no extra data, no comment, no modification time (set to zero), no

header crc, and the operating system will be set to 255 (unknown). If a

header crc, and the operating system will be set to the appropriate value,

gzip stream is being written, strm->adler is a crc32 instead of an adler32.

if the operating system was determined at compile time. If a gzip stream is

being written, strm->adler is a CRC-32 instead of an Adler-32.

For raw deflate or gzip encoding, a request for a 256-byte window is

rejected as invalid, since only the zlib header provides a means of

transmitting the window size to the decompressor.

The memLevel parameter specifies how much memory should be allocated

for the internal compression state. memLevel=1 uses minimum memory but is

Line 614 ZEXTERN int ZEXPORT deflateSetDictionary

Line 638 ZEXTERN int ZEXPORT deflateSetDictionary

addition, the current implementation of deflate will use at most the window

size minus 262 bytes of the provided dictionary.

Upon return of this function, strm->adler is set to the adler32 value

Upon return of this function, strm->adler is set to the Adler-32 value

of the dictionary; the decompressor may later use this value to determine

which dictionary has been used by the compressor. (The adler32 value

which dictionary has been used by the compressor. (The Adler-32 value

applies to the whole dictionary even if only a subset of the dictionary is

actually used by the compressor.) If a raw deflate was requested, then the

adler32 value is not computed and strm->adler is not set.

Adler-32 value is not computed and strm->adler is not set.

deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a

parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is

Line 628 ZEXTERN int ZEXPORT deflateSetDictionary

Line 652 ZEXTERN int ZEXPORT deflateSetDictionary

not perform any compression: this will be done by deflate().

ZEXTERN int ZEXPORT deflateGetDictionary OF((z_streamp strm,

Bytef *dictionary,

uInt *dictLength));

Returns the sliding dictionary being maintained by deflate. dictLength is

set to the number of bytes in the dictionary, and that many bytes are copied

to dictionary. dictionary must have enough space, where 32768 bytes is

always enough. If deflateGetDictionary() is called with dictionary equal to

Z_NULL, then only the dictionary length is returned, and nothing is copied.

Similary, if dictLength is Z_NULL, then it is not set.

deflateGetDictionary() may return a length less than the window size, even

when more than the window size in input has been provided. It may return up

to 258 bytes less in that case, due to how zlib's implementation of deflate

manages the sliding window and lookahead for matches, where matches can be

up to 258 bytes long. If the application needs the last window-size bytes of

input, then that would need to be saved by the application outside of zlib.

deflateGetDictionary returns Z_OK on success, or Z_STREAM_ERROR if the

stream state is inconsistent.

ZEXTERN int ZEXPORT deflateCopy OF((z_streamp dest,

z_streamp source));

Line 648 ZEXTERN int ZEXPORT deflateCopy OF((z_st

Line 694 ZEXTERN int ZEXPORT deflateCopy OF((z_st

ZEXTERN int ZEXPORT deflateReset OF((z_streamp strm));

This function is equivalent to deflateEnd followed by deflateInit,

This function is equivalent to deflateEnd followed by deflateInit, but

but does not free and reallocate all the internal compression state. The

does not free and reallocate the internal compression state. The stream

stream will keep the same compression level and any other attributes that

will leave the compression level and any other attributes that may have been

may have been set by deflateInit2.

set unchanged.

deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source

stream state was inconsistent (such as zalloc or state being Z_NULL).

Line 662 ZEXTERN int ZEXPORT deflateParams OF((z_

Line 708 ZEXTERN int ZEXPORT deflateParams OF((z_

int strategy));

Dynamically update the compression level and compression strategy. The

interpretation of level and strategy is as in deflateInit2. This can be

interpretation of level and strategy is as in deflateInit2(). This can be

used to switch between compression and straight copy of the input data, or

to switch to a different kind of input data requiring a different strategy.

If the compression level is changed, the input available so far is

If the compression approach (which is a function of the level) or the

compressed with the old level (and may be flushed); the new level will take

strategy is changed, and if any input has been consumed in a previous

effect only at the next call of deflate().

deflate() call, then the input available so far is compressed with the old

level and strategy using deflate(strm, Z_BLOCK). There are three approaches

Before the call of deflateParams, the stream state must be set as for

for the compression levels 0, 1..3, and 4..9 respectively. The new level

a call of deflate(), since the currently available input may have to be

and strategy will take effect at the next call of deflate().

compressed and flushed. In particular, strm->avail_out must be non-zero.

If a deflate(strm, Z_BLOCK) is performed by deflateParams(), and it does

deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source

not have enough output space to complete, then the parameter change will not

stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR if

take effect. In this case, deflateParams() can be called again with the

strm->avail_out was zero.

same parameters and more output space to try again.

In order to assure a change in the parameters on the first try, the

deflate stream should be flushed using deflate() with Z_BLOCK or other flush

request until strm.avail_out is not zero, before calling deflateParams().

Then no more input data should be provided before the deflateParams() call.

If this is done, the old level and strategy will be applied to the data

compressed before deflateParams(), and the new level and strategy will be

applied to the the data compressed after deflateParams().

deflateParams returns Z_OK on success, Z_STREAM_ERROR if the source stream

state was inconsistent or if a parameter was invalid, or Z_BUF_ERROR if

there was not enough output space to complete the compression of the

available input data before a change in the strategy or approach. Note that

in the case of a Z_BUF_ERROR, the parameters are not changed. A return

value of Z_BUF_ERROR is not fatal, in which case deflateParams() can be

retried with more output space.

ZEXTERN int ZEXPORT deflateTune OF((z_streamp strm,

Line 793 ZEXTERN int ZEXPORT inflateInit2 OF((z_s

Line 855 ZEXTERN int ZEXPORT inflateInit2 OF((z_s

is for use with other formats that use the deflate compressed data format

such as zip. Those formats provide their own check values. If a custom

format is developed using the raw deflate format for compressed data, it is

recommended that a check value such as an adler32 or a crc32 be applied to

recommended that a check value such as an Adler-32 or a CRC-32 be applied to

the uncompressed data as is done in the zlib, gzip, and zip formats. For

most applications, the zlib format should be used as is. Note that comments

above on the use in deflateInit2() applies to the magnitude of windowBits.

Line 802 ZEXTERN int ZEXPORT inflateInit2 OF((z_s

Line 864 ZEXTERN int ZEXPORT inflateInit2 OF((z_s

32 to windowBits to enable zlib and gzip decoding with automatic header

detection, or add 16 to decode only the gzip format (the zlib format will

return a Z_DATA_ERROR). If a gzip stream is being decoded, strm->adler is a

crc32 instead of an adler32.

CRC-32 instead of an Adler-32. Unlike the gunzip utility and gzread() (see

below), inflate() will not automatically decode concatenated gzip streams.

inflate() will return Z_STREAM_END at the end of the gzip stream. The state

would need to be reset to continue decoding a subsequent gzip stream.

inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough

memory, Z_VERSION_ERROR if the zlib library version is incompatible with the

Line 823 ZEXTERN int ZEXPORT inflateSetDictionary

Line 888 ZEXTERN int ZEXPORT inflateSetDictionary

Initializes the decompression dictionary from the given uncompressed byte

sequence. This function must be called immediately after a call of inflate,

if that call returned Z_NEED_DICT. The dictionary chosen by the compressor

can be determined from the adler32 value returned by that call of inflate.

can be determined from the Adler-32 value returned by that call of inflate.

The compressor and decompressor must use exactly the same dictionary (see

deflateSetDictionary). For raw inflate, this function can be called at any

time to set the dictionary. If the provided dictionary is smaller than the

Line 834 ZEXTERN int ZEXPORT inflateSetDictionary

Line 899 ZEXTERN int ZEXPORT inflateSetDictionary

inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a

parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is

inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the

expected one (incorrect adler32 value). inflateSetDictionary does not

expected one (incorrect Adler-32 value). inflateSetDictionary does not

perform any decompression: this will be done by subsequent calls of

inflate().

Line 892 ZEXTERN int ZEXPORT inflateCopy OF((z_st

Line 957 ZEXTERN int ZEXPORT inflateCopy OF((z_st

ZEXTERN int ZEXPORT inflateReset OF((z_streamp strm));

This function is equivalent to inflateEnd followed by inflateInit,

but does not free and reallocate all the internal decompression state. The

but does not free and reallocate the internal decompression state. The

stream will keep attributes that may have been set by inflateInit2.

inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source

Line 904 ZEXTERN int ZEXPORT inflateReset2 OF((z_

Line 969 ZEXTERN int ZEXPORT inflateReset2 OF((z_

This function is the same as inflateReset, but it also permits changing

the wrap and window size requests. The windowBits parameter is interpreted

the same as it is for inflateInit2.

the same as it is for inflateInit2. If the window size is changed, then the

memory allocated for the window is freed, and the window will be reallocated

by inflate() if needed.

inflateReset2 returns Z_OK if success, or Z_STREAM_ERROR if the source

stream state was inconsistent (such as zalloc or state being Z_NULL), or if

Line 956 ZEXTERN long ZEXPORT inflateMark OF((z_s

Line 1023 ZEXTERN long ZEXPORT inflateMark OF((z_s

location in the input stream can be determined from avail_in and data_type

as noted in the description for the Z_BLOCK flush parameter for inflate.

inflateMark returns the value noted above or -1 << 16 if the provided

inflateMark returns the value noted above, or -65536 if the provided

source stream state was inconsistent.

Line 1048 ZEXTERN int ZEXPORT inflateBack OF((z_st

Line 1115 ZEXTERN int ZEXPORT inflateBack OF((z_st

This routine would normally be used in a utility that reads zip or gzip

files and writes out uncompressed files. The utility would decode the

header and process the trailer on its own, hence this routine expects only

the raw deflate stream to decompress. This is different from the normal

the raw deflate stream to decompress. This is different from the default

behavior of inflate(), which expects either a zlib or gzip header and

behavior of inflate(), which expects a zlib header and trailer around the

trailer around the deflate stream.

deflate stream.

inflateBack() uses two subroutines supplied by the caller that are then

called by inflateBack() for input and output. inflateBack() calls those

Line 1059 ZEXTERN int ZEXPORT inflateBack OF((z_st

Line 1126 ZEXTERN int ZEXPORT inflateBack OF((z_st

parameters and return types are defined above in the in_func and out_func

typedefs. inflateBack() will call in(in_desc, &buf) which should return the

number of bytes of provided input, and a pointer to that input in buf. If

there is no input available, in() must return zero--buf is ignored in that

there is no input available, in() must return zero -- buf is ignored in that

case--and inflateBack() will return a buffer error. inflateBack() will call

case -- and inflateBack() will return a buffer error. inflateBack() will

out(out_desc, buf, len) to write the uncompressed data buf[0..len-1]. out()

call out(out_desc, buf, len) to write the uncompressed data buf[0..len-1].

should return zero on success, or non-zero on failure. If out() returns

out() should return zero on success, or non-zero on failure. If out()

non-zero, inflateBack() will return with an error. Neither in() nor out()

returns non-zero, inflateBack() will return with an error. Neither in() nor

are permitted to change the contents of the window provided to

out() are permitted to change the contents of the window provided to

inflateBackInit(), which is also the buffer that out() uses to write from.

The length written by out() will be at most the window size. Any non-zero

amount of input may be provided by in().

Line 1092 ZEXTERN int ZEXPORT inflateBack OF((z_st

Line 1159 ZEXTERN int ZEXPORT inflateBack OF((z_st

using strm->next_in which will be Z_NULL only if in() returned an error. If

strm->next_in is not Z_NULL, then the Z_BUF_ERROR was due to out() returning

non-zero. (in() will always be called before out(), so strm->next_in is

assured to be defined if out() returns non-zero.) Note that inflateBack()

cannot return Z_OK.

Line 1114 ZEXTERN uLong ZEXPORT zlibCompileFlags O

Line 1181 ZEXTERN uLong ZEXPORT zlibCompileFlags O

7.6: size of z_off_t

Compiler, assembler, and debug options:

8: DEBUG

8: ZLIB_DEBUG

9: ASMV or ASMINF -- use ASM code

10: ZLIB_WINAPI -- exported functions use the WINAPI calling convention

11: 0 (reserved)

Line 1164 ZEXTERN int ZEXPORT compress OF((Bytef *

Line 1231 ZEXTERN int ZEXPORT compress OF((Bytef *

the byte length of the source buffer. Upon entry, destLen is the total size

of the destination buffer, which must be at least the value returned by

compressBound(sourceLen). Upon exit, destLen is the actual size of the

compressed buffer.

compressed data. compress() is equivalent to compress2() with a level

parameter of Z_DEFAULT_COMPRESSION.

compress returns Z_OK if success, Z_MEM_ERROR if there was not

enough memory, Z_BUF_ERROR if there was not enough room in the output

Line 1180 ZEXTERN int ZEXPORT compress2 OF((Bytef

Line 1248 ZEXTERN int ZEXPORT compress2 OF((Bytef

length of the source buffer. Upon entry, destLen is the total size of the

destination buffer, which must be at least the value returned by

compressBound(sourceLen). Upon exit, destLen is the actual size of the

compressed buffer.

compressed data.

compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough

memory, Z_BUF_ERROR if there was not enough room in the output buffer,

Line 1203 ZEXTERN int ZEXPORT uncompress OF((Bytef

Line 1271 ZEXTERN int ZEXPORT uncompress OF((Bytef

uncompressed data. (The size of the uncompressed data must have been saved

previously by the compressor and transmitted to the decompressor by some

mechanism outside the scope of this compression library.) Upon exit, destLen

is the actual size of the uncompressed buffer.

is the actual size of the uncompressed data.

uncompress returns Z_OK if success, Z_MEM_ERROR if there was not

enough memory, Z_BUF_ERROR if there was not enough room in the output

Line 1212 ZEXTERN int ZEXPORT uncompress OF((Bytef

Line 1280 ZEXTERN int ZEXPORT uncompress OF((Bytef

buffer with the uncompressed data up to that point.

ZEXTERN int ZEXPORT uncompress2 OF((Bytef *dest, uLongf *destLen,

const Bytef *source, uLong *sourceLen));

Same as uncompress, except that sourceLen is a pointer, where the

length of the source is *sourceLen. On return, *sourceLen is the number of

source bytes consumed.

/* gzip file access functions */

Line 1290 ZEXTERN int ZEXPORT gzbuffer OF((gzFile

Line 1366 ZEXTERN int ZEXPORT gzbuffer OF((gzFile

default buffer size is 8192 bytes. This function must be called after

gzopen() or gzdopen(), and before any other calls that read or write the

file. The buffer memory allocation is always deferred to the first read or

write. Two buffers are allocated, either both of the specified size when

write. Three times that size in buffer space is allocated. A larger buffer

writing, or one of the specified size and the other twice that size when

size of, for example, 64K or 128K bytes will noticeably increase the speed

reading. A larger buffer size of, for example, 64K or 128K bytes will

of decompression (reading).

noticeably increase the speed of decompression (reading).

The new buffer size also affects the maximum length for gzprintf().

Line 1304 ZEXTERN int ZEXPORT gzbuffer OF((gzFile

Line 1379 ZEXTERN int ZEXPORT gzbuffer OF((gzFile

ZEXTERN int ZEXPORT gzsetparams OF((gzFile file, int level, int strategy));

Dynamically update the compression level or strategy. See the description

of deflateInit2 for the meaning of these parameters.

of deflateInit2 for the meaning of these parameters. Previously provided

data is flushed before the parameter change.

gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not

gzsetparams returns Z_OK if success, Z_STREAM_ERROR if the file was not

opened for writing.

opened for writing, Z_ERRNO if there is an error writing the flushed data,

or Z_MEM_ERROR if there is a memory allocation error.

ZEXTERN int ZEXPORT gzread OF((gzFile file, voidp buf, unsigned len));

Line 1335 ZEXTERN int ZEXPORT gzread OF((gzFile fi

Line 1412 ZEXTERN int ZEXPORT gzread OF((gzFile fi

case.

gzread returns the number of uncompressed bytes actually read, less than

len for end of file, or -1 for error.

len for end of file, or -1 for error. If len is too large to fit in an int,

then nothing is read, -1 is returned, and the error state is set to

Z_STREAM_ERROR.

ZEXTERN z_size_t ZEXPORT gzfread OF((voidp buf, z_size_t size, z_size_t nitems,

gzFile file));

Read up to nitems items of size size from file to buf, otherwise operating

as gzread() does. This duplicates the interface of stdio's fread(), with

size_t request and return types. If the library defines size_t, then

z_size_t is identical to size_t. If not, then z_size_t is an unsigned

integer type that can contain a pointer.

gzfread() returns the number of full items read of size size, or zero if

the end of the file was reached and a full item could not be read, or if

there was an error. gzerror() must be consulted if zero is returned in

order to determine if there was an error. If the multiplication of size and

nitems overflows, i.e. the product does not fit in a z_size_t, then nothing

is read, zero is returned, and the error state is set to Z_STREAM_ERROR.

In the event that the end of file is reached and only a partial item is

available at the end, i.e. the remaining uncompressed data length is not a

multiple of size, then the final partial item is nevetheless read into buf

and the end-of-file flag is set. The length of the partial item read is not

provided, but could be inferred from the result of gztell(). This behavior

is the same as the behavior of fread() implementations in common libraries,

but it prevents the direct use of gzfread() to read a concurrently written

file, reseting and retrying on end-of-file, when size is not 1.

ZEXTERN int ZEXPORT gzwrite OF((gzFile file,

Line 1346 ZEXTERN int ZEXPORT gzwrite OF((gzFile f

Line 1451 ZEXTERN int ZEXPORT gzwrite OF((gzFile f

error.

ZEXTERN z_size_t ZEXPORT gzfwrite OF((voidpc buf, z_size_t size,

z_size_t nitems, gzFile file));

gzfwrite() writes nitems items of size size from buf to file, duplicating

the interface of stdio's fwrite(), with size_t request and return types. If

the library defines size_t, then z_size_t is identical to size_t. If not,

then z_size_t is an unsigned integer type that can contain a pointer.

gzfwrite() returns the number of full items written of size size, or zero

if there was an error. If the multiplication of size and nitems overflows,

i.e. the product does not fit in a z_size_t, then nothing is written, zero

is returned, and the error state is set to Z_STREAM_ERROR.

ZEXTERN int ZEXPORTVA gzprintf Z_ARG((gzFile file, const char *format, ...));

Converts, formats, and writes the arguments to the compressed file under

control of the format string, as in fprintf. gzprintf returns the number of

uncompressed bytes actually written, or 0 in case of error. The number of

uncompressed bytes actually written, or a negative zlib error code in case

uncompressed bytes written is limited to 8191, or one less than the buffer

of error. The number of uncompressed bytes written is limited to 8191, or

size given to gzbuffer(). The caller should assure that this limit is not

one less than the buffer size given to gzbuffer(). The caller should assure

exceeded. If it is exceeded, then gzprintf() will return an error (0) with

that this limit is not exceeded. If it is exceeded, then gzprintf() will

nothing written. In this case, there may also be a buffer overflow with

return an error (0) with nothing written. In this case, there may also be a

unpredictable consequences, which is possible only if zlib was compiled with

buffer overflow with unpredictable consequences, which is possible only if

the insecure functions sprintf() or vsprintf() because the secure snprintf()

zlib was compiled with the insecure functions sprintf() or vsprintf()

or vsnprintf() functions were not available. This can be determined using

because the secure snprintf() or vsnprintf() functions were not available.

zlibCompileFlags().

This can be determined using zlibCompileFlags().

ZEXTERN int ZEXPORT gzputs OF((gzFile file, const char *s));

Line 1418 ZEXTERN int ZEXPORT gzflush OF((gzFile f

Line 1537 ZEXTERN int ZEXPORT gzflush OF((gzFile f

If the flush parameter is Z_FINISH, the remaining data is written and the

gzip stream is completed in the output. If gzwrite() is called again, a new

gzip stream will be started in the output. gzread() is able to read such

concatented gzip streams.

concatenated gzip streams.

gzflush should be called only when strictly necessary because it will

degrade compression if called too often.

Line 1572 ZEXTERN uLong ZEXPORT adler32 OF((uLong

Line 1691 ZEXTERN uLong ZEXPORT adler32 OF((uLong

return the updated checksum. If buf is Z_NULL, this function returns the

required initial value for the checksum.

An Adler-32 checksum is almost as reliable as a CRC32 but can be computed

An Adler-32 checksum is almost as reliable as a CRC-32 but can be computed

much faster.

Usage example:

Line 1585 ZEXTERN uLong ZEXPORT adler32 OF((uLong

Line 1704 ZEXTERN uLong ZEXPORT adler32 OF((uLong

if (adler != original_adler) error();

ZEXTERN uLong ZEXPORT adler32_z OF((uLong adler, const Bytef *buf,

z_size_t len));

Same as adler32(), but with a size_t length.

ZEXTERN uLong ZEXPORT adler32_combine OF((uLong adler1, uLong adler2,

z_off_t len2));

Line 1614 ZEXTERN uLong ZEXPORT crc32 OF((uLong

Line 1739 ZEXTERN uLong ZEXPORT crc32 OF((uLong

if (crc != original_crc) error();

ZEXTERN uLong ZEXPORT crc32_z OF((uLong adler, const Bytef *buf,

z_size_t len));

Same as crc32(), but with a size_t length.

ZEXTERN uLong ZEXPORT crc32_combine OF((uLong crc1, uLong crc2, z_off_t len2));

Line 1644 ZEXTERN int ZEXPORT inflateBackInit_ OF(

Line 1775 ZEXTERN int ZEXPORT inflateBackInit_ OF(

unsigned char FAR *window,

const char *version,

int stream_size));

#define deflateInit(strm, level) \

#ifdef Z_PREFIX_SET

deflateInit_((strm), (level), ZLIB_VERSION, (int)sizeof(z_stream))

# define z_deflateInit(strm, level) \

#define inflateInit(strm) \

deflateInit_((strm), (level), ZLIB_VERSION, (int)sizeof(z_stream))

inflateInit_((strm), ZLIB_VERSION, (int)sizeof(z_stream))

# define z_inflateInit(strm) \

#define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \

inflateInit_((strm), ZLIB_VERSION, (int)sizeof(z_stream))

deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\

# define z_deflateInit2(strm, level, method, windowBits, memLevel, strategy) \

(strategy), ZLIB_VERSION, (int)sizeof(z_stream))

deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\

#define inflateInit2(strm, windowBits) \

(strategy), ZLIB_VERSION, (int)sizeof(z_stream))

inflateInit2_((strm), (windowBits), ZLIB_VERSION, \

# define z_inflateInit2(strm, windowBits) \

(int)sizeof(z_stream))

inflateInit2_((strm), (windowBits), ZLIB_VERSION, \

#define inflateBackInit(strm, windowBits, window) \

(int)sizeof(z_stream))

inflateBackInit_((strm), (windowBits), (window), \

# define z_inflateBackInit(strm, windowBits, window) \

ZLIB_VERSION, (int)sizeof(z_stream))

inflateBackInit_((strm), (windowBits), (window), \

ZLIB_VERSION, (int)sizeof(z_stream))

#else

# define deflateInit(strm, level) \

deflateInit_((strm), (level), ZLIB_VERSION, (int)sizeof(z_stream))

# define inflateInit(strm) \

inflateInit_((strm), ZLIB_VERSION, (int)sizeof(z_stream))

# define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \

deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\

(strategy), ZLIB_VERSION, (int)sizeof(z_stream))

# define inflateInit2(strm, windowBits) \

inflateInit2_((strm), (windowBits), ZLIB_VERSION, \

(int)sizeof(z_stream))

# define inflateBackInit(strm, windowBits, window) \

inflateBackInit_((strm), (windowBits), (window), \

ZLIB_VERSION, (int)sizeof(z_stream))

#endif

#ifndef Z_SOLO

Line 1676 ZEXTERN int ZEXPORT gzgetc_ OF((gzFile f

Line 1823 ZEXTERN int ZEXPORT gzgetc_ OF((gzFile f

#ifdef Z_PREFIX_SET

# undef z_gzgetc

# define z_gzgetc(g) \

((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g))

((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : (gzgetc)(g))

#else

# define gzgetc(g) \

((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g))

((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : (gzgetc)(g))

#endif

/* provide 64-bit offset functions if _LARGEFILE64_SOURCE defined, and/or

Line 1737 ZEXTERN int ZEXPORT gzgetc_ OF((gzFile f

Line 1884 ZEXTERN int ZEXPORT gzgetc_ OF((gzFile f

#endif /* !Z_SOLO */

/* hack for buggy compilers */

#if !defined(ZUTIL_H) && !defined(NO_DUMMY_DECL)

struct internal_state {int dummy;};

#endif

/* undocumented functions */

ZEXTERN const char * ZEXPORT zError OF((int));

ZEXTERN int ZEXPORT inflateSyncPoint OF((z_streamp));

ZEXTERN const z_crc_t FAR * ZEXPORT get_crc_table OF((void));

ZEXTERN int ZEXPORT inflateUndermine OF((z_streamp, int));

ZEXTERN int ZEXPORT inflateValidate OF((z_streamp, int));

ZEXTERN unsigned long ZEXPORT inflateCodesUsed OF ((z_streamp));

ZEXTERN int ZEXPORT inflateResetKeep OF((z_streamp));

ZEXTERN int ZEXPORT deflateResetKeep OF((z_streamp));

#if defined(_WIN32) && !defined(Z_SOLO)

CVSweb <webmaster@jp.NetBSD.org>