zlib.h File Reference

#include "zconf.h"

Include dependency graph for zlib.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	z_stream_s
struct	gz_header_s
struct	internal_state

Macros
#define	ZLIB_VERSION   "1.2.3"
#define	ZLIB_VERNUM   0x1230
#define	Z_NO_FLUSH   0
#define	Z_PARTIAL_FLUSH   1 /* will be removed, use Z_SYNC_FLUSH instead */
#define	Z_SYNC_FLUSH   2
#define	Z_FULL_FLUSH   3
#define	Z_FINISH   4
#define	Z_BLOCK   5
#define	Z_OK   0
#define	Z_STREAM_END   1
#define	Z_NEED_DICT   2
#define	Z_ERRNO   (-1)
#define	Z_STREAM_ERROR   (-2)
#define	Z_DATA_ERROR   (-3)
#define	Z_MEM_ERROR   (-4)
#define	Z_BUF_ERROR   (-5)
#define	Z_VERSION_ERROR   (-6)
#define	Z_NO_COMPRESSION   0
#define	Z_BEST_SPEED   1
#define	Z_BEST_COMPRESSION   9
#define	Z_DEFAULT_COMPRESSION   (-1)
#define	Z_FILTERED   1
#define	Z_HUFFMAN_ONLY   2
#define	Z_RLE   3
#define	Z_FIXED   4
#define	Z_DEFAULT_STRATEGY   0
#define	Z_BINARY   0
#define	Z_TEXT   1
#define	Z_ASCII   Z_TEXT /* for compatibility with 1.2.2 and earlier */
#define	Z_UNKNOWN   2
#define	Z_DEFLATED   8
#define	Z_NULL   0 /* for initializing zalloc, zfree, opaque */
#define	zlib_version   zlibVersion()
#define	deflateInit(strm, level)   deflateInit_((strm), (level), ZLIB_VERSION, sizeof(z_stream))
#define	inflateInit(strm)   inflateInit_((strm), ZLIB_VERSION, sizeof(z_stream))
#define	deflateInit2(strm, level, method, windowBits, memLevel, strategy)
#define	inflateInit2(strm, windowBits)   inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))
#define	inflateBackInit(strm, windowBits, window)

Typedefs
typedef voidpf alloc_func	OF((voidpf opaque, uInt items, uInt size))
typedef struct z_stream_s	z_stream
typedef z_stream FAR *	z_streamp
typedef struct gz_header_s	gz_header
typedef gz_header FAR *	gz_headerp
typedef voidp	gzFile

