Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(46)

Side by Side Diff: third_party/zlib/zlib.h

Issue 2690623003: Update zlib to 1.2.11 (Closed)
Patch Set: Drop the inflater change, improve the deflater comment Created 3 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « third_party/zlib/zconf.h ('k') | third_party/zlib/zutil.h » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 /* zlib.h -- interface of the 'zlib' general purpose compression library 1 /* zlib.h -- interface of the 'zlib' general purpose compression library
2 version 1.2.8, April 28th, 2013 2 version 1.2.11, January 15th, 2017
3 3
4 Copyright (C) 1995-2013 Jean-loup Gailly and Mark Adler 4 Copyright (C) 1995-2017 Jean-loup Gailly and Mark Adler
5 5
6 This software is provided 'as-is', without any express or implied 6 This software is provided 'as-is', without any express or implied
7 warranty. In no event will the authors be held liable for any damages 7 warranty. In no event will the authors be held liable for any damages
8 arising from the use of this software. 8 arising from the use of this software.
9 9
10 Permission is granted to anyone to use this software for any purpose, 10 Permission is granted to anyone to use this software for any purpose,
11 including commercial applications, and to alter it and redistribute it 11 including commercial applications, and to alter it and redistribute it
12 freely, subject to the following restrictions: 12 freely, subject to the following restrictions:
13 13
14 1. The origin of this software must not be misrepresented; you must not 14 1. The origin of this software must not be misrepresented; you must not
(...skipping 15 matching lines...) Expand all
30 30
31 #ifndef ZLIB_H 31 #ifndef ZLIB_H
32 #define ZLIB_H 32 #define ZLIB_H
33 33
34 #include "zconf.h" 34 #include "zconf.h"
35 35
36 #ifdef __cplusplus 36 #ifdef __cplusplus
37 extern "C" { 37 extern "C" {
38 #endif 38 #endif
39 39
40 #define ZLIB_VERSION "1.2.8" 40 #define ZLIB_VERSION "1.2.11"
41 #define ZLIB_VERNUM 0x1280 41 #define ZLIB_VERNUM 0x12b0
42 #define ZLIB_VER_MAJOR 1 42 #define ZLIB_VER_MAJOR 1
43 #define ZLIB_VER_MINOR 2 43 #define ZLIB_VER_MINOR 2
44 #define ZLIB_VER_REVISION 8 44 #define ZLIB_VER_REVISION 11
45 #define ZLIB_VER_SUBREVISION 0 45 #define ZLIB_VER_SUBREVISION 0
46 46
47 /* 47 /*
48 The 'zlib' compression library provides in-memory compression and 48 The 'zlib' compression library provides in-memory compression and
49 decompression functions, including integrity checks of the uncompressed data. 49 decompression functions, including integrity checks of the uncompressed data.
50 This version of the library supports only one compression method (deflation) 50 This version of the library supports only one compression method (deflation)
51 but other algorithms will be added later and will have the same stream 51 but other algorithms will be added later and will have the same stream
52 interface. 52 interface.
53 53
54 Compression can be done in a single step if the buffers are large enough, 54 Compression can be done in a single step if the buffers are large enough,
55 or can be done by repeated calls of the compression function. In the latter 55 or can be done by repeated calls of the compression function. In the latter
56 case, the application must provide more input and/or consume the output 56 case, the application must provide more input and/or consume the output
57 (providing more output space) before each call. 57 (providing more output space) before each call.
58 58
59 The compressed data format used by default by the in-memory functions is 59 The compressed data format used by default by the in-memory functions is
60 the zlib format, which is a zlib wrapper documented in RFC 1950, wrapped 60 the zlib format, which is a zlib wrapper documented in RFC 1950, wrapped
61 around a deflate stream, which is itself documented in RFC 1951. 61 around a deflate stream, which is itself documented in RFC 1951.
62 62
63 The library also supports reading and writing files in gzip (.gz) format 63 The library also supports reading and writing files in gzip (.gz) format
64 with an interface similar to that of stdio using the functions that start 64 with an interface similar to that of stdio using the functions that start
65 with "gz". The gzip format is different from the zlib format. gzip is a 65 with "gz". The gzip format is different from the zlib format. gzip is a
66 gzip wrapper, documented in RFC 1952, wrapped around a deflate stream. 66 gzip wrapper, documented in RFC 1952, wrapped around a deflate stream.
67 67
68 This library can optionally read and write gzip streams in memory as well. 68 This library can optionally read and write gzip and raw deflate streams in
69 memory as well.
69 70
70 The zlib format was designed to be compact and fast for use in memory 71 The zlib format was designed to be compact and fast for use in memory
71 and on communications channels. The gzip format was designed for single- 72 and on communications channels. The gzip format was designed for single-
72 file compression on file systems, has a larger header than zlib to maintain 73 file compression on file systems, has a larger header than zlib to maintain
73 directory information, and uses a different, slower check method than zlib. 74 directory information, and uses a different, slower check method than zlib.
74 75
75 The library does not install any signal handler. The decoder checks 76 The library does not install any signal handler. The decoder checks
76 the consistency of the compressed data, so the library should never crash 77 the consistency of the compressed data, so the library should never crash
77 even in case of corrupted input. 78 even in the case of corrupted input.
78 */ 79 */
79 80
80 typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size)); 81 typedef voidpf (*alloc_func) OF((voidpf opaque, uInt items, uInt size));
81 typedef void (*free_func) OF((voidpf opaque, voidpf address)); 82 typedef void (*free_func) OF((voidpf opaque, voidpf address));
82 83
83 struct internal_state; 84 struct internal_state;
84 85
85 typedef struct z_stream_s { 86 typedef struct z_stream_s {
86 z_const Bytef *next_in; /* next input byte */ 87 z_const Bytef *next_in; /* next input byte */
87 uInt avail_in; /* number of bytes available at next_in */ 88 uInt avail_in; /* number of bytes available at next_in */
88 uLong total_in; /* total number of input bytes read so far */ 89 uLong total_in; /* total number of input bytes read so far */
89 90
90 Bytef *next_out; /* next output byte should be put there */ 91 Bytef *next_out; /* next output byte will go here */
91 uInt avail_out; /* remaining free space at next_out */ 92 uInt avail_out; /* remaining free space at next_out */
92 uLong total_out; /* total number of bytes output so far */ 93 uLong total_out; /* total number of bytes output so far */
93 94
94 z_const char *msg; /* last error message, NULL if no error */ 95 z_const char *msg; /* last error message, NULL if no error */
95 struct internal_state FAR *state; /* not visible by applications */ 96 struct internal_state FAR *state; /* not visible by applications */
96 97
97 alloc_func zalloc; /* used to allocate the internal state */ 98 alloc_func zalloc; /* used to allocate the internal state */
98 free_func zfree; /* used to free the internal state */ 99 free_func zfree; /* used to free the internal state */
99 voidpf opaque; /* private data object passed to zalloc and zfree */ 100 voidpf opaque; /* private data object passed to zalloc and zfree */
100 101
101 int data_type; /* best guess about the data type: binary or text */ 102 int data_type; /* best guess about the data type: binary or text
102 uLong adler; /* adler32 value of the uncompressed data */ 103 for deflate, or the decoding state for inflate */
104 uLong adler; /* Adler-32 or CRC-32 value of the uncompressed data */
103 uLong reserved; /* reserved for future use */ 105 uLong reserved; /* reserved for future use */
104 } z_stream; 106 } z_stream;
105 107
106 typedef z_stream FAR *z_streamp; 108 typedef z_stream FAR *z_streamp;
107 109
108 /* 110 /*
109 gzip header information passed to and from zlib routines. See RFC 1952 111 gzip header information passed to and from zlib routines. See RFC 1952
110 for more details on the meanings of these fields. 112 for more details on the meanings of these fields.
111 */ 113 */
112 typedef struct gz_header_s { 114 typedef struct gz_header_s {
(...skipping 22 matching lines...) Expand all
135 calling the init function. All other fields are set by the compression 137 calling the init function. All other fields are set by the compression
136 library and must not be updated by the application. 138 library and must not be updated by the application.
137 139
138 The opaque value provided by the application will be passed as the first 140 The opaque value provided by the application will be passed as the first
139 parameter for calls of zalloc and zfree. This can be useful for custom 141 parameter for calls of zalloc and zfree. This can be useful for custom
140 memory management. The compression library attaches no meaning to the 142 memory management. The compression library attaches no meaning to the
141 opaque value. 143 opaque value.
142 144
143 zalloc must return Z_NULL if there is not enough memory for the object. 145 zalloc must return Z_NULL if there is not enough memory for the object.
144 If zlib is used in a multi-threaded application, zalloc and zfree must be 146 If zlib is used in a multi-threaded application, zalloc and zfree must be
145 thread safe. 147 thread safe. In that case, zlib is thread-safe. When zalloc and zfree are
148 Z_NULL on entry to the initialization function, they are set to internal
149 routines that use the standard library functions malloc() and free().
146 150
147 On 16-bit systems, the functions zalloc and zfree must be able to allocate 151 On 16-bit systems, the functions zalloc and zfree must be able to allocate
148 exactly 65536 bytes, but will not be required to allocate more than this if 152 exactly 65536 bytes, but will not be required to allocate more than this if
149 the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS, pointers 153 the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS, pointers
150 returned by zalloc for objects of exactly 65536 bytes *must* have their 154 returned by zalloc for objects of exactly 65536 bytes *must* have their
151 offset normalized to zero. The default allocation function provided by this 155 offset normalized to zero. The default allocation function provided by this
152 library ensures this (see zutil.c). To reduce memory requirements and avoid 156 library ensures this (see zutil.c). To reduce memory requirements and avoid
153 any allocation of 64K objects, at the expense of compression ratio, compile 157 any allocation of 64K objects, at the expense of compression ratio, compile
154 the library with -DMAX_WBITS=14 (see zconf.h). 158 the library with -DMAX_WBITS=14 (see zconf.h).
155 159
156 The fields total_in and total_out can be used for statistics or progress 160 The fields total_in and total_out can be used for statistics or progress
157 reports. After compression, total_in holds the total size of the 161 reports. After compression, total_in holds the total size of the
158 uncompressed data and may be saved for use in the decompressor (particularly 162 uncompressed data and may be saved for use by the decompressor (particularly
159 if the decompressor wants to decompress everything in a single step). 163 if the decompressor wants to decompress everything in a single step).
160 */ 164 */
161 165
162 /* constants */ 166 /* constants */
163 167
164 #define Z_NO_FLUSH 0 168 #define Z_NO_FLUSH 0
165 #define Z_PARTIAL_FLUSH 1 169 #define Z_PARTIAL_FLUSH 1
166 #define Z_SYNC_FLUSH 2 170 #define Z_SYNC_FLUSH 2
167 #define Z_FULL_FLUSH 3 171 #define Z_FULL_FLUSH 3
168 #define Z_FINISH 4 172 #define Z_FINISH 4
(...skipping 24 matching lines...) Expand all
193 #define Z_HUFFMAN_ONLY 2 197 #define Z_HUFFMAN_ONLY 2
194 #define Z_RLE 3 198 #define Z_RLE 3
195 #define Z_FIXED 4 199 #define Z_FIXED 4
196 #define Z_DEFAULT_STRATEGY 0 200 #define Z_DEFAULT_STRATEGY 0
197 /* compression strategy; see deflateInit2() below for details */ 201 /* compression strategy; see deflateInit2() below for details */
198 202
199 #define Z_BINARY 0 203 #define Z_BINARY 0
200 #define Z_TEXT 1 204 #define Z_TEXT 1
201 #define Z_ASCII Z_TEXT /* for compatibility with 1.2.2 and earlier */ 205 #define Z_ASCII Z_TEXT /* for compatibility with 1.2.2 and earlier */
202 #define Z_UNKNOWN 2 206 #define Z_UNKNOWN 2
203 /* Possible values of the data_type field (though see inflate()) */ 207 /* Possible values of the data_type field for deflate() */
204 208
205 #define Z_DEFLATED 8 209 #define Z_DEFLATED 8
206 /* The deflate compression method (the only one supported in this version) */ 210 /* The deflate compression method (the only one supported in this version) */
207 211
208 #define Z_NULL 0 /* for initializing zalloc, zfree, opaque */ 212 #define Z_NULL 0 /* for initializing zalloc, zfree, opaque */
209 213
210 #define zlib_version zlibVersion() 214 #define zlib_version zlibVersion()
211 /* for compatibility with versions < 1.0.2 */ 215 /* for compatibility with versions < 1.0.2 */
212 216
213 217
(...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after
251 forced to flush. 255 forced to flush.
252 256
253 The detailed semantics are as follows. deflate performs one or both of the 257 The detailed semantics are as follows. deflate performs one or both of the
254 following actions: 258 following actions:
255 259
256 - Compress more input starting at next_in and update next_in and avail_in 260 - Compress more input starting at next_in and update next_in and avail_in
257 accordingly. If not all input can be processed (because there is not 261 accordingly. If not all input can be processed (because there is not
258 enough room in the output buffer), next_in and avail_in are updated and 262 enough room in the output buffer), next_in and avail_in are updated and
259 processing will resume at this point for the next call of deflate(). 263 processing will resume at this point for the next call of deflate().
260 264
261 - Provide more output starting at next_out and update next_out and avail_out 265 - Generate more output starting at next_out and update next_out and avail_out
262 accordingly. This action is forced if the parameter flush is non zero. 266 accordingly. This action is forced if the parameter flush is non zero.
263 Forcing flush frequently degrades the compression ratio, so this parameter 267 Forcing flush frequently degrades the compression ratio, so this parameter
264 should be set only when necessary (in interactive applications). Some 268 should be set only when necessary. Some output may be provided even if
265 output may be provided even if flush is not set. 269 flush is zero.
266 270
267 Before the call of deflate(), the application should ensure that at least 271 Before the call of deflate(), the application should ensure that at least
268 one of the actions is possible, by providing more input and/or consuming more 272 one of the actions is possible, by providing more input and/or consuming more
269 output, and updating avail_in or avail_out accordingly; avail_out should 273 output, and updating avail_in or avail_out accordingly; avail_out should
270 never be zero before the call. The application can consume the compressed 274 never be zero before the call. The application can consume the compressed
271 output when it wants, for example when the output buffer is full (avail_out 275 output when it wants, for example when the output buffer is full (avail_out
272 == 0), or after each call of deflate(). If deflate returns Z_OK and with 276 == 0), or after each call of deflate(). If deflate returns Z_OK and with
273 zero avail_out, it must be called again after making room in the output 277 zero avail_out, it must be called again after making room in the output
274 buffer because there might be more output pending. 278 buffer because there might be more output pending. See deflatePending(),
279 which can be used if desired to determine whether or not there is more ouput
280 in that case.
275 281
276 Normally the parameter flush is set to Z_NO_FLUSH, which allows deflate to 282 Normally the parameter flush is set to Z_NO_FLUSH, which allows deflate to
277 decide how much data to accumulate before producing output, in order to 283 decide how much data to accumulate before producing output, in order to
278 maximize compression. 284 maximize compression.
279 285
280 If the parameter flush is set to Z_SYNC_FLUSH, all pending output is 286 If the parameter flush is set to Z_SYNC_FLUSH, all pending output is
281 flushed to the output buffer and the output is aligned on a byte boundary, so 287 flushed to the output buffer and the output is aligned on a byte boundary, so
282 that the decompressor can get all input data available so far. (In 288 that the decompressor can get all input data available so far. (In
283 particular avail_in is zero after the call if enough output space has been 289 particular avail_in is zero after the call if enough output space has been
284 provided before the call.) Flushing may degrade compression for some 290 provided before the call.) Flushing may degrade compression for some
285 compression algorithms and so it should be used only when necessary. This 291 compression algorithms and so it should be used only when necessary. This
286 completes the current deflate block and follows it with an empty stored block 292 completes the current deflate block and follows it with an empty stored block
287 that is three bits plus filler bits to the next byte, followed by four bytes 293 that is three bits plus filler bits to the next byte, followed by four bytes
288 (00 00 ff ff). 294 (00 00 ff ff).
289 295
290 If flush is set to Z_PARTIAL_FLUSH, all pending output is flushed to the 296 If flush is set to Z_PARTIAL_FLUSH, all pending output is flushed to the
291 output buffer, but the output is not aligned to a byte boundary. All of the 297 output buffer, but the output is not aligned to a byte boundary. All of the
292 input data so far will be available to the decompressor, as for Z_SYNC_FLUSH. 298 input data so far will be available to the decompressor, as for Z_SYNC_FLUSH.
293 This completes the current deflate block and follows it with an empty fixed 299 This completes the current deflate block and follows it with an empty fixed
294 codes block that is 10 bits long. This assures that enough bytes are output 300 codes block that is 10 bits long. This assures that enough bytes are output
295 in order for the decompressor to finish the block before the empty fixed code 301 in order for the decompressor to finish the block before the empty fixed
296 block. 302 codes block.
297 303
298 If flush is set to Z_BLOCK, a deflate block is completed and emitted, as 304 If flush is set to Z_BLOCK, a deflate block is completed and emitted, as
299 for Z_SYNC_FLUSH, but the output is not aligned on a byte boundary, and up to 305 for Z_SYNC_FLUSH, but the output is not aligned on a byte boundary, and up to
300 seven bits of the current block are held to be written as the next byte after 306 seven bits of the current block are held to be written as the next byte after
301 the next deflate block is completed. In this case, the decompressor may not 307 the next deflate block is completed. In this case, the decompressor may not
302 be provided enough bits at this point in order to complete decompression of 308 be provided enough bits at this point in order to complete decompression of
303 the data provided so far to the compressor. It may need to wait for the next 309 the data provided so far to the compressor. It may need to wait for the next
304 block to be emitted. This is for advanced applications that need to control 310 block to be emitted. This is for advanced applications that need to control
305 the emission of deflate blocks. 311 the emission of deflate blocks.
306 312
307 If flush is set to Z_FULL_FLUSH, all output is flushed as with 313 If flush is set to Z_FULL_FLUSH, all output is flushed as with
308 Z_SYNC_FLUSH, and the compression state is reset so that decompression can 314 Z_SYNC_FLUSH, and the compression state is reset so that decompression can
309 restart from this point if previous compressed data has been damaged or if 315 restart from this point if previous compressed data has been damaged or if
310 random access is desired. Using Z_FULL_FLUSH too often can seriously degrade 316 random access is desired. Using Z_FULL_FLUSH too often can seriously degrade
311 compression. 317 compression.
312 318
313 If deflate returns with avail_out == 0, this function must be called again 319 If deflate returns with avail_out == 0, this function must be called again
314 with the same value of the flush parameter and more output space (updated 320 with the same value of the flush parameter and more output space (updated
315 avail_out), until the flush is complete (deflate returns with non-zero 321 avail_out), until the flush is complete (deflate returns with non-zero
316 avail_out). In the case of a Z_FULL_FLUSH or Z_SYNC_FLUSH, make sure that 322 avail_out). In the case of a Z_FULL_FLUSH or Z_SYNC_FLUSH, make sure that
317 avail_out is greater than six to avoid repeated flush markers due to 323 avail_out is greater than six to avoid repeated flush markers due to
318 avail_out == 0 on return. 324 avail_out == 0 on return.
319 325
320 If the parameter flush is set to Z_FINISH, pending input is processed, 326 If the parameter flush is set to Z_FINISH, pending input is processed,
321 pending output is flushed and deflate returns with Z_STREAM_END if there was 327 pending output is flushed and deflate returns with Z_STREAM_END if there was
322 enough output space; if deflate returns with Z_OK, this function must be 328 enough output space. If deflate returns with Z_OK or Z_BUF_ERROR, this
323 called again with Z_FINISH and more output space (updated avail_out) but no 329 function must be called again with Z_FINISH and more output space (updated
324 more input data, until it returns with Z_STREAM_END or an error. After 330 avail_out) but no more input data, until it returns with Z_STREAM_END or an
325 deflate has returned Z_STREAM_END, the only possible operations on the stream 331 error. After deflate has returned Z_STREAM_END, the only possible operations
326 are deflateReset or deflateEnd. 332 on the stream are deflateReset or deflateEnd.
327 333
328 Z_FINISH can be used immediately after deflateInit if all the compression 334 Z_FINISH can be used in the first deflate call after deflateInit if all the
329 is to be done in a single step. In this case, avail_out must be at least the 335 compression is to be done in a single step. In order to complete in one
330 value returned by deflateBound (see below). Then deflate is guaranteed to 336 call, avail_out must be at least the value returned by deflateBound (see
331 return Z_STREAM_END. If not enough output space is provided, deflate will 337 below). Then deflate is guaranteed to return Z_STREAM_END. If not enough
332 not return Z_STREAM_END, and it must be called again as described above. 338 output space is provided, deflate will not return Z_STREAM_END, and it must
339 be called again as described above.
333 340
334 deflate() sets strm->adler to the adler32 checksum of all input read 341 deflate() sets strm->adler to the Adler-32 checksum of all input read
335 so far (that is, total_in bytes). 342 so far (that is, total_in bytes). If a gzip stream is being generated, then
343 strm->adler will be the CRC-32 checksum of the input read so far. (See
344 deflateInit2 below.)
336 345
337 deflate() may update strm->data_type if it can make a good guess about 346 deflate() may update strm->data_type if it can make a good guess about
338 the input data type (Z_BINARY or Z_TEXT). In doubt, the data is considered 347 the input data type (Z_BINARY or Z_TEXT). If in doubt, the data is
339 binary. This field is only for information purposes and does not affect the 348 considered binary. This field is only for information purposes and does not
340 compression algorithm in any manner. 349 affect the compression algorithm in any manner.
341 350
342 deflate() returns Z_OK if some progress has been made (more input 351 deflate() returns Z_OK if some progress has been made (more input
343 processed or more output produced), Z_STREAM_END if all input has been 352 processed or more output produced), Z_STREAM_END if all input has been
344 consumed and all output has been produced (only when flush is set to 353 consumed and all output has been produced (only when flush is set to
345 Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example 354 Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example
346 if next_in or next_out was Z_NULL), Z_BUF_ERROR if no progress is possible 355 if next_in or next_out was Z_NULL or the state was inadvertently written over
347 (for example avail_in or avail_out was zero). Note that Z_BUF_ERROR is not 356 by the application), or Z_BUF_ERROR if no progress is possible (for example
348 fatal, and deflate() can be called again with more input and more output 357 avail_in or avail_out was zero). Note that Z_BUF_ERROR is not fatal, and
349 space to continue compressing. 358 deflate() can be called again with more input and more output space to
359 continue compressing.
350 */ 360 */
351 361
352 362
353 ZEXTERN int ZEXPORT deflateEnd OF((z_streamp strm)); 363 ZEXTERN int ZEXPORT deflateEnd OF((z_streamp strm));
354 /* 364 /*
355 All dynamically allocated data structures for this stream are freed. 365 All dynamically allocated data structures for this stream are freed.
356 This function discards any unprocessed input and does not flush any pending 366 This function discards any unprocessed input and does not flush any pending
357 output. 367 output.
358 368
359 deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the 369 deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the
360 stream state was inconsistent, Z_DATA_ERROR if the stream was freed 370 stream state was inconsistent, Z_DATA_ERROR if the stream was freed
361 prematurely (some input or output was discarded). In the error case, msg 371 prematurely (some input or output was discarded). In the error case, msg
362 may be set but then points to a static string (which must not be 372 may be set but then points to a static string (which must not be
363 deallocated). 373 deallocated).
364 */ 374 */
365 375
366 376
367 /* 377 /*
368 ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm)); 378 ZEXTERN int ZEXPORT inflateInit OF((z_streamp strm));
369 379
370 Initializes the internal stream state for decompression. The fields 380 Initializes the internal stream state for decompression. The fields
371 next_in, avail_in, zalloc, zfree and opaque must be initialized before by 381 next_in, avail_in, zalloc, zfree and opaque must be initialized before by
372 the caller. If next_in is not Z_NULL and avail_in is large enough (the 382 the caller. In the current version of inflate, the provided input is not
373 exact value depends on the compression method), inflateInit determines the 383 read or consumed. The allocation of a sliding window will be deferred to
374 compression method from the zlib header and allocates all data structures 384 the first call of inflate (if the decompression does not complete on the
375 accordingly; otherwise the allocation will be deferred to the first call of 385 first call). If zalloc and zfree are set to Z_NULL, inflateInit updates
376 inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them to 386 them to use default allocation functions.
377 use default allocation functions.
378 387
379 inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough 388 inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough
380 memory, Z_VERSION_ERROR if the zlib library version is incompatible with the 389 memory, Z_VERSION_ERROR if the zlib library version is incompatible with the
381 version assumed by the caller, or Z_STREAM_ERROR if the parameters are 390 version assumed by the caller, or Z_STREAM_ERROR if the parameters are
382 invalid, such as a null pointer to the structure. msg is set to null if 391 invalid, such as a null pointer to the structure. msg is set to null if
383 there is no error message. inflateInit does not perform any decompression 392 there is no error message. inflateInit does not perform any decompression.
384 apart from possibly reading the zlib header if present: actual decompression 393 Actual decompression will be done by inflate(). So next_in, and avail_in,
385 will be done by inflate(). (So next_in and avail_in may be modified, but 394 next_out, and avail_out are unused and unchanged. The current
386 next_out and avail_out are unused and unchanged.) The current implementation 395 implementation of inflateInit() does not process any header information --
387 of inflateInit() does not process any header information -- that is deferred 396 that is deferred until inflate() is called.
388 until inflate() is called.
389 */ 397 */
390 398
391 399
392 ZEXTERN int ZEXPORT inflate OF((z_streamp strm, int flush)); 400 ZEXTERN int ZEXPORT inflate OF((z_streamp strm, int flush));
393 /* 401 /*
394 inflate decompresses as much data as possible, and stops when the input 402 inflate decompresses as much data as possible, and stops when the input
395 buffer becomes empty or the output buffer becomes full. It may introduce 403 buffer becomes empty or the output buffer becomes full. It may introduce
396 some output latency (reading input without producing any output) except when 404 some output latency (reading input without producing any output) except when
397 forced to flush. 405 forced to flush.
398 406
399 The detailed semantics are as follows. inflate performs one or both of the 407 The detailed semantics are as follows. inflate performs one or both of the
400 following actions: 408 following actions:
401 409
402 - Decompress more input starting at next_in and update next_in and avail_in 410 - Decompress more input starting at next_in and update next_in and avail_in
403 accordingly. If not all input can be processed (because there is not 411 accordingly. If not all input can be processed (because there is not
404 enough room in the output buffer), next_in is updated and processing will 412 enough room in the output buffer), then next_in and avail_in are updated
405 resume at this point for the next call of inflate(). 413 accordingly, and processing will resume at this point for the next call of
414 inflate().
406 415
407 - Provide more output starting at next_out and update next_out and avail_out 416 - Generate more output starting at next_out and update next_out and avail_out
408 accordingly. inflate() provides as much output as possible, until there is 417 accordingly. inflate() provides as much output as possible, until there is
409 no more input data or no more space in the output buffer (see below about 418 no more input data or no more space in the output buffer (see below about
410 the flush parameter). 419 the flush parameter).
411 420
412 Before the call of inflate(), the application should ensure that at least 421 Before the call of inflate(), the application should ensure that at least
413 one of the actions is possible, by providing more input and/or consuming more 422 one of the actions is possible, by providing more input and/or consuming more
414 output, and updating the next_* and avail_* values accordingly. The 423 output, and updating the next_* and avail_* values accordingly. If the
424 caller of inflate() does not provide both available input and available
425 output space, it is possible that there will be no progress made. The
415 application can consume the uncompressed output when it wants, for example 426 application can consume the uncompressed output when it wants, for example
416 when the output buffer is full (avail_out == 0), or after each call of 427 when the output buffer is full (avail_out == 0), or after each call of
417 inflate(). If inflate returns Z_OK and with zero avail_out, it must be 428 inflate(). If inflate returns Z_OK and with zero avail_out, it must be
418 called again after making room in the output buffer because there might be 429 called again after making room in the output buffer because there might be
419 more output pending. 430 more output pending.
420 431
421 The flush parameter of inflate() can be Z_NO_FLUSH, Z_SYNC_FLUSH, Z_FINISH, 432 The flush parameter of inflate() can be Z_NO_FLUSH, Z_SYNC_FLUSH, Z_FINISH,
422 Z_BLOCK, or Z_TREES. Z_SYNC_FLUSH requests that inflate() flush as much 433 Z_BLOCK, or Z_TREES. Z_SYNC_FLUSH requests that inflate() flush as much
423 output as possible to the output buffer. Z_BLOCK requests that inflate() 434 output as possible to the output buffer. Z_BLOCK requests that inflate()
424 stop if and when it gets to the next deflate block boundary. When decoding 435 stop if and when it gets to the next deflate block boundary. When decoding
425 the zlib or gzip format, this will cause inflate() to return immediately 436 the zlib or gzip format, this will cause inflate() to return immediately
426 after the header and before the first block. When doing a raw inflate, 437 after the header and before the first block. When doing a raw inflate,
427 inflate() will go ahead and process the first block, and will return when it 438 inflate() will go ahead and process the first block, and will return when it
428 gets to the end of that block, or when it runs out of data. 439 gets to the end of that block, or when it runs out of data.
429 440
430 The Z_BLOCK option assists in appending to or combining deflate streams. 441 The Z_BLOCK option assists in appending to or combining deflate streams.
431 Also to assist in this, on return inflate() will set strm->data_type to the 442 To assist in this, on return inflate() always sets strm->data_type to the
432 number of unused bits in the last byte taken from strm->next_in, plus 64 if 443 number of unused bits in the last byte taken from strm->next_in, plus 64 if
433 inflate() is currently decoding the last block in the deflate stream, plus 444 inflate() is currently decoding the last block in the deflate stream, plus
434 128 if inflate() returned immediately after decoding an end-of-block code or 445 128 if inflate() returned immediately after decoding an end-of-block code or
435 decoding the complete header up to just before the first byte of the deflate 446 decoding the complete header up to just before the first byte of the deflate
436 stream. The end-of-block will not be indicated until all of the uncompressed 447 stream. The end-of-block will not be indicated until all of the uncompressed
437 data from that block has been written to strm->next_out. The number of 448 data from that block has been written to strm->next_out. The number of
438 unused bits may in general be greater than seven, except when bit 7 of 449 unused bits may in general be greater than seven, except when bit 7 of
439 data_type is set, in which case the number of unused bits will be less than 450 data_type is set, in which case the number of unused bits will be less than
440 eight. data_type is set as noted here every time inflate() returns for all 451 eight. data_type is set as noted here every time inflate() returns for all
441 flush options, and so can be used to determine the amount of currently 452 flush options, and so can be used to determine the amount of currently
442 consumed input in bits. 453 consumed input in bits.
443 454
444 The Z_TREES option behaves as Z_BLOCK does, but it also returns when the 455 The Z_TREES option behaves as Z_BLOCK does, but it also returns when the
445 end of each deflate block header is reached, before any actual data in that 456 end of each deflate block header is reached, before any actual data in that
446 block is decoded. This allows the caller to determine the length of the 457 block is decoded. This allows the caller to determine the length of the
447 deflate block header for later use in random access within a deflate block. 458 deflate block header for later use in random access within a deflate block.
448 256 is added to the value of strm->data_type when inflate() returns 459 256 is added to the value of strm->data_type when inflate() returns
449 immediately after reaching the end of the deflate block header. 460 immediately after reaching the end of the deflate block header.
450 461
451 inflate() should normally be called until it returns Z_STREAM_END or an 462 inflate() should normally be called until it returns Z_STREAM_END or an
452 error. However if all decompression is to be performed in a single step (a 463 error. However if all decompression is to be performed in a single step (a
453 single call of inflate), the parameter flush should be set to Z_FINISH. In 464 single call of inflate), the parameter flush should be set to Z_FINISH. In
454 this case all pending input is processed and all pending output is flushed; 465 this case all pending input is processed and all pending output is flushed;
455 avail_out must be large enough to hold all of the uncompressed data for the 466 avail_out must be large enough to hold all of the uncompressed data for the
456 operation to complete. (The size of the uncompressed data may have been 467 operation to complete. (The size of the uncompressed data may have been
457 saved by the compressor for this purpose.) The use of Z_FINISH is not 468 saved by the compressor for this purpose.) The use of Z_FINISH is not
458 required to perform an inflation in one step. However it may be used to 469 required to perform an inflation in one step. However it may be used to
459 inform inflate that a faster approach can be used for the single inflate() 470 inform inflate that a faster approach can be used for the single inflate()
460 call. Z_FINISH also informs inflate to not maintain a sliding window if the 471 call. Z_FINISH also informs inflate to not maintain a sliding window if the
461 stream completes, which reduces inflate's memory footprint. If the stream 472 stream completes, which reduces inflate's memory footprint. If the stream
462 does not complete, either because not all of the stream is provided or not 473 does not complete, either because not all of the stream is provided or not
463 enough output space is provided, then a sliding window will be allocated and 474 enough output space is provided, then a sliding window will be allocated and
464 inflate() can be called again to continue the operation as if Z_NO_FLUSH had 475 inflate() can be called again to continue the operation as if Z_NO_FLUSH had
465 been used. 476 been used.
466 477
467 In this implementation, inflate() always flushes as much output as 478 In this implementation, inflate() always flushes as much output as
468 possible to the output buffer, and always uses the faster approach on the 479 possible to the output buffer, and always uses the faster approach on the
469 first call. So the effects of the flush parameter in this implementation are 480 first call. So the effects of the flush parameter in this implementation are
470 on the return value of inflate() as noted below, when inflate() returns early 481 on the return value of inflate() as noted below, when inflate() returns early
471 when Z_BLOCK or Z_TREES is used, and when inflate() avoids the allocation of 482 when Z_BLOCK or Z_TREES is used, and when inflate() avoids the allocation of
472 memory for a sliding window when Z_FINISH is used. 483 memory for a sliding window when Z_FINISH is used.
473 484
474 If a preset dictionary is needed after this call (see inflateSetDictionary 485 If a preset dictionary is needed after this call (see inflateSetDictionary
475 below), inflate sets strm->adler to the Adler-32 checksum of the dictionary 486 below), inflate sets strm->adler to the Adler-32 checksum of the dictionary
476 chosen by the compressor and returns Z_NEED_DICT; otherwise it sets 487 chosen by the compressor and returns Z_NEED_DICT; otherwise it sets
477 strm->adler to the Adler-32 checksum of all output produced so far (that is, 488 strm->adler to the Adler-32 checksum of all output produced so far (that is,
478 total_out bytes) and returns Z_OK, Z_STREAM_END or an error code as described 489 total_out bytes) and returns Z_OK, Z_STREAM_END or an error code as described
479 below. At the end of the stream, inflate() checks that its computed adler32 490 below. At the end of the stream, inflate() checks that its computed Adler-32
480 checksum is equal to that saved by the compressor and returns Z_STREAM_END 491 checksum is equal to that saved by the compressor and returns Z_STREAM_END
481 only if the checksum is correct. 492 only if the checksum is correct.
482 493
483 inflate() can decompress and check either zlib-wrapped or gzip-wrapped 494 inflate() can decompress and check either zlib-wrapped or gzip-wrapped
484 deflate data. The header type is detected automatically, if requested when 495 deflate data. The header type is detected automatically, if requested when
485 initializing with inflateInit2(). Any information contained in the gzip 496 initializing with inflateInit2(). Any information contained in the gzip
486 header is not retained, so applications that need that information should 497 header is not retained unless inflateGetHeader() is used. When processing
487 instead use raw inflate, see inflateInit2() below, or inflateBack() and
488 perform their own processing of the gzip header and trailer. When processing
489 gzip-wrapped deflate data, strm->adler32 is set to the CRC-32 of the output 498 gzip-wrapped deflate data, strm->adler32 is set to the CRC-32 of the output
490 producted so far. The CRC-32 is checked against the gzip trailer. 499 produced so far. The CRC-32 is checked against the gzip trailer, as is the
500 uncompressed length, modulo 2^32.
491 501
492 inflate() returns Z_OK if some progress has been made (more input processed 502 inflate() returns Z_OK if some progress has been made (more input processed
493 or more output produced), Z_STREAM_END if the end of the compressed data has 503 or more output produced), Z_STREAM_END if the end of the compressed data has
494 been reached and all uncompressed output has been produced, Z_NEED_DICT if a 504 been reached and all uncompressed output has been produced, Z_NEED_DICT if a
495 preset dictionary is needed at this point, Z_DATA_ERROR if the input data was 505 preset dictionary is needed at this point, Z_DATA_ERROR if the input data was
496 corrupted (input stream not conforming to the zlib format or incorrect check 506 corrupted (input stream not conforming to the zlib format or incorrect check
497 value), Z_STREAM_ERROR if the stream structure was inconsistent (for example 507 value, in which case strm->msg points to a string with a more specific
498 next_in or next_out was Z_NULL), Z_MEM_ERROR if there was not enough memory, 508 error), Z_STREAM_ERROR if the stream structure was inconsistent (for example
499 Z_BUF_ERROR if no progress is possible or if there was not enough room in the 509 next_in or next_out was Z_NULL, or the state was inadvertently written over
500 output buffer when Z_FINISH is used. Note that Z_BUF_ERROR is not fatal, and 510 by the application), Z_MEM_ERROR if there was not enough memory, Z_BUF_ERROR
511 if no progress was possible or if there was not enough room in the output
512 buffer when Z_FINISH is used. Note that Z_BUF_ERROR is not fatal, and
501 inflate() can be called again with more input and more output space to 513 inflate() can be called again with more input and more output space to
502 continue decompressing. If Z_DATA_ERROR is returned, the application may 514 continue decompressing. If Z_DATA_ERROR is returned, the application may
503 then call inflateSync() to look for a good compression block if a partial 515 then call inflateSync() to look for a good compression block if a partial
504 recovery of the data is desired. 516 recovery of the data is to be attempted.
505 */ 517 */
506 518
507 519
508 ZEXTERN int ZEXPORT inflateEnd OF((z_streamp strm)); 520 ZEXTERN int ZEXPORT inflateEnd OF((z_streamp strm));
509 /* 521 /*
510 All dynamically allocated data structures for this stream are freed. 522 All dynamically allocated data structures for this stream are freed.
511 This function discards any unprocessed input and does not flush any pending 523 This function discards any unprocessed input and does not flush any pending
512 output. 524 output.
513 525
514 inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state 526 inflateEnd returns Z_OK if success, or Z_STREAM_ERROR if the stream state
515 was inconsistent. In the error case, msg may be set but then points to a 527 was inconsistent.
516 static string (which must not be deallocated).
517 */ 528 */
518 529
519 530
520 /* Advanced functions */ 531 /* Advanced functions */
521 532
522 /* 533 /*
523 The following functions are needed only in some special applications. 534 The following functions are needed only in some special applications.
524 */ 535 */
525 536
526 /* 537 /*
(...skipping 10 matching lines...) Expand all
537 548
538 The method parameter is the compression method. It must be Z_DEFLATED in 549 The method parameter is the compression method. It must be Z_DEFLATED in
539 this version of the library. 550 this version of the library.
540 551
541 The windowBits parameter is the base two logarithm of the window size 552 The windowBits parameter is the base two logarithm of the window size
542 (the size of the history buffer). It should be in the range 8..15 for this 553 (the size of the history buffer). It should be in the range 8..15 for this
543 version of the library. Larger values of this parameter result in better 554 version of the library. Larger values of this parameter result in better
544 compression at the expense of memory usage. The default value is 15 if 555 compression at the expense of memory usage. The default value is 15 if
545 deflateInit is used instead. 556 deflateInit is used instead.
546 557
558 For the current implementation of deflate(), a windowBits value of 8 (a
559 window size of 256 bytes) is not supported. As a result, a request for 8
560 will result in 9 (a 512-byte window). In that case, providing 8 to
561 inflateInit2() will result in an error when the zlib header with 9 is
562 checked against the initialization of inflate(). The remedy is to not use 8
563 with deflateInit2() with this initialization, or at least in that case use 9
564 with inflateInit2().
565
547 windowBits can also be -8..-15 for raw deflate. In this case, -windowBits 566 windowBits can also be -8..-15 for raw deflate. In this case, -windowBits
548 determines the window size. deflate() will then generate raw deflate data 567 determines the window size. deflate() will then generate raw deflate data
549 with no zlib header or trailer, and will not compute an adler32 check value. 568 with no zlib header or trailer, and will not compute a check value.
550 569
551 windowBits can also be greater than 15 for optional gzip encoding. Add 570 windowBits can also be greater than 15 for optional gzip encoding. Add
552 16 to windowBits to write a simple gzip header and trailer around the 571 16 to windowBits to write a simple gzip header and trailer around the
553 compressed data instead of a zlib wrapper. The gzip header will have no 572 compressed data instead of a zlib wrapper. The gzip header will have no
554 file name, no extra data, no comment, no modification time (set to zero), no 573 file name, no extra data, no comment, no modification time (set to zero), no
555 header crc, and the operating system will be set to 255 (unknown). If a 574 header crc, and the operating system will be set to the appropriate value,
556 gzip stream is being written, strm->adler is a crc32 instead of an adler32. 575 if the operating system was determined at compile time. If a gzip stream is
576 being written, strm->adler is a CRC-32 instead of an Adler-32.
577
578 For raw deflate or gzip encoding, a request for a 256-byte window is
579 rejected as invalid, since only the zlib header provides a means of
580 transmitting the window size to the decompressor.
557 581
558 The memLevel parameter specifies how much memory should be allocated 582 The memLevel parameter specifies how much memory should be allocated
559 for the internal compression state. memLevel=1 uses minimum memory but is 583 for the internal compression state. memLevel=1 uses minimum memory but is
560 slow and reduces compression ratio; memLevel=9 uses maximum memory for 584 slow and reduces compression ratio; memLevel=9 uses maximum memory for
561 optimal speed. The default value is 8. See zconf.h for total memory usage 585 optimal speed. The default value is 8. See zconf.h for total memory usage
562 as a function of windowBits and memLevel. 586 as a function of windowBits and memLevel.
563 587
564 The strategy parameter is used to tune the compression algorithm. Use the 588 The strategy parameter is used to tune the compression algorithm. Use the
565 value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a 589 value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a
566 filter (or predictor), Z_HUFFMAN_ONLY to force Huffman encoding only (no 590 filter (or predictor), Z_HUFFMAN_ONLY to force Huffman encoding only (no
(...skipping 40 matching lines...) Expand 10 before | Expand all | Expand 10 after
607 with the default empty dictionary. 631 with the default empty dictionary.
608 632
609 Depending on the size of the compression data structures selected by 633 Depending on the size of the compression data structures selected by
610 deflateInit or deflateInit2, a part of the dictionary may in effect be 634 deflateInit or deflateInit2, a part of the dictionary may in effect be
611 discarded, for example if the dictionary is larger than the window size 635 discarded, for example if the dictionary is larger than the window size
612 provided in deflateInit or deflateInit2. Thus the strings most likely to be 636 provided in deflateInit or deflateInit2. Thus the strings most likely to be
613 useful should be put at the end of the dictionary, not at the front. In 637 useful should be put at the end of the dictionary, not at the front. In
614 addition, the current implementation of deflate will use at most the window 638 addition, the current implementation of deflate will use at most the window
615 size minus 262 bytes of the provided dictionary. 639 size minus 262 bytes of the provided dictionary.
616 640
617 Upon return of this function, strm->adler is set to the adler32 value 641 Upon return of this function, strm->adler is set to the Adler-32 value
618 of the dictionary; the decompressor may later use this value to determine 642 of the dictionary; the decompressor may later use this value to determine
619 which dictionary has been used by the compressor. (The adler32 value 643 which dictionary has been used by the compressor. (The Adler-32 value
620 applies to the whole dictionary even if only a subset of the dictionary is 644 applies to the whole dictionary even if only a subset of the dictionary is
621 actually used by the compressor.) If a raw deflate was requested, then the 645 actually used by the compressor.) If a raw deflate was requested, then the
622 adler32 value is not computed and strm->adler is not set. 646 Adler-32 value is not computed and strm->adler is not set.
623 647
624 deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a 648 deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a
625 parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is 649 parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is
626 inconsistent (for example if deflate has already been called for this stream 650 inconsistent (for example if deflate has already been called for this stream
627 or if not at a block boundary for raw deflate). deflateSetDictionary does 651 or if not at a block boundary for raw deflate). deflateSetDictionary does
628 not perform any compression: this will be done by deflate(). 652 not perform any compression: this will be done by deflate().
629 */ 653 */
630 654
655 ZEXTERN int ZEXPORT deflateGetDictionary OF((z_streamp strm,
656 Bytef *dictionary,
657 uInt *dictLength));
658 /*
659 Returns the sliding dictionary being maintained by deflate. dictLength is
660 set to the number of bytes in the dictionary, and that many bytes are copied
661 to dictionary. dictionary must have enough space, where 32768 bytes is
662 always enough. If deflateGetDictionary() is called with dictionary equal to
663 Z_NULL, then only the dictionary length is returned, and nothing is copied.
664 Similary, if dictLength is Z_NULL, then it is not set.
665
666 deflateGetDictionary() may return a length less than the window size, even
667 when more than the window size in input has been provided. It may return up
668 to 258 bytes less in that case, due to how zlib's implementation of deflate
669 manages the sliding window and lookahead for matches, where matches can be
670 up to 258 bytes long. If the application needs the last window-size bytes of
671 input, then that would need to be saved by the application outside of zlib.
672
673 deflateGetDictionary returns Z_OK on success, or Z_STREAM_ERROR if the
674 stream state is inconsistent.
675 */
676
631 ZEXTERN int ZEXPORT deflateCopy OF((z_streamp dest, 677 ZEXTERN int ZEXPORT deflateCopy OF((z_streamp dest,
632 z_streamp source)); 678 z_streamp source));
633 /* 679 /*
634 Sets the destination stream as a complete copy of the source stream. 680 Sets the destination stream as a complete copy of the source stream.
635 681
636 This function can be useful when several compression strategies will be 682 This function can be useful when several compression strategies will be
637 tried, for example when there are several ways of pre-processing the input 683 tried, for example when there are several ways of pre-processing the input
638 data with a filter. The streams that will be discarded should then be freed 684 data with a filter. The streams that will be discarded should then be freed
639 by calling deflateEnd. Note that deflateCopy duplicates the internal 685 by calling deflateEnd. Note that deflateCopy duplicates the internal
640 compression state which can be quite large, so this strategy is slow and can 686 compression state which can be quite large, so this strategy is slow and can
641 consume lots of memory. 687 consume lots of memory.
642 688
643 deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not 689 deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not
644 enough memory, Z_STREAM_ERROR if the source stream state was inconsistent 690 enough memory, Z_STREAM_ERROR if the source stream state was inconsistent
645 (such as zalloc being Z_NULL). msg is left unchanged in both source and 691 (such as zalloc being Z_NULL). msg is left unchanged in both source and
646 destination. 692 destination.
647 */ 693 */
648 694
649 ZEXTERN int ZEXPORT deflateReset OF((z_streamp strm)); 695 ZEXTERN int ZEXPORT deflateReset OF((z_streamp strm));
650 /* 696 /*
651 This function is equivalent to deflateEnd followed by deflateInit, 697 This function is equivalent to deflateEnd followed by deflateInit, but
652 but does not free and reallocate all the internal compression state. The 698 does not free and reallocate the internal compression state. The stream
653 stream will keep the same compression level and any other attributes that 699 will leave the compression level and any other attributes that may have been
654 may have been set by deflateInit2. 700 set unchanged.
655 701
656 deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source 702 deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
657 stream state was inconsistent (such as zalloc or state being Z_NULL). 703 stream state was inconsistent (such as zalloc or state being Z_NULL).
658 */ 704 */
659 705
660 ZEXTERN int ZEXPORT deflateParams OF((z_streamp strm, 706 ZEXTERN int ZEXPORT deflateParams OF((z_streamp strm,
661 int level, 707 int level,
662 int strategy)); 708 int strategy));
663 /* 709 /*
664 Dynamically update the compression level and compression strategy. The 710 Dynamically update the compression level and compression strategy. The
665 interpretation of level and strategy is as in deflateInit2. This can be 711 interpretation of level and strategy is as in deflateInit2(). This can be
666 used to switch between compression and straight copy of the input data, or 712 used to switch between compression and straight copy of the input data, or
667 to switch to a different kind of input data requiring a different strategy. 713 to switch to a different kind of input data requiring a different strategy.
668 If the compression level is changed, the input available so far is 714 If the compression approach (which is a function of the level) or the
669 compressed with the old level (and may be flushed); the new level will take 715 strategy is changed, and if any input has been consumed in a previous
670 effect only at the next call of deflate(). 716 deflate() call, then the input available so far is compressed with the old
717 level and strategy using deflate(strm, Z_BLOCK). There are three approaches
718 for the compression levels 0, 1..3, and 4..9 respectively. The new level
719 and strategy will take effect at the next call of deflate().
671 720
672 Before the call of deflateParams, the stream state must be set as for 721 If a deflate(strm, Z_BLOCK) is performed by deflateParams(), and it does
673 a call of deflate(), since the currently available input may have to be 722 not have enough output space to complete, then the parameter change will not
674 compressed and flushed. In particular, strm->avail_out must be non-zero. 723 take effect. In this case, deflateParams() can be called again with the
724 same parameters and more output space to try again.
675 725
676 deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source 726 In order to assure a change in the parameters on the first try, the
677 stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR if 727 deflate stream should be flushed using deflate() with Z_BLOCK or other flush
678 strm->avail_out was zero. 728 request until strm.avail_out is not zero, before calling deflateParams().
729 Then no more input data should be provided before the deflateParams() call.
730 If this is done, the old level and strategy will be applied to the data
731 compressed before deflateParams(), and the new level and strategy will be
732 applied to the the data compressed after deflateParams().
733
734 deflateParams returns Z_OK on success, Z_STREAM_ERROR if the source stream
735 state was inconsistent or if a parameter was invalid, or Z_BUF_ERROR if
736 there was not enough output space to complete the compression of the
737 available input data before a change in the strategy or approach. Note that
738 in the case of a Z_BUF_ERROR, the parameters are not changed. A return
739 value of Z_BUF_ERROR is not fatal, in which case deflateParams() can be
740 retried with more output space.
679 */ 741 */
680 742
681 ZEXTERN int ZEXPORT deflateTune OF((z_streamp strm, 743 ZEXTERN int ZEXPORT deflateTune OF((z_streamp strm,
682 int good_length, 744 int good_length,
683 int max_lazy, 745 int max_lazy,
684 int nice_length, 746 int nice_length,
685 int max_chain)); 747 int max_chain));
686 /* 748 /*
687 Fine tune deflate's internal compression parameters. This should only be 749 Fine tune deflate's internal compression parameters. This should only be
688 used by someone who understands the algorithm used by zlib's deflate for 750 used by someone who understands the algorithm used by zlib's deflate for
(...skipping 97 matching lines...) Expand 10 before | Expand all | Expand 10 after
786 windowBits can also be zero to request that inflate use the window size in 848 windowBits can also be zero to request that inflate use the window size in
787 the zlib header of the compressed stream. 849 the zlib header of the compressed stream.
788 850
789 windowBits can also be -8..-15 for raw inflate. In this case, -windowBits 851 windowBits can also be -8..-15 for raw inflate. In this case, -windowBits
790 determines the window size. inflate() will then process raw deflate data, 852 determines the window size. inflate() will then process raw deflate data,
791 not looking for a zlib or gzip header, not generating a check value, and not 853 not looking for a zlib or gzip header, not generating a check value, and not
792 looking for any check values for comparison at the end of the stream. This 854 looking for any check values for comparison at the end of the stream. This
793 is for use with other formats that use the deflate compressed data format 855 is for use with other formats that use the deflate compressed data format
794 such as zip. Those formats provide their own check values. If a custom 856 such as zip. Those formats provide their own check values. If a custom
795 format is developed using the raw deflate format for compressed data, it is 857 format is developed using the raw deflate format for compressed data, it is
796 recommended that a check value such as an adler32 or a crc32 be applied to 858 recommended that a check value such as an Adler-32 or a CRC-32 be applied to
797 the uncompressed data as is done in the zlib, gzip, and zip formats. For 859 the uncompressed data as is done in the zlib, gzip, and zip formats. For
798 most applications, the zlib format should be used as is. Note that comments 860 most applications, the zlib format should be used as is. Note that comments
799 above on the use in deflateInit2() applies to the magnitude of windowBits. 861 above on the use in deflateInit2() applies to the magnitude of windowBits.
800 862
801 windowBits can also be greater than 15 for optional gzip decoding. Add 863 windowBits can also be greater than 15 for optional gzip decoding. Add
802 32 to windowBits to enable zlib and gzip decoding with automatic header 864 32 to windowBits to enable zlib and gzip decoding with automatic header
803 detection, or add 16 to decode only the gzip format (the zlib format will 865 detection, or add 16 to decode only the gzip format (the zlib format will
804 return a Z_DATA_ERROR). If a gzip stream is being decoded, strm->adler is a 866 return a Z_DATA_ERROR). If a gzip stream is being decoded, strm->adler is a
805 crc32 instead of an adler32. 867 CRC-32 instead of an Adler-32. Unlike the gunzip utility and gzread() (see
868 below), inflate() will not automatically decode concatenated gzip streams.
869 inflate() will return Z_STREAM_END at the end of the gzip stream. The state
870 would need to be reset to continue decoding a subsequent gzip stream.
806 871
807 inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough 872 inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
808 memory, Z_VERSION_ERROR if the zlib library version is incompatible with the 873 memory, Z_VERSION_ERROR if the zlib library version is incompatible with the
809 version assumed by the caller, or Z_STREAM_ERROR if the parameters are 874 version assumed by the caller, or Z_STREAM_ERROR if the parameters are
810 invalid, such as a null pointer to the structure. msg is set to null if 875 invalid, such as a null pointer to the structure. msg is set to null if
811 there is no error message. inflateInit2 does not perform any decompression 876 there is no error message. inflateInit2 does not perform any decompression
812 apart from possibly reading the zlib header if present: actual decompression 877 apart from possibly reading the zlib header if present: actual decompression
813 will be done by inflate(). (So next_in and avail_in may be modified, but 878 will be done by inflate(). (So next_in and avail_in may be modified, but
814 next_out and avail_out are unused and unchanged.) The current implementation 879 next_out and avail_out are unused and unchanged.) The current implementation
815 of inflateInit2() does not process any header information -- that is 880 of inflateInit2() does not process any header information -- that is
816 deferred until inflate() is called. 881 deferred until inflate() is called.
817 */ 882 */
818 883
819 ZEXTERN int ZEXPORT inflateSetDictionary OF((z_streamp strm, 884 ZEXTERN int ZEXPORT inflateSetDictionary OF((z_streamp strm,
820 const Bytef *dictionary, 885 const Bytef *dictionary,
821 uInt dictLength)); 886 uInt dictLength));
822 /* 887 /*
823 Initializes the decompression dictionary from the given uncompressed byte 888 Initializes the decompression dictionary from the given uncompressed byte
824 sequence. This function must be called immediately after a call of inflate, 889 sequence. This function must be called immediately after a call of inflate,
825 if that call returned Z_NEED_DICT. The dictionary chosen by the compressor 890 if that call returned Z_NEED_DICT. The dictionary chosen by the compressor
826 can be determined from the adler32 value returned by that call of inflate. 891 can be determined from the Adler-32 value returned by that call of inflate.
827 The compressor and decompressor must use exactly the same dictionary (see 892 The compressor and decompressor must use exactly the same dictionary (see
828 deflateSetDictionary). For raw inflate, this function can be called at any 893 deflateSetDictionary). For raw inflate, this function can be called at any
829 time to set the dictionary. If the provided dictionary is smaller than the 894 time to set the dictionary. If the provided dictionary is smaller than the
830 window and there is already data in the window, then the provided dictionary 895 window and there is already data in the window, then the provided dictionary
831 will amend what's there. The application must insure that the dictionary 896 will amend what's there. The application must insure that the dictionary
832 that was used for compression is provided. 897 that was used for compression is provided.
833 898
834 inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a 899 inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a
835 parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is 900 parameter is invalid (e.g. dictionary being Z_NULL) or the stream state is
836 inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the 901 inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the
837 expected one (incorrect adler32 value). inflateSetDictionary does not 902 expected one (incorrect Adler-32 value). inflateSetDictionary does not
838 perform any decompression: this will be done by subsequent calls of 903 perform any decompression: this will be done by subsequent calls of
839 inflate(). 904 inflate().
840 */ 905 */
841 906
842 ZEXTERN int ZEXPORT inflateGetDictionary OF((z_streamp strm, 907 ZEXTERN int ZEXPORT inflateGetDictionary OF((z_streamp strm,
843 Bytef *dictionary, 908 Bytef *dictionary,
844 uInt *dictLength)); 909 uInt *dictLength));
845 /* 910 /*
846 Returns the sliding dictionary being maintained by inflate. dictLength is 911 Returns the sliding dictionary being maintained by inflate. dictLength is
847 set to the number of bytes in the dictionary, and that many bytes are copied 912 set to the number of bytes in the dictionary, and that many bytes are copied
(...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after
885 950
886 inflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not 951 inflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not
887 enough memory, Z_STREAM_ERROR if the source stream state was inconsistent 952 enough memory, Z_STREAM_ERROR if the source stream state was inconsistent
888 (such as zalloc being Z_NULL). msg is left unchanged in both source and 953 (such as zalloc being Z_NULL). msg is left unchanged in both source and
889 destination. 954 destination.
890 */ 955 */
891 956
892 ZEXTERN int ZEXPORT inflateReset OF((z_streamp strm)); 957 ZEXTERN int ZEXPORT inflateReset OF((z_streamp strm));
893 /* 958 /*
894 This function is equivalent to inflateEnd followed by inflateInit, 959 This function is equivalent to inflateEnd followed by inflateInit,
895 but does not free and reallocate all the internal decompression state. The 960 but does not free and reallocate the internal decompression state. The
896 stream will keep attributes that may have been set by inflateInit2. 961 stream will keep attributes that may have been set by inflateInit2.
897 962
898 inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source 963 inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
899 stream state was inconsistent (such as zalloc or state being Z_NULL). 964 stream state was inconsistent (such as zalloc or state being Z_NULL).
900 */ 965 */
901 966
902 ZEXTERN int ZEXPORT inflateReset2 OF((z_streamp strm, 967 ZEXTERN int ZEXPORT inflateReset2 OF((z_streamp strm,
903 int windowBits)); 968 int windowBits));
904 /* 969 /*
905 This function is the same as inflateReset, but it also permits changing 970 This function is the same as inflateReset, but it also permits changing
906 the wrap and window size requests. The windowBits parameter is interpreted 971 the wrap and window size requests. The windowBits parameter is interpreted
907 the same as it is for inflateInit2. 972 the same as it is for inflateInit2. If the window size is changed, then the
973 memory allocated for the window is freed, and the window will be reallocated
974 by inflate() if needed.
908 975
909 inflateReset2 returns Z_OK if success, or Z_STREAM_ERROR if the source 976 inflateReset2 returns Z_OK if success, or Z_STREAM_ERROR if the source
910 stream state was inconsistent (such as zalloc or state being Z_NULL), or if 977 stream state was inconsistent (such as zalloc or state being Z_NULL), or if
911 the windowBits parameter is invalid. 978 the windowBits parameter is invalid.
912 */ 979 */
913 980
914 ZEXTERN int ZEXPORT inflatePrime OF((z_streamp strm, 981 ZEXTERN int ZEXPORT inflatePrime OF((z_streamp strm,
915 int bits, 982 int bits,
916 int value)); 983 int value));
917 /* 984 /*
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after
949 A code is being processed if inflate is waiting for more input to complete 1016 A code is being processed if inflate is waiting for more input to complete
950 decoding of the code, or if it has completed decoding but is waiting for 1017 decoding of the code, or if it has completed decoding but is waiting for
951 more output space to write the literal or match data. 1018 more output space to write the literal or match data.
952 1019
953 inflateMark() is used to mark locations in the input data for random 1020 inflateMark() is used to mark locations in the input data for random
954 access, which may be at bit positions, and to note those cases where the 1021 access, which may be at bit positions, and to note those cases where the
955 output of a code may span boundaries of random access blocks. The current 1022 output of a code may span boundaries of random access blocks. The current
956 location in the input stream can be determined from avail_in and data_type 1023 location in the input stream can be determined from avail_in and data_type
957 as noted in the description for the Z_BLOCK flush parameter for inflate. 1024 as noted in the description for the Z_BLOCK flush parameter for inflate.
958 1025
959 inflateMark returns the value noted above or -1 << 16 if the provided 1026 inflateMark returns the value noted above, or -65536 if the provided
960 source stream state was inconsistent. 1027 source stream state was inconsistent.
961 */ 1028 */
962 1029
963 ZEXTERN int ZEXPORT inflateGetHeader OF((z_streamp strm, 1030 ZEXTERN int ZEXPORT inflateGetHeader OF((z_streamp strm,
964 gz_headerp head)); 1031 gz_headerp head));
965 /* 1032 /*
966 inflateGetHeader() requests that gzip header information be stored in the 1033 inflateGetHeader() requests that gzip header information be stored in the
967 provided gz_header structure. inflateGetHeader() may be called after 1034 provided gz_header structure. inflateGetHeader() may be called after
968 inflateInit2() or inflateReset(), and before the first call of inflate(). 1035 inflateInit2() or inflateReset(), and before the first call of inflate().
969 As inflate() processes the gzip stream, head->done is zero until the header 1036 As inflate() processes the gzip stream, head->done is zero until the header
(...skipping 71 matching lines...) Expand 10 before | Expand all | Expand 10 after
1041 inflateBackInit() must be called first to allocate the internal state 1108 inflateBackInit() must be called first to allocate the internal state
1042 and to initialize the state with the user-provided window buffer. 1109 and to initialize the state with the user-provided window buffer.
1043 inflateBack() may then be used multiple times to inflate a complete, raw 1110 inflateBack() may then be used multiple times to inflate a complete, raw
1044 deflate stream with each call. inflateBackEnd() is then called to free the 1111 deflate stream with each call. inflateBackEnd() is then called to free the
1045 allocated state. 1112 allocated state.
1046 1113
1047 A raw deflate stream is one with no zlib or gzip header or trailer. 1114 A raw deflate stream is one with no zlib or gzip header or trailer.
1048 This routine would normally be used in a utility that reads zip or gzip 1115 This routine would normally be used in a utility that reads zip or gzip
1049 files and writes out uncompressed files. The utility would decode the 1116 files and writes out uncompressed files. The utility would decode the
1050 header and process the trailer on its own, hence this routine expects only 1117 header and process the trailer on its own, hence this routine expects only
1051 the raw deflate stream to decompress. This is different from the normal 1118 the raw deflate stream to decompress. This is different from the default
1052 behavior of inflate(), which expects either a zlib or gzip header and 1119 behavior of inflate(), which expects a zlib header and trailer around the
1053 trailer around the deflate stream. 1120 deflate stream.
1054 1121
1055 inflateBack() uses two subroutines supplied by the caller that are then 1122 inflateBack() uses two subroutines supplied by the caller that are then
1056 called by inflateBack() for input and output. inflateBack() calls those 1123 called by inflateBack() for input and output. inflateBack() calls those
1057 routines until it reads a complete deflate stream and writes out all of the 1124 routines until it reads a complete deflate stream and writes out all of the
1058 uncompressed data, or until it encounters an error. The function's 1125 uncompressed data, or until it encounters an error. The function's
1059 parameters and return types are defined above in the in_func and out_func 1126 parameters and return types are defined above in the in_func and out_func
1060 typedefs. inflateBack() will call in(in_desc, &buf) which should return the 1127 typedefs. inflateBack() will call in(in_desc, &buf) which should return the
1061 number of bytes of provided input, and a pointer to that input in buf. If 1128 number of bytes of provided input, and a pointer to that input in buf. If
1062 there is no input available, in() must return zero--buf is ignored in that 1129 there is no input available, in() must return zero -- buf is ignored in that
1063 case--and inflateBack() will return a buffer error. inflateBack() will call 1130 case -- and inflateBack() will return a buffer error. inflateBack() will
1064 out(out_desc, buf, len) to write the uncompressed data buf[0..len-1]. out() 1131 call out(out_desc, buf, len) to write the uncompressed data buf[0..len-1].
1065 should return zero on success, or non-zero on failure. If out() returns 1132 out() should return zero on success, or non-zero on failure. If out()
1066 non-zero, inflateBack() will return with an error. Neither in() nor out() 1133 returns non-zero, inflateBack() will return with an error. Neither in() nor
1067 are permitted to change the contents of the window provided to 1134 out() are permitted to change the contents of the window provided to
1068 inflateBackInit(), which is also the buffer that out() uses to write from. 1135 inflateBackInit(), which is also the buffer that out() uses to write from.
1069 The length written by out() will be at most the window size. Any non-zero 1136 The length written by out() will be at most the window size. Any non-zero
1070 amount of input may be provided by in(). 1137 amount of input may be provided by in().
1071 1138
1072 For convenience, inflateBack() can be provided input on the first call by 1139 For convenience, inflateBack() can be provided input on the first call by
1073 setting strm->next_in and strm->avail_in. If that input is exhausted, then 1140 setting strm->next_in and strm->avail_in. If that input is exhausted, then
1074 in() will be called. Therefore strm->next_in must be initialized before 1141 in() will be called. Therefore strm->next_in must be initialized before
1075 calling inflateBack(). If strm->next_in is Z_NULL, then in() will be called 1142 calling inflateBack(). If strm->next_in is Z_NULL, then in() will be called
1076 immediately for input. If strm->next_in is not Z_NULL, then strm->avail_in 1143 immediately for input. If strm->next_in is not Z_NULL, then strm->avail_in
1077 must also be initialized, and then if strm->avail_in is not zero, input will 1144 must also be initialized, and then if strm->avail_in is not zero, input will
1078 initially be taken from strm->next_in[0 .. strm->avail_in - 1]. 1145 initially be taken from strm->next_in[0 .. strm->avail_in - 1].
1079 1146
1080 The in_desc and out_desc parameters of inflateBack() is passed as the 1147 The in_desc and out_desc parameters of inflateBack() is passed as the
1081 first parameter of in() and out() respectively when they are called. These 1148 first parameter of in() and out() respectively when they are called. These
1082 descriptors can be optionally used to pass any information that the caller- 1149 descriptors can be optionally used to pass any information that the caller-
1083 supplied in() and out() functions need to do their job. 1150 supplied in() and out() functions need to do their job.
1084 1151
1085 On return, inflateBack() will set strm->next_in and strm->avail_in to 1152 On return, inflateBack() will set strm->next_in and strm->avail_in to
1086 pass back any unused input that was provided by the last in() call. The 1153 pass back any unused input that was provided by the last in() call. The
1087 return values of inflateBack() can be Z_STREAM_END on success, Z_BUF_ERROR 1154 return values of inflateBack() can be Z_STREAM_END on success, Z_BUF_ERROR
1088 if in() or out() returned an error, Z_DATA_ERROR if there was a format error 1155 if in() or out() returned an error, Z_DATA_ERROR if there was a format error
1089 in the deflate stream (in which case strm->msg is set to indicate the nature 1156 in the deflate stream (in which case strm->msg is set to indicate the nature
1090 of the error), or Z_STREAM_ERROR if the stream was not properly initialized. 1157 of the error), or Z_STREAM_ERROR if the stream was not properly initialized.
1091 In the case of Z_BUF_ERROR, an input or output error can be distinguished 1158 In the case of Z_BUF_ERROR, an input or output error can be distinguished
1092 using strm->next_in which will be Z_NULL only if in() returned an error. If 1159 using strm->next_in which will be Z_NULL only if in() returned an error. If
1093 strm->next_in is not Z_NULL, then the Z_BUF_ERROR was due to out() returning 1160 strm->next_in is not Z_NULL, then the Z_BUF_ERROR was due to out() returning
1094 non-zero. (in() will always be called before out(), so strm->next_in is 1161 non-zero. (in() will always be called before out(), so strm->next_in is
1095 assured to be defined if out() returns non-zero.) Note that inflateBack() 1162 assured to be defined if out() returns non-zero.) Note that inflateBack()
1096 cannot return Z_OK. 1163 cannot return Z_OK.
1097 */ 1164 */
1098 1165
1099 ZEXTERN int ZEXPORT inflateBackEnd OF((z_streamp strm)); 1166 ZEXTERN int ZEXPORT inflateBackEnd OF((z_streamp strm));
1100 /* 1167 /*
1101 All memory allocated by inflateBackInit() is freed. 1168 All memory allocated by inflateBackInit() is freed.
1102 1169
1103 inflateBackEnd() returns Z_OK on success, or Z_STREAM_ERROR if the stream 1170 inflateBackEnd() returns Z_OK on success, or Z_STREAM_ERROR if the stream
1104 state was inconsistent. 1171 state was inconsistent.
1105 */ 1172 */
1106 1173
1107 ZEXTERN uLong ZEXPORT zlibCompileFlags OF((void)); 1174 ZEXTERN uLong ZEXPORT zlibCompileFlags OF((void));
1108 /* Return flags indicating compile-time options. 1175 /* Return flags indicating compile-time options.
1109 1176
1110 Type sizes, two bits each, 00 = 16 bits, 01 = 32, 10 = 64, 11 = other: 1177 Type sizes, two bits each, 00 = 16 bits, 01 = 32, 10 = 64, 11 = other:
1111 1.0: size of uInt 1178 1.0: size of uInt
1112 3.2: size of uLong 1179 3.2: size of uLong
1113 5.4: size of voidpf (pointer) 1180 5.4: size of voidpf (pointer)
1114 7.6: size of z_off_t 1181 7.6: size of z_off_t
1115 1182
1116 Compiler, assembler, and debug options: 1183 Compiler, assembler, and debug options:
1117 8: DEBUG 1184 8: ZLIB_DEBUG
1118 9: ASMV or ASMINF -- use ASM code 1185 9: ASMV or ASMINF -- use ASM code
1119 10: ZLIB_WINAPI -- exported functions use the WINAPI calling convention 1186 10: ZLIB_WINAPI -- exported functions use the WINAPI calling convention
1120 11: 0 (reserved) 1187 11: 0 (reserved)
1121 1188
1122 One-time table building (smaller code, but not thread-safe if true): 1189 One-time table building (smaller code, but not thread-safe if true):
1123 12: BUILDFIXED -- build static block decoding tables when needed 1190 12: BUILDFIXED -- build static block decoding tables when needed
1124 13: DYNAMIC_CRC_TABLE -- build CRC calculation tables when needed 1191 13: DYNAMIC_CRC_TABLE -- build CRC calculation tables when needed
1125 14,15: 0 (reserved) 1192 14,15: 0 (reserved)
1126 1193
1127 Library content (indicates missing functionality): 1194 Library content (indicates missing functionality):
(...skipping 29 matching lines...) Expand all
1157 you need special options. 1224 you need special options.
1158 */ 1225 */
1159 1226
1160 ZEXTERN int ZEXPORT compress OF((Bytef *dest, uLongf *destLen, 1227 ZEXTERN int ZEXPORT compress OF((Bytef *dest, uLongf *destLen,
1161 const Bytef *source, uLong sourceLen)); 1228 const Bytef *source, uLong sourceLen));
1162 /* 1229 /*
1163 Compresses the source buffer into the destination buffer. sourceLen is 1230 Compresses the source buffer into the destination buffer. sourceLen is
1164 the byte length of the source buffer. Upon entry, destLen is the total size 1231 the byte length of the source buffer. Upon entry, destLen is the total size
1165 of the destination buffer, which must be at least the value returned by 1232 of the destination buffer, which must be at least the value returned by
1166 compressBound(sourceLen). Upon exit, destLen is the actual size of the 1233 compressBound(sourceLen). Upon exit, destLen is the actual size of the
1167 compressed buffer. 1234 compressed data. compress() is equivalent to compress2() with a level
1235 parameter of Z_DEFAULT_COMPRESSION.
1168 1236
1169 compress returns Z_OK if success, Z_MEM_ERROR if there was not 1237 compress returns Z_OK if success, Z_MEM_ERROR if there was not
1170 enough memory, Z_BUF_ERROR if there was not enough room in the output 1238 enough memory, Z_BUF_ERROR if there was not enough room in the output
1171 buffer. 1239 buffer.
1172 */ 1240 */
1173 1241
1174 ZEXTERN int ZEXPORT compress2 OF((Bytef *dest, uLongf *destLen, 1242 ZEXTERN int ZEXPORT compress2 OF((Bytef *dest, uLongf *destLen,
1175 const Bytef *source, uLong sourceLen, 1243 const Bytef *source, uLong sourceLen,
1176 int level)); 1244 int level));
1177 /* 1245 /*
1178 Compresses the source buffer into the destination buffer. The level 1246 Compresses the source buffer into the destination buffer. The level
1179 parameter has the same meaning as in deflateInit. sourceLen is the byte 1247 parameter has the same meaning as in deflateInit. sourceLen is the byte
1180 length of the source buffer. Upon entry, destLen is the total size of the 1248 length of the source buffer. Upon entry, destLen is the total size of the
1181 destination buffer, which must be at least the value returned by 1249 destination buffer, which must be at least the value returned by
1182 compressBound(sourceLen). Upon exit, destLen is the actual size of the 1250 compressBound(sourceLen). Upon exit, destLen is the actual size of the
1183 compressed buffer. 1251 compressed data.
1184 1252
1185 compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough 1253 compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough
1186 memory, Z_BUF_ERROR if there was not enough room in the output buffer, 1254 memory, Z_BUF_ERROR if there was not enough room in the output buffer,
1187 Z_STREAM_ERROR if the level parameter is invalid. 1255 Z_STREAM_ERROR if the level parameter is invalid.
1188 */ 1256 */
1189 1257
1190 ZEXTERN uLong ZEXPORT compressBound OF((uLong sourceLen)); 1258 ZEXTERN uLong ZEXPORT compressBound OF((uLong sourceLen));
1191 /* 1259 /*
1192 compressBound() returns an upper bound on the compressed size after 1260 compressBound() returns an upper bound on the compressed size after
1193 compress() or compress2() on sourceLen bytes. It would be used before a 1261 compress() or compress2() on sourceLen bytes. It would be used before a
1194 compress() or compress2() call to allocate the destination buffer. 1262 compress() or compress2() call to allocate the destination buffer.
1195 */ 1263 */
1196 1264
1197 ZEXTERN int ZEXPORT uncompress OF((Bytef *dest, uLongf *destLen, 1265 ZEXTERN int ZEXPORT uncompress OF((Bytef *dest, uLongf *destLen,
1198 const Bytef *source, uLong sourceLen)); 1266 const Bytef *source, uLong sourceLen));
1199 /* 1267 /*
1200 Decompresses the source buffer into the destination buffer. sourceLen is 1268 Decompresses the source buffer into the destination buffer. sourceLen is
1201 the byte length of the source buffer. Upon entry, destLen is the total size 1269 the byte length of the source buffer. Upon entry, destLen is the total size
1202 of the destination buffer, which must be large enough to hold the entire 1270 of the destination buffer, which must be large enough to hold the entire
1203 uncompressed data. (The size of the uncompressed data must have been saved 1271 uncompressed data. (The size of the uncompressed data must have been saved
1204 previously by the compressor and transmitted to the decompressor by some 1272 previously by the compressor and transmitted to the decompressor by some
1205 mechanism outside the scope of this compression library.) Upon exit, destLen 1273 mechanism outside the scope of this compression library.) Upon exit, destLen
1206 is the actual size of the uncompressed buffer. 1274 is the actual size of the uncompressed data.
1207 1275
1208 uncompress returns Z_OK if success, Z_MEM_ERROR if there was not 1276 uncompress returns Z_OK if success, Z_MEM_ERROR if there was not
1209 enough memory, Z_BUF_ERROR if there was not enough room in the output 1277 enough memory, Z_BUF_ERROR if there was not enough room in the output
1210 buffer, or Z_DATA_ERROR if the input data was corrupted or incomplete. In 1278 buffer, or Z_DATA_ERROR if the input data was corrupted or incomplete. In
1211 the case where there is not enough room, uncompress() will fill the output 1279 the case where there is not enough room, uncompress() will fill the output
1212 buffer with the uncompressed data up to that point. 1280 buffer with the uncompressed data up to that point.
1213 */ 1281 */
1214 1282
1283 ZEXTERN int ZEXPORT uncompress2 OF((Bytef *dest, uLongf *destLen,
1284 const Bytef *source, uLong *sourceLen));
1285 /*
1286 Same as uncompress, except that sourceLen is a pointer, where the
1287 length of the source is *sourceLen. On return, *sourceLen is the number of
1288 source bytes consumed.
1289 */
1290
1215 /* gzip file access functions */ 1291 /* gzip file access functions */
1216 1292
1217 /* 1293 /*
1218 This library supports reading and writing files in gzip (.gz) format with 1294 This library supports reading and writing files in gzip (.gz) format with
1219 an interface similar to that of stdio, using the functions that start with 1295 an interface similar to that of stdio, using the functions that start with
1220 "gz". The gzip format is different from the zlib format. gzip is a gzip 1296 "gz". The gzip format is different from the zlib format. gzip is a gzip
1221 wrapper, documented in RFC 1952, wrapped around a deflate stream. 1297 wrapper, documented in RFC 1952, wrapped around a deflate stream.
1222 */ 1298 */
1223 1299
1224 typedef struct gzFile_s *gzFile; /* semi-opaque gzip file descriptor */ 1300 typedef struct gzFile_s *gzFile; /* semi-opaque gzip file descriptor */
(...skipping 58 matching lines...) Expand 10 before | Expand all | Expand 10 after
1283 used until the next gz* read, write, seek, or close operation, so gzdopen 1359 used until the next gz* read, write, seek, or close operation, so gzdopen
1284 will not detect if fd is invalid (unless fd is -1). 1360 will not detect if fd is invalid (unless fd is -1).
1285 */ 1361 */
1286 1362
1287 ZEXTERN int ZEXPORT gzbuffer OF((gzFile file, unsigned size)); 1363 ZEXTERN int ZEXPORT gzbuffer OF((gzFile file, unsigned size));
1288 /* 1364 /*
1289 Set the internal buffer size used by this library's functions. The 1365 Set the internal buffer size used by this library's functions. The
1290 default buffer size is 8192 bytes. This function must be called after 1366 default buffer size is 8192 bytes. This function must be called after
1291 gzopen() or gzdopen(), and before any other calls that read or write the 1367 gzopen() or gzdopen(), and before any other calls that read or write the
1292 file. The buffer memory allocation is always deferred to the first read or 1368 file. The buffer memory allocation is always deferred to the first read or
1293 write. Two buffers are allocated, either both of the specified size when 1369 write. Three times that size in buffer space is allocated. A larger buffer
1294 writing, or one of the specified size and the other twice that size when 1370 size of, for example, 64K or 128K bytes will noticeably increase the speed
1295 reading. A larger buffer size of, for example, 64K or 128K bytes will 1371 of decompression (reading).
1296 noticeably increase the speed of decompression (reading).
1297 1372
1298 The new buffer size also affects the maximum length for gzprintf(). 1373 The new buffer size also affects the maximum length for gzprintf().
1299 1374
1300 gzbuffer() returns 0 on success, or -1 on failure, such as being called 1375 gzbuffer() returns 0 on success, or -1 on failure, such as being called
1301 too late. 1376 too late.
1302 */ 1377 */
1303 1378
1304 ZEXTERN int ZEXPORT gzsetparams OF((gzFile file, int level, int strategy)); 1379 ZEXTERN int ZEXPORT gzsetparams OF((gzFile file, int level, int strategy));
1305 /* 1380 /*
1306 Dynamically update the compression level or strategy. See the description 1381 Dynamically update the compression level or strategy. See the description
1307 of deflateInit2 for the meaning of these parameters. 1382 of deflateInit2 for the meaning of these parameters. Previously provided
1383 data is flushed before the parameter change.
1308 1384
1309 gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not 1385 gzsetparams returns Z_OK if success, Z_STREAM_ERROR if the file was not
1310 opened for writing. 1386 opened for writing, Z_ERRNO if there is an error writing the flushed data,
1387 or Z_MEM_ERROR if there is a memory allocation error.
1311 */ 1388 */
1312 1389
1313 ZEXTERN int ZEXPORT gzread OF((gzFile file, voidp buf, unsigned len)); 1390 ZEXTERN int ZEXPORT gzread OF((gzFile file, voidp buf, unsigned len));
1314 /* 1391 /*
1315 Reads the given number of uncompressed bytes from the compressed file. If 1392 Reads the given number of uncompressed bytes from the compressed file. If
1316 the input file is not in gzip format, gzread copies the given number of 1393 the input file is not in gzip format, gzread copies the given number of
1317 bytes into the buffer directly from the file. 1394 bytes into the buffer directly from the file.
1318 1395
1319 After reaching the end of a gzip stream in the input, gzread will continue 1396 After reaching the end of a gzip stream in the input, gzread will continue
1320 to read, looking for another gzip stream. Any number of gzip streams may be 1397 to read, looking for another gzip stream. Any number of gzip streams may be
1321 concatenated in the input file, and will all be decompressed by gzread(). 1398 concatenated in the input file, and will all be decompressed by gzread().
1322 If something other than a gzip stream is encountered after a gzip stream, 1399 If something other than a gzip stream is encountered after a gzip stream,
1323 that remaining trailing garbage is ignored (and no error is returned). 1400 that remaining trailing garbage is ignored (and no error is returned).
1324 1401
1325 gzread can be used to read a gzip file that is being concurrently written. 1402 gzread can be used to read a gzip file that is being concurrently written.
1326 Upon reaching the end of the input, gzread will return with the available 1403 Upon reaching the end of the input, gzread will return with the available
1327 data. If the error code returned by gzerror is Z_OK or Z_BUF_ERROR, then 1404 data. If the error code returned by gzerror is Z_OK or Z_BUF_ERROR, then
1328 gzclearerr can be used to clear the end of file indicator in order to permit 1405 gzclearerr can be used to clear the end of file indicator in order to permit
1329 gzread to be tried again. Z_OK indicates that a gzip stream was completed 1406 gzread to be tried again. Z_OK indicates that a gzip stream was completed
1330 on the last gzread. Z_BUF_ERROR indicates that the input file ended in the 1407 on the last gzread. Z_BUF_ERROR indicates that the input file ended in the
1331 middle of a gzip stream. Note that gzread does not return -1 in the event 1408 middle of a gzip stream. Note that gzread does not return -1 in the event
1332 of an incomplete gzip stream. This error is deferred until gzclose(), which 1409 of an incomplete gzip stream. This error is deferred until gzclose(), which
1333 will return Z_BUF_ERROR if the last gzread ended in the middle of a gzip 1410 will return Z_BUF_ERROR if the last gzread ended in the middle of a gzip
1334 stream. Alternatively, gzerror can be used before gzclose to detect this 1411 stream. Alternatively, gzerror can be used before gzclose to detect this
1335 case. 1412 case.
1336 1413
1337 gzread returns the number of uncompressed bytes actually read, less than 1414 gzread returns the number of uncompressed bytes actually read, less than
1338 len for end of file, or -1 for error. 1415 len for end of file, or -1 for error. If len is too large to fit in an int,
1416 then nothing is read, -1 is returned, and the error state is set to
1417 Z_STREAM_ERROR.
1418 */
1419
1420 ZEXTERN z_size_t ZEXPORT gzfread OF((voidp buf, z_size_t size, z_size_t nitems,
1421 gzFile file));
1422 /*
1423 Read up to nitems items of size size from file to buf, otherwise operating
1424 as gzread() does. This duplicates the interface of stdio's fread(), with
1425 size_t request and return types. If the library defines size_t, then
1426 z_size_t is identical to size_t. If not, then z_size_t is an unsigned
1427 integer type that can contain a pointer.
1428
1429 gzfread() returns the number of full items read of size size, or zero if
1430 the end of the file was reached and a full item could not be read, or if
1431 there was an error. gzerror() must be consulted if zero is returned in
1432 order to determine if there was an error. If the multiplication of size and
1433 nitems overflows, i.e. the product does not fit in a z_size_t, then nothing
1434 is read, zero is returned, and the error state is set to Z_STREAM_ERROR.
1435
1436 In the event that the end of file is reached and only a partial item is
1437 available at the end, i.e. the remaining uncompressed data length is not a
1438 multiple of size, then the final partial item is nevetheless read into buf
1439 and the end-of-file flag is set. The length of the partial item read is not
1440 provided, but could be inferred from the result of gztell(). This behavior
1441 is the same as the behavior of fread() implementations in common libraries,
1442 but it prevents the direct use of gzfread() to read a concurrently written
1443 file, reseting and retrying on end-of-file, when size is not 1.
1339 */ 1444 */
1340 1445
1341 ZEXTERN int ZEXPORT gzwrite OF((gzFile file, 1446 ZEXTERN int ZEXPORT gzwrite OF((gzFile file,
1342 voidpc buf, unsigned len)); 1447 voidpc buf, unsigned len));
1343 /* 1448 /*
1344 Writes the given number of uncompressed bytes into the compressed file. 1449 Writes the given number of uncompressed bytes into the compressed file.
1345 gzwrite returns the number of uncompressed bytes written or 0 in case of 1450 gzwrite returns the number of uncompressed bytes written or 0 in case of
1346 error. 1451 error.
1347 */ 1452 */
1348 1453
1454 ZEXTERN z_size_t ZEXPORT gzfwrite OF((voidpc buf, z_size_t size,
1455 z_size_t nitems, gzFile file));
1456 /*
1457 gzfwrite() writes nitems items of size size from buf to file, duplicating
1458 the interface of stdio's fwrite(), with size_t request and return types. If
1459 the library defines size_t, then z_size_t is identical to size_t. If not,
1460 then z_size_t is an unsigned integer type that can contain a pointer.
1461
1462 gzfwrite() returns the number of full items written of size size, or zero
1463 if there was an error. If the multiplication of size and nitems overflows,
1464 i.e. the product does not fit in a z_size_t, then nothing is written, zero
1465 is returned, and the error state is set to Z_STREAM_ERROR.
1466 */
1467
1349 ZEXTERN int ZEXPORTVA gzprintf Z_ARG((gzFile file, const char *format, ...)); 1468 ZEXTERN int ZEXPORTVA gzprintf Z_ARG((gzFile file, const char *format, ...));
1350 /* 1469 /*
1351 Converts, formats, and writes the arguments to the compressed file under 1470 Converts, formats, and writes the arguments to the compressed file under
1352 control of the format string, as in fprintf. gzprintf returns the number of 1471 control of the format string, as in fprintf. gzprintf returns the number of
1353 uncompressed bytes actually written, or 0 in case of error. The number of 1472 uncompressed bytes actually written, or a negative zlib error code in case
1354 uncompressed bytes written is limited to 8191, or one less than the buffer 1473 of error. The number of uncompressed bytes written is limited to 8191, or
1355 size given to gzbuffer(). The caller should assure that this limit is not 1474 one less than the buffer size given to gzbuffer(). The caller should assure
1356 exceeded. If it is exceeded, then gzprintf() will return an error (0) with 1475 that this limit is not exceeded. If it is exceeded, then gzprintf() will
1357 nothing written. In this case, there may also be a buffer overflow with 1476 return an error (0) with nothing written. In this case, there may also be a
1358 unpredictable consequences, which is possible only if zlib was compiled with 1477 buffer overflow with unpredictable consequences, which is possible only if
1359 the insecure functions sprintf() or vsprintf() because the secure snprintf() 1478 zlib was compiled with the insecure functions sprintf() or vsprintf()
1360 or vsnprintf() functions were not available. This can be determined using 1479 because the secure snprintf() or vsnprintf() functions were not available.
1361 zlibCompileFlags(). 1480 This can be determined using zlibCompileFlags().
1362 */ 1481 */
1363 1482
1364 ZEXTERN int ZEXPORT gzputs OF((gzFile file, const char *s)); 1483 ZEXTERN int ZEXPORT gzputs OF((gzFile file, const char *s));
1365 /* 1484 /*
1366 Writes the given null-terminated string to the compressed file, excluding 1485 Writes the given null-terminated string to the compressed file, excluding
1367 the terminating null character. 1486 the terminating null character.
1368 1487
1369 gzputs returns the number of characters written, or -1 in case of error. 1488 gzputs returns the number of characters written, or -1 in case of error.
1370 */ 1489 */
1371 1490
(...skipping 39 matching lines...) Expand 10 before | Expand all | Expand 10 after
1411 1530
1412 ZEXTERN int ZEXPORT gzflush OF((gzFile file, int flush)); 1531 ZEXTERN int ZEXPORT gzflush OF((gzFile file, int flush));
1413 /* 1532 /*
1414 Flushes all pending output into the compressed file. The parameter flush 1533 Flushes all pending output into the compressed file. The parameter flush
1415 is as in the deflate() function. The return value is the zlib error number 1534 is as in the deflate() function. The return value is the zlib error number
1416 (see function gzerror below). gzflush is only permitted when writing. 1535 (see function gzerror below). gzflush is only permitted when writing.
1417 1536
1418 If the flush parameter is Z_FINISH, the remaining data is written and the 1537 If the flush parameter is Z_FINISH, the remaining data is written and the
1419 gzip stream is completed in the output. If gzwrite() is called again, a new 1538 gzip stream is completed in the output. If gzwrite() is called again, a new
1420 gzip stream will be started in the output. gzread() is able to read such 1539 gzip stream will be started in the output. gzread() is able to read such
1421 concatented gzip streams. 1540 concatenated gzip streams.
1422 1541
1423 gzflush should be called only when strictly necessary because it will 1542 gzflush should be called only when strictly necessary because it will
1424 degrade compression if called too often. 1543 degrade compression if called too often.
1425 */ 1544 */
1426 1545
1427 /* 1546 /*
1428 ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile file, 1547 ZEXTERN z_off_t ZEXPORT gzseek OF((gzFile file,
1429 z_off_t offset, int whence)); 1548 z_off_t offset, int whence));
1430 1549
1431 Sets the starting position for the next gzread or gzwrite on the given 1550 Sets the starting position for the next gzread or gzwrite on the given
(...skipping 133 matching lines...) Expand 10 before | Expand all | Expand 10 after
1565 anyway because they might be useful in applications using the compression 1684 anyway because they might be useful in applications using the compression
1566 library. 1685 library.
1567 */ 1686 */
1568 1687
1569 ZEXTERN uLong ZEXPORT adler32 OF((uLong adler, const Bytef *buf, uInt len)); 1688 ZEXTERN uLong ZEXPORT adler32 OF((uLong adler, const Bytef *buf, uInt len));
1570 /* 1689 /*
1571 Update a running Adler-32 checksum with the bytes buf[0..len-1] and 1690 Update a running Adler-32 checksum with the bytes buf[0..len-1] and
1572 return the updated checksum. If buf is Z_NULL, this function returns the 1691 return the updated checksum. If buf is Z_NULL, this function returns the
1573 required initial value for the checksum. 1692 required initial value for the checksum.
1574 1693
1575 An Adler-32 checksum is almost as reliable as a CRC32 but can be computed 1694 An Adler-32 checksum is almost as reliable as a CRC-32 but can be computed
1576 much faster. 1695 much faster.
1577 1696
1578 Usage example: 1697 Usage example:
1579 1698
1580 uLong adler = adler32(0L, Z_NULL, 0); 1699 uLong adler = adler32(0L, Z_NULL, 0);
1581 1700
1582 while (read_buffer(buffer, length) != EOF) { 1701 while (read_buffer(buffer, length) != EOF) {
1583 adler = adler32(adler, buffer, length); 1702 adler = adler32(adler, buffer, length);
1584 } 1703 }
1585 if (adler != original_adler) error(); 1704 if (adler != original_adler) error();
1586 */ 1705 */
1587 1706
1707 ZEXTERN uLong ZEXPORT adler32_z OF((uLong adler, const Bytef *buf,
1708 z_size_t len));
1709 /*
1710 Same as adler32(), but with a size_t length.
1711 */
1712
1588 /* 1713 /*
1589 ZEXTERN uLong ZEXPORT adler32_combine OF((uLong adler1, uLong adler2, 1714 ZEXTERN uLong ZEXPORT adler32_combine OF((uLong adler1, uLong adler2,
1590 z_off_t len2)); 1715 z_off_t len2));
1591 1716
1592 Combine two Adler-32 checksums into one. For two sequences of bytes, seq1 1717 Combine two Adler-32 checksums into one. For two sequences of bytes, seq1
1593 and seq2 with lengths len1 and len2, Adler-32 checksums were calculated for 1718 and seq2 with lengths len1 and len2, Adler-32 checksums were calculated for
1594 each, adler1 and adler2. adler32_combine() returns the Adler-32 checksum of 1719 each, adler1 and adler2. adler32_combine() returns the Adler-32 checksum of
1595 seq1 and seq2 concatenated, requiring only adler1, adler2, and len2. Note 1720 seq1 and seq2 concatenated, requiring only adler1, adler2, and len2. Note
1596 that the z_off_t type (like off_t) is a signed integer. If len2 is 1721 that the z_off_t type (like off_t) is a signed integer. If len2 is
1597 negative, the result has no meaning or utility. 1722 negative, the result has no meaning or utility.
1598 */ 1723 */
1599 1724
1600 ZEXTERN uLong ZEXPORT crc32 OF((uLong crc, const Bytef *buf, uInt len)); 1725 ZEXTERN uLong ZEXPORT crc32 OF((uLong crc, const Bytef *buf, uInt len));
1601 /* 1726 /*
1602 Update a running CRC-32 with the bytes buf[0..len-1] and return the 1727 Update a running CRC-32 with the bytes buf[0..len-1] and return the
1603 updated CRC-32. If buf is Z_NULL, this function returns the required 1728 updated CRC-32. If buf is Z_NULL, this function returns the required
1604 initial value for the crc. Pre- and post-conditioning (one's complement) is 1729 initial value for the crc. Pre- and post-conditioning (one's complement) is
1605 performed within this function so it shouldn't be done by the application. 1730 performed within this function so it shouldn't be done by the application.
1606 1731
1607 Usage example: 1732 Usage example:
1608 1733
1609 uLong crc = crc32(0L, Z_NULL, 0); 1734 uLong crc = crc32(0L, Z_NULL, 0);
1610 1735
1611 while (read_buffer(buffer, length) != EOF) { 1736 while (read_buffer(buffer, length) != EOF) {
1612 crc = crc32(crc, buffer, length); 1737 crc = crc32(crc, buffer, length);
1613 } 1738 }
1614 if (crc != original_crc) error(); 1739 if (crc != original_crc) error();
1615 */ 1740 */
1616 1741
1742 ZEXTERN uLong ZEXPORT crc32_z OF((uLong adler, const Bytef *buf,
1743 z_size_t len));
1744 /*
1745 Same as crc32(), but with a size_t length.
1746 */
1747
1617 /* 1748 /*
1618 ZEXTERN uLong ZEXPORT crc32_combine OF((uLong crc1, uLong crc2, z_off_t len2)); 1749 ZEXTERN uLong ZEXPORT crc32_combine OF((uLong crc1, uLong crc2, z_off_t len2));
1619 1750
1620 Combine two CRC-32 check values into one. For two sequences of bytes, 1751 Combine two CRC-32 check values into one. For two sequences of bytes,
1621 seq1 and seq2 with lengths len1 and len2, CRC-32 check values were 1752 seq1 and seq2 with lengths len1 and len2, CRC-32 check values were
1622 calculated for each, crc1 and crc2. crc32_combine() returns the CRC-32 1753 calculated for each, crc1 and crc2. crc32_combine() returns the CRC-32
1623 check value of seq1 and seq2 concatenated, requiring only crc1, crc2, and 1754 check value of seq1 and seq2 concatenated, requiring only crc1, crc2, and
1624 len2. 1755 len2.
1625 */ 1756 */
1626 1757
(...skipping 10 matching lines...) Expand all
1637 ZEXTERN int ZEXPORT deflateInit2_ OF((z_streamp strm, int level, int method, 1768 ZEXTERN int ZEXPORT deflateInit2_ OF((z_streamp strm, int level, int method,
1638 int windowBits, int memLevel, 1769 int windowBits, int memLevel,
1639 int strategy, const char *version, 1770 int strategy, const char *version,
1640 int stream_size)); 1771 int stream_size));
1641 ZEXTERN int ZEXPORT inflateInit2_ OF((z_streamp strm, int windowBits, 1772 ZEXTERN int ZEXPORT inflateInit2_ OF((z_streamp strm, int windowBits,
1642 const char *version, int stream_size)); 1773 const char *version, int stream_size));
1643 ZEXTERN int ZEXPORT inflateBackInit_ OF((z_streamp strm, int windowBits, 1774 ZEXTERN int ZEXPORT inflateBackInit_ OF((z_streamp strm, int windowBits,
1644 unsigned char FAR *window, 1775 unsigned char FAR *window,
1645 const char *version, 1776 const char *version,
1646 int stream_size)); 1777 int stream_size));
1647 #define deflateInit(strm, level) \ 1778 #ifdef Z_PREFIX_SET
1648 deflateInit_((strm), (level), ZLIB_VERSION, (int)sizeof(z_stream)) 1779 # define z_deflateInit(strm, level) \
1649 #define inflateInit(strm) \ 1780 deflateInit_((strm), (level), ZLIB_VERSION, (int)sizeof(z_stream))
1650 inflateInit_((strm), ZLIB_VERSION, (int)sizeof(z_stream)) 1781 # define z_inflateInit(strm) \
1651 #define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \ 1782 inflateInit_((strm), ZLIB_VERSION, (int)sizeof(z_stream))
1652 deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\ 1783 # define z_deflateInit2(strm, level, method, windowBits, memLevel, strategy) \
1653 (strategy), ZLIB_VERSION, (int)sizeof(z_stream)) 1784 deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\
1654 #define inflateInit2(strm, windowBits) \ 1785 (strategy), ZLIB_VERSION, (int)sizeof(z_stream))
1655 inflateInit2_((strm), (windowBits), ZLIB_VERSION, \ 1786 # define z_inflateInit2(strm, windowBits) \
1656 (int)sizeof(z_stream)) 1787 inflateInit2_((strm), (windowBits), ZLIB_VERSION, \
1657 #define inflateBackInit(strm, windowBits, window) \ 1788 (int)sizeof(z_stream))
1658 inflateBackInit_((strm), (windowBits), (window), \ 1789 # define z_inflateBackInit(strm, windowBits, window) \
1659 ZLIB_VERSION, (int)sizeof(z_stream)) 1790 inflateBackInit_((strm), (windowBits), (window), \
1791 ZLIB_VERSION, (int)sizeof(z_stream))
1792 #else
1793 # define deflateInit(strm, level) \
1794 deflateInit_((strm), (level), ZLIB_VERSION, (int)sizeof(z_stream))
1795 # define inflateInit(strm) \
1796 inflateInit_((strm), ZLIB_VERSION, (int)sizeof(z_stream))
1797 # define deflateInit2(strm, level, method, windowBits, memLevel, strategy) \
1798 deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\
1799 (strategy), ZLIB_VERSION, (int)sizeof(z_stream))
1800 # define inflateInit2(strm, windowBits) \
1801 inflateInit2_((strm), (windowBits), ZLIB_VERSION, \
1802 (int)sizeof(z_stream))
1803 # define inflateBackInit(strm, windowBits, window) \
1804 inflateBackInit_((strm), (windowBits), (window), \
1805 ZLIB_VERSION, (int)sizeof(z_stream))
1806 #endif
1660 1807
1661 #ifndef Z_SOLO 1808 #ifndef Z_SOLO
1662 1809
1663 /* gzgetc() macro and its supporting function and exposed data structure. Note 1810 /* gzgetc() macro and its supporting function and exposed data structure. Note
1664 * that the real internal state is much larger than the exposed structure. 1811 * that the real internal state is much larger than the exposed structure.
1665 * This abbreviated structure exposes just enough for the gzgetc() macro. The 1812 * This abbreviated structure exposes just enough for the gzgetc() macro. The
1666 * user should not mess with these exposed elements, since their names or 1813 * user should not mess with these exposed elements, since their names or
1667 * behavior could change in the future, perhaps even capriciously. They can 1814 * behavior could change in the future, perhaps even capriciously. They can
1668 * only be used by the gzgetc() macro. You have been warned. 1815 * only be used by the gzgetc() macro. You have been warned.
1669 */ 1816 */
1670 struct gzFile_s { 1817 struct gzFile_s {
1671 unsigned have; 1818 unsigned have;
1672 unsigned char *next; 1819 unsigned char *next;
1673 z_off64_t pos; 1820 z_off64_t pos;
1674 }; 1821 };
1675 ZEXTERN int ZEXPORT gzgetc_ OF((gzFile file)); /* backward compatibility */ 1822 ZEXTERN int ZEXPORT gzgetc_ OF((gzFile file)); /* backward compatibility */
1676 #ifdef Z_PREFIX_SET 1823 #ifdef Z_PREFIX_SET
1677 # undef z_gzgetc 1824 # undef z_gzgetc
1678 # define z_gzgetc(g) \ 1825 # define z_gzgetc(g) \
1679 ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g)) 1826 ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : (gzgetc)(g))
1680 #else 1827 #elif defined(Z_CR_PREFIX_SET)
1681 # ifdef MOZZCONF_H
1682 # undef gzgetc 1828 # undef gzgetc
1683 # define gzgetc(g) \ 1829 # define gzgetc(g) \
1684 ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : MOZ_Z_gzgetc( g)) 1830 ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) \
1685 # else 1831 : (Cr_z_gzgetc)(g))
1686 # define gzgetc(g) \ 1832 #else
1687 ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : gzgetc(g)) 1833 # define gzgetc(g) \
1688 # endif 1834 ((g)->have ? ((g)->have--, (g)->pos++, *((g)->next)++) : (gzgetc)(g))
1689 #endif 1835 #endif
1690 1836
1691 /* provide 64-bit offset functions if _LARGEFILE64_SOURCE defined, and/or 1837 /* provide 64-bit offset functions if _LARGEFILE64_SOURCE defined, and/or
1692 * change the regular functions to 64 bits if _FILE_OFFSET_BITS is 64 (if 1838 * change the regular functions to 64 bits if _FILE_OFFSET_BITS is 64 (if
1693 * both are true, the application gets the *64 functions, and the regular 1839 * both are true, the application gets the *64 functions, and the regular
1694 * functions are changed to 64 bits) -- in case these are set on systems 1840 * functions are changed to 64 bits) -- in case these are set on systems
1695 * without large file support, _LFS64_LARGEFILE must also be true 1841 * without large file support, _LFS64_LARGEFILE must also be true
1696 */ 1842 */
1697 #ifdef Z_LARGE64 1843 #ifdef Z_LARGE64
1698 ZEXTERN gzFile ZEXPORT gzopen64 OF((const char *, const char *)); 1844 ZEXTERN gzFile ZEXPORT gzopen64 OF((const char *, const char *));
(...skipping 55 matching lines...) Expand 10 before | Expand all | Expand 10 after
1754 ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t)); 1900 ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t));
1755 #endif 1901 #endif
1756 1902
1757 #else /* Z_SOLO */ 1903 #else /* Z_SOLO */
1758 1904
1759 ZEXTERN uLong ZEXPORT adler32_combine OF((uLong, uLong, z_off_t)); 1905 ZEXTERN uLong ZEXPORT adler32_combine OF((uLong, uLong, z_off_t));
1760 ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t)); 1906 ZEXTERN uLong ZEXPORT crc32_combine OF((uLong, uLong, z_off_t));
1761 1907
1762 #endif /* !Z_SOLO */ 1908 #endif /* !Z_SOLO */
1763 1909
1764 /* hack for buggy compilers */
1765 #if !defined(ZUTIL_H) && !defined(NO_DUMMY_DECL)
1766 struct internal_state {int dummy;};
1767 #endif
1768
1769 /* undocumented functions */ 1910 /* undocumented functions */
1770 ZEXTERN const char * ZEXPORT zError OF((int)); 1911 ZEXTERN const char * ZEXPORT zError OF((int));
1771 ZEXTERN int ZEXPORT inflateSyncPoint OF((z_streamp)); 1912 ZEXTERN int ZEXPORT inflateSyncPoint OF((z_streamp));
1772 ZEXTERN const z_crc_t FAR * ZEXPORT get_crc_table OF((void)); 1913 ZEXTERN const z_crc_t FAR * ZEXPORT get_crc_table OF((void));
1773 ZEXTERN int ZEXPORT inflateUndermine OF((z_streamp, int)); 1914 ZEXTERN int ZEXPORT inflateUndermine OF((z_streamp, int));
1915 ZEXTERN int ZEXPORT inflateValidate OF((z_streamp, int));
1916 ZEXTERN unsigned long ZEXPORT inflateCodesUsed OF ((z_streamp));
1774 ZEXTERN int ZEXPORT inflateResetKeep OF((z_streamp)); 1917 ZEXTERN int ZEXPORT inflateResetKeep OF((z_streamp));
1775 ZEXTERN int ZEXPORT deflateResetKeep OF((z_streamp)); 1918 ZEXTERN int ZEXPORT deflateResetKeep OF((z_streamp));
1776 #if defined(_WIN32) && !defined(Z_SOLO) 1919 #if (defined(_WIN32) || defined(__CYGWIN__)) && !defined(Z_SOLO)
1777 ZEXTERN gzFile ZEXPORT gzopen_w OF((const wchar_t *path, 1920 ZEXTERN gzFile ZEXPORT gzopen_w OF((const wchar_t *path,
1778 const char *mode)); 1921 const char *mode));
1779 #endif 1922 #endif
1780 #if defined(STDC) || defined(Z_HAVE_STDARG_H) 1923 #if defined(STDC) || defined(Z_HAVE_STDARG_H)
1781 # ifndef Z_SOLO 1924 # ifndef Z_SOLO
1782 ZEXTERN int ZEXPORTVA gzvprintf Z_ARG((gzFile file, 1925 ZEXTERN int ZEXPORTVA gzvprintf Z_ARG((gzFile file,
1783 const char *format, 1926 const char *format,
1784 va_list va)); 1927 va_list va));
1785 # endif 1928 # endif
1786 #endif 1929 #endif
1787 1930
1788 #ifdef __cplusplus 1931 #ifdef __cplusplus
1789 } 1932 }
1790 #endif 1933 #endif
1791 1934
1792 #endif /* ZLIB_H */ 1935 #endif /* ZLIB_H */
OLDNEW
« no previous file with comments | « third_party/zlib/zconf.h ('k') | third_party/zlib/zutil.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698