Functions
ZEXTERN const char *ZEXPORT zlibVersion	OF ((void))
ZEXTERN int ZEXPORT deflate	OF ((z_streamp strm, int flush))
ZEXTERN int ZEXPORT deflateEnd	OF ((z_streamp strm))
ZEXTERN int ZEXPORT deflateSetDictionary	OF ((z_streamp strm, const Bytef *dictionary, uInt dictLength))
ZEXTERN int ZEXPORT deflateCopy	OF ((z_streamp dest, z_streamp source))
ZEXTERN int ZEXPORT deflateParams	OF ((z_streamp strm, int level, int strategy))
ZEXTERN int ZEXPORT deflateTune	OF ((z_streamp strm, int good_length, int max_lazy, int nice_length, int max_chain))
ZEXTERN uLong ZEXPORT deflateBound	OF ((z_streamp strm, uLong sourceLen))
ZEXTERN int ZEXPORT deflatePrime	OF ((z_streamp strm, int bits, int value))
ZEXTERN int ZEXPORT deflateSetHeader	OF ((z_streamp strm, gz_headerp head))
ZEXTERN int ZEXPORT inflateBack	OF ((z_streamp strm, in_func in, void FAR *in_desc, out_func out, void FAR *out_desc))
ZEXTERN int ZEXPORT compress	OF ((Bytef *dest, uLongf *destLen, const Bytef *source, uLong sourceLen))
ZEXTERN int ZEXPORT compress2	OF ((Bytef *dest, uLongf *destLen, const Bytef *source, uLong sourceLen, int level))
ZEXTERN uLong ZEXPORT compressBound	OF ((uLong sourceLen))
ZEXTERN gzFile ZEXPORT gzopen	OF ((const char *path, const char *mode))
ZEXTERN gzFile ZEXPORT gzdopen	OF ((int fd, const char *mode))
ZEXTERN int ZEXPORT gzsetparams	OF ((gzFile file, int level, int strategy))
ZEXTERN int ZEXPORT gzread	OF ((gzFile file, voidp buf, unsigned len))
ZEXTERN int ZEXPORT gzwrite	OF ((gzFile file, voidpc buf, unsigned len))
ZEXTERN int ZEXPORTVA gzprintf	OF ((gzFile file, const char *format,...))
ZEXTERN int ZEXPORT gzputs	OF ((gzFile file, const char *s))
ZEXTERN char *ZEXPORT gzgets	OF ((gzFile file, char *buf, int len))
ZEXTERN int ZEXPORT gzputc	OF ((gzFile file, int c))
ZEXTERN int ZEXPORT gzgetc	OF ((gzFile file))
ZEXTERN int ZEXPORT gzungetc	OF ((int c, gzFile file))
ZEXTERN int ZEXPORT gzflush	OF ((gzFile file, int flush))
ZEXTERN z_off_t ZEXPORT gzseek	OF ((gzFile file, z_off_t offset, int whence))
ZEXTERN const char *ZEXPORT gzerror	OF ((gzFile file, int *errnum))
ZEXTERN uLong ZEXPORT adler32	OF ((uLong adler, const Bytef *buf, uInt len))
ZEXTERN uLong ZEXPORT adler32_combine	OF ((uLong adler1, uLong adler2, z_off_t len2))
ZEXTERN uLong ZEXPORT crc32	OF ((uLong crc, const Bytef *buf, uInt len))
ZEXTERN uLong ZEXPORT crc32_combine	OF ((uLong crc1, uLong crc2, z_off_t len2))
ZEXTERN int ZEXPORT deflateInit_	OF ((z_streamp strm, int level, const char *version, int stream_size))
ZEXTERN int ZEXPORT inflateInit_	OF ((z_streamp strm, const char *version, int stream_size))
ZEXTERN int ZEXPORT deflateInit2_	OF ((z_streamp strm, int level, int method, int windowBits, int memLevel, int strategy, const char *version, int stream_size))
ZEXTERN int ZEXPORT inflateInit2_	OF ((z_streamp strm, int windowBits, const char *version, int stream_size))
ZEXTERN int ZEXPORT inflateBackInit_	OF ((z_streamp strm, int windowBits, unsigned char FAR *window, const char *version, int stream_size))
ZEXTERN const char *ZEXPORT zError	OF ((int))
ZEXTERN int ZEXPORT inflateSyncPoint	OF ((z_streamp z))

Macro Definition Documentation

deflateInit

#define deflateInit	(		strm,
			level
	)		deflateInit_((strm), (level), ZLIB_VERSION, sizeof(z_stream))

Definition at line 1310 of file zlib.h.

deflateInit2

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

Value:

deflateInit2_((strm),(level),(method),(windowBits),(memLevel),\
                      (strategy),           ZLIB_VERSION, sizeof(z_stream))

Definition at line 1314 of file zlib.h.

inflateBackInit

#define inflateBackInit	(		strm,
			windowBits,
			window
	)

Value:

inflateBackInit_((strm), (windowBits), (window), \
        ZLIB_VERSION, sizeof(z_stream))

Definition at line 1319 of file zlib.h.

inflateInit

#define inflateInit

(

strm

)

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

Definition at line 1312 of file zlib.h.

inflateInit2

#define inflateInit2	(		strm,
			windowBits
	)		inflateInit2_((strm), (windowBits), ZLIB_VERSION, sizeof(z_stream))

Definition at line 1317 of file zlib.h.

Z_ASCII

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

Definition at line 177 of file zlib.h.

Z_BEST_COMPRESSION

#define Z_BEST_COMPRESSION   9

Definition at line 164 of file zlib.h.

Z_BEST_SPEED

#define Z_BEST_SPEED   1

Definition at line 163 of file zlib.h.

Z_BINARY

#define Z_BINARY   0

Definition at line 175 of file zlib.h.

Z_BLOCK

#define Z_BLOCK   5

Definition at line 146 of file zlib.h.

Z_BUF_ERROR

#define Z_BUF_ERROR   (-5)

Definition at line 156 of file zlib.h.

Z_DATA_ERROR

#define Z_DATA_ERROR   (-3)

Definition at line 154 of file zlib.h.

Z_DEFAULT_COMPRESSION

#define Z_DEFAULT_COMPRESSION   (-1)

Definition at line 165 of file zlib.h.

Z_DEFAULT_STRATEGY

#define Z_DEFAULT_STRATEGY   0

Definition at line 172 of file zlib.h.

Z_DEFLATED

#define Z_DEFLATED   8

Definition at line 181 of file zlib.h.

Z_ERRNO

#define Z_ERRNO   (-1)

Definition at line 152 of file zlib.h.

Z_FILTERED

#define Z_FILTERED   1

Definition at line 168 of file zlib.h.

Z_FINISH

#define Z_FINISH   4

Definition at line 145 of file zlib.h.

Z_FIXED

#define Z_FIXED   4

Definition at line 171 of file zlib.h.

Z_FULL_FLUSH

#define Z_FULL_FLUSH   3

Definition at line 144 of file zlib.h.

Z_HUFFMAN_ONLY

#define Z_HUFFMAN_ONLY   2

Definition at line 169 of file zlib.h.

Z_MEM_ERROR

#define Z_MEM_ERROR   (-4)

Definition at line 155 of file zlib.h.

Z_NEED_DICT

#define Z_NEED_DICT   2

Definition at line 151 of file zlib.h.

Z_NO_COMPRESSION

#define Z_NO_COMPRESSION   0

Definition at line 162 of file zlib.h.

Z_NO_FLUSH

#define Z_NO_FLUSH   0

Definition at line 141 of file zlib.h.

Z_NULL

#define Z_NULL   0 /* for initializing zalloc, zfree, opaque */

Definition at line 184 of file zlib.h.

Z_OK

#define Z_OK   0

Definition at line 149 of file zlib.h.

Referenced by mrpt::compress::zip::compress(), and mrpt::compress::zip::decompress().

Z_PARTIAL_FLUSH

#define Z_PARTIAL_FLUSH   1 /* will be removed, use Z_SYNC_FLUSH instead */

Definition at line 142 of file zlib.h.

Z_RLE

#define Z_RLE   3

Definition at line 170 of file zlib.h.

Z_STREAM_END

#define Z_STREAM_END   1

Definition at line 150 of file zlib.h.

Z_STREAM_ERROR

#define Z_STREAM_ERROR   (-2)

Definition at line 153 of file zlib.h.

Z_SYNC_FLUSH

#define Z_SYNC_FLUSH   2

Definition at line 143 of file zlib.h.

Z_TEXT

#define Z_TEXT   1

Definition at line 176 of file zlib.h.

Z_UNKNOWN

#define Z_UNKNOWN   2

Definition at line 178 of file zlib.h.

Z_VERSION_ERROR

#define Z_VERSION_ERROR   (-6)

Definition at line 157 of file zlib.h.

ZLIB_VERNUM

#define ZLIB_VERNUM   0x1230

Definition at line 20 of file zlib.h.

ZLIB_VERSION

#define ZLIB_VERSION   "1.2.3"

Definition at line 19 of file zlib.h.

zlib_version

#define zlib_version   zlibVersion()

Definition at line 186 of file zlib.h.

Typedef Documentation

gz_header

typedef struct gz_header_s gz_header

gz_headerp

typedef gz_header FAR* gz_headerp

Definition at line 105 of file zlib.h.

gzFile

typedef voidp gzFile

Definition at line 1045 of file zlib.h.

OF

ZEXTERN const uLongf *ZEXPORT get_crc_table OF

(

(voidpf opaque, uInt items, uInt size)

)

Definition at line 56 of file zlib.h.

z_stream

typedef struct z_stream_s z_stream

z_streamp

typedef z_stream FAR* z_streamp

Definition at line 82 of file zlib.h.

Function Documentation

OF() [1/39]

ZEXTERN const char* ZEXPORT zlibVersion OF

(

(void)

)

OF() [2/39]

ZEXTERN int ZEXPORT deflate OF

(

(z_streamp strm, int flush)

)

OF() [3/39]

ZEXTERN int ZEXPORT deflateEnd OF

(

(z_streamp strm)

)

OF() [4/39]

ZEXTERN int ZEXPORT deflateSetDictionary OF

(

(z_streamp strm, const Bytef *dictionary, uInt dictLength)

)

OF() [5/39]

ZEXTERN int ZEXPORT deflateCopy OF

(

(z_streamp dest, z_streamp source)

)

OF() [6/39]

ZEXTERN int ZEXPORT deflateParams OF

(

(z_streamp strm, int level, int strategy)

)

OF() [7/39]

ZEXTERN int ZEXPORT deflateTune OF

(

(z_streamp strm, int good_length, int max_lazy, int nice_length, int max_chain)

)

OF() [8/39]

ZEXTERN uLong ZEXPORT deflateBound OF

(

(z_streamp strm, uLong sourceLen)

)

OF() [9/39]

ZEXTERN int ZEXPORT deflatePrime OF

(

(z_streamp strm, int bits, int value)

)

OF() [10/39]

ZEXTERN int ZEXPORT deflateSetHeader OF

(

(z_streamp strm, gz_headerp head)

)

OF() [11/39]

ZEXTERN int ZEXPORT inflateBack OF

(

(z_streamp strm, in_func in, void FAR *in_desc, out_func out, void FAR *out_desc)

)

OF() [12/39]

ZEXTERN int ZEXPORT compress OF

(

(Bytef *dest, uLongf *destLen, const Bytef *source, uLong sourceLen)

)

OF() [13/39]

ZEXTERN int ZEXPORT compress2 OF

(

(Bytef *dest, uLongf *destLen, const Bytef *source, uLong sourceLen, int level)

)

OF() [14/39]

ZEXTERN uLong ZEXPORT compressBound OF

(

(uLong sourceLen)

)

OF() [15/39]

ZEXTERN gzFile ZEXPORT gzopen OF

(

(const char *path, const char *mode)

)

OF() [16/39]

ZEXTERN gzFile ZEXPORT gzdopen OF

(

(int fd, const char *mode)

)

OF() [17/39]

ZEXTERN int ZEXPORT gzsetparams OF

(

(gzFile file, int level, int strategy)

)

OF() [18/39]

ZEXTERN int ZEXPORT gzread OF

(

(gzFile file, voidp buf, unsigned len)

)

OF() [19/39]

ZEXTERN int ZEXPORT gzwrite OF

(

(gzFile file, voidpc buf, unsigned len)

)

OF() [20/39]

ZEXTERN int ZEXPORTVA gzprintf OF

(

(gzFile file, const char *format,...)

)

OF() [21/39]

ZEXTERN int ZEXPORT gzputs OF

(

(gzFile file, const char *s)

)

OF() [22/39]

ZEXTERN char* ZEXPORT gzgets OF

(

(gzFile file, char *buf, int len)

)

OF() [23/39]

ZEXTERN int ZEXPORT gzputc OF

(

(gzFile file, int c)

)

OF() [24/39]

ZEXTERN int ZEXPORT gzgetc OF

(

(gzFile file)

)

OF() [25/39]

ZEXTERN int ZEXPORT gzungetc OF

(

(int c, gzFile file)

)

OF() [26/39]

ZEXTERN int ZEXPORT gzflush OF

(

(gzFile file, int flush)

)

OF() [27/39]

ZEXTERN z_off_t ZEXPORT gzseek OF

(

(gzFile file, z_off_t offset, int whence)

)

OF() [28/39]

ZEXTERN const char* ZEXPORT gzerror OF

(

(gzFile file, int *errnum)

)

OF() [29/39]

ZEXTERN uLong ZEXPORT adler32 OF

(

(uLong adler, const Bytef *buf, uInt len)

)

OF() [30/39]

ZEXTERN uLong ZEXPORT adler32_combine OF

(

(uLong adler1, uLong adler2, z_off_t len2)

)

OF() [31/39]

ZEXTERN uLong ZEXPORT crc32 OF

(

(uLong crc, const Bytef *buf, uInt len)

)

OF() [32/39]

ZEXTERN uLong ZEXPORT crc32_combine OF

(

(uLong crc1, uLong crc2, z_off_t len2)

)

OF() [33/39]

ZEXTERN int ZEXPORT deflateInit_ OF

(

(z_streamp strm, int level, const char *version, int stream_size)

)

OF() [34/39]

ZEXTERN int ZEXPORT inflateInit_ OF

(

(z_streamp strm, const char *version, int stream_size)

)

OF() [35/39]

ZEXTERN int ZEXPORT deflateInit2_ OF

(

(z_streamp strm, int level, int method, int windowBits, int memLevel, int strategy, const char *version, int stream_size)

)

OF() [36/39]

ZEXTERN int ZEXPORT inflateInit2_ OF

(

(z_streamp strm, int windowBits, const char *version, int stream_size)

)

OF() [37/39]

ZEXTERN int ZEXPORT inflateBackInit_ OF

(

(z_streamp strm, int windowBits, unsigned char FAR *window, const char *version, int stream_size)

)

OF() [38/39]

ZEXTERN const char* ZEXPORT zError OF

(

(int)

)

OF() [39/39]

ZEXTERN int ZEXPORT inflateSyncPoint OF

(

(z_streamp z)

)