blob: b079ea6a80f5abd23a6b2451d6eaee50ceda969b [file] [log] [blame]
Martin v. Löwisd372aa82006-01-03 06:44:59 +00001/* zutil.h -- internal interface and configuration of the compression library
doko@ubuntu.com34e7e2e2017-01-31 13:49:48 +01002 * Copyright (C) 1995-2016 Jean-loup Gailly, Mark Adler
Martin v. Löwisd372aa82006-01-03 06:44:59 +00003 * For conditions of distribution and use, see copyright notice in zlib.h
4 */
5
6/* WARNING: this file should *not* be used by applications. It is
7 part of the implementation of the compression library and is
8 subject to change. Applications should only use zlib.h.
9 */
10
11/* @(#) $Id$ */
12
13#ifndef ZUTIL_H
14#define ZUTIL_H
15
Christian Heimesc20bcde2013-10-21 12:03:09 +020016#ifdef HAVE_HIDDEN
Martin v. Löwisce126ed2010-07-30 20:03:17 +000017# define ZLIB_INTERNAL __attribute__((visibility ("hidden")))
18#else
19# define ZLIB_INTERNAL
20#endif
21
Martin v. Löwisd372aa82006-01-03 06:44:59 +000022#include "zlib.h"
23
Christian Heimesc20bcde2013-10-21 12:03:09 +020024#if defined(STDC) && !defined(Z_SOLO)
Martin v. Löwisce126ed2010-07-30 20:03:17 +000025# if !(defined(_WIN32_WCE) && defined(_MSC_VER))
Martin v. Löwisd372aa82006-01-03 06:44:59 +000026# include <stddef.h>
27# endif
28# include <string.h>
29# include <stdlib.h>
30#endif
Martin v. Löwisd372aa82006-01-03 06:44:59 +000031
Christian Heimesc20bcde2013-10-21 12:03:09 +020032#ifdef Z_SOLO
33 typedef long ptrdiff_t; /* guess -- will be caught if guess is wrong */
34#endif
35
Martin v. Löwisd372aa82006-01-03 06:44:59 +000036#ifndef local
37# define local static
38#endif
doko@ubuntu.com34e7e2e2017-01-31 13:49:48 +010039/* since "static" is used to mean two completely different things in C, we
40 define "local" for the non-static meaning of "static", for readability
41 (compile with -Dlocal if your debugger can't find static symbols) */
Martin v. Löwisd372aa82006-01-03 06:44:59 +000042
43typedef unsigned char uch;
44typedef uch FAR uchf;
45typedef unsigned short ush;
46typedef ush FAR ushf;
47typedef unsigned long ulg;
48
Christian Heimesc20bcde2013-10-21 12:03:09 +020049extern z_const char * const z_errmsg[10]; /* indexed by 2-zlib_error */
Martin v. Löwisd372aa82006-01-03 06:44:59 +000050/* (size given to avoid silly warnings with Visual C++) */
51
52#define ERR_MSG(err) z_errmsg[Z_NEED_DICT-(err)]
53
54#define ERR_RETURN(strm,err) \
Christian Heimesc20bcde2013-10-21 12:03:09 +020055 return (strm->msg = ERR_MSG(err), (err))
Martin v. Löwisd372aa82006-01-03 06:44:59 +000056/* To be used only when the state is known to be valid */
57
58 /* common constants */
59
60#ifndef DEF_WBITS
61# define DEF_WBITS MAX_WBITS
62#endif
63/* default windowBits for decompression. MAX_WBITS is for compression only */
64
65#if MAX_MEM_LEVEL >= 8
66# define DEF_MEM_LEVEL 8
67#else
68# define DEF_MEM_LEVEL MAX_MEM_LEVEL
69#endif
70/* default memLevel */
71
72#define STORED_BLOCK 0
73#define STATIC_TREES 1
74#define DYN_TREES 2
75/* The three kinds of block type */
76
77#define MIN_MATCH 3
78#define MAX_MATCH 258
79/* The minimum and maximum match lengths */
80
81#define PRESET_DICT 0x20 /* preset dictionary flag in zlib header */
82
83 /* target dependencies */
84
85#if defined(MSDOS) || (defined(WINDOWS) && !defined(WIN32))
86# define OS_CODE 0x00
Christian Heimesc20bcde2013-10-21 12:03:09 +020087# ifndef Z_SOLO
88# if defined(__TURBOC__) || defined(__BORLANDC__)
89# if (__STDC__ == 1) && (defined(__LARGE__) || defined(__COMPACT__))
90 /* Allow compilation with ANSI keywords only enabled */
91 void _Cdecl farfree( void *block );
92 void *_Cdecl farmalloc( unsigned long nbytes );
93# else
94# include <alloc.h>
95# endif
96# else /* MSC or DJGPP */
97# include <malloc.h>
Martin v. Löwisd372aa82006-01-03 06:44:59 +000098# endif
Martin v. Löwisd372aa82006-01-03 06:44:59 +000099# endif
100#endif
101
102#ifdef AMIGA
doko@ubuntu.com34e7e2e2017-01-31 13:49:48 +0100103# define OS_CODE 1
Martin v. Löwisd372aa82006-01-03 06:44:59 +0000104#endif
105
106#if defined(VAXC) || defined(VMS)
doko@ubuntu.com34e7e2e2017-01-31 13:49:48 +0100107# define OS_CODE 2
Martin v. Löwisd372aa82006-01-03 06:44:59 +0000108# define F_OPEN(name, mode) \
109 fopen((name), (mode), "mbc=60", "ctx=stm", "rfm=fix", "mrs=512")
110#endif
111
doko@ubuntu.com34e7e2e2017-01-31 13:49:48 +0100112#ifdef __370__
113# if __TARGET_LIB__ < 0x20000000
114# define OS_CODE 4
115# elif __TARGET_LIB__ < 0x40000000
116# define OS_CODE 11
117# else
118# define OS_CODE 8
119# endif
120#endif
121
Martin v. Löwisd372aa82006-01-03 06:44:59 +0000122#if defined(ATARI) || defined(atarist)
doko@ubuntu.com34e7e2e2017-01-31 13:49:48 +0100123# define OS_CODE 5
Martin v. Löwisd372aa82006-01-03 06:44:59 +0000124#endif
125
126#ifdef OS2
doko@ubuntu.com34e7e2e2017-01-31 13:49:48 +0100127# define OS_CODE 6
Christian Heimesc20bcde2013-10-21 12:03:09 +0200128# if defined(M_I86) && !defined(Z_SOLO)
Martin v. Löwisce126ed2010-07-30 20:03:17 +0000129# include <malloc.h>
Martin v. Löwisd372aa82006-01-03 06:44:59 +0000130# endif
131#endif
132
133#if defined(MACOS) || defined(TARGET_OS_MAC)
doko@ubuntu.com34e7e2e2017-01-31 13:49:48 +0100134# define OS_CODE 7
Christian Heimesc20bcde2013-10-21 12:03:09 +0200135# ifndef Z_SOLO
136# if defined(__MWERKS__) && __dest_os != __be_os && __dest_os != __win32_os
137# include <unix.h> /* for fdopen */
138# else
139# ifndef fdopen
140# define fdopen(fd,mode) NULL /* No fdopen() */
141# endif
Martin v. Löwisd372aa82006-01-03 06:44:59 +0000142# endif
143# endif
144#endif
145
doko@ubuntu.com34e7e2e2017-01-31 13:49:48 +0100146#ifdef __acorn
147# define OS_CODE 13
Martin v. Löwisd372aa82006-01-03 06:44:59 +0000148#endif
149
doko@ubuntu.com34e7e2e2017-01-31 13:49:48 +0100150#if defined(WIN32) && !defined(__CYGWIN__)
151# define OS_CODE 10
Martin v. Löwisd372aa82006-01-03 06:44:59 +0000152#endif
153
doko@ubuntu.com34e7e2e2017-01-31 13:49:48 +0100154#ifdef _BEOS_
155# define OS_CODE 16
156#endif
157
158#ifdef __TOS_OS400__
159# define OS_CODE 18
160#endif
161
162#ifdef __APPLE__
163# define OS_CODE 19
Martin v. Löwisd372aa82006-01-03 06:44:59 +0000164#endif
165
Martin v. Löwisce126ed2010-07-30 20:03:17 +0000166#if defined(_BEOS_) || defined(RISCOS)
Martin v. Löwisd372aa82006-01-03 06:44:59 +0000167# define fdopen(fd,mode) NULL /* No fdopen() */
168#endif
169
Martin v. Löwisce126ed2010-07-30 20:03:17 +0000170#if (defined(_MSC_VER) && (_MSC_VER > 600)) && !defined __INTERIX
Martin v. Löwisd372aa82006-01-03 06:44:59 +0000171# if defined(_WIN32_WCE)
172# define fdopen(fd,mode) NULL /* No fdopen() */
173# ifndef _PTRDIFF_T_DEFINED
174 typedef int ptrdiff_t;
175# define _PTRDIFF_T_DEFINED
176# endif
177# else
178# define fdopen(fd,type) _fdopen(fd,type)
179# endif
180#endif
181
Christian Heimesc20bcde2013-10-21 12:03:09 +0200182#if defined(__BORLANDC__) && !defined(MSDOS)
Martin v. Löwisce126ed2010-07-30 20:03:17 +0000183 #pragma warn -8004
184 #pragma warn -8008
185 #pragma warn -8066
186#endif
187
188/* provide prototypes for these when building zlib without LFS */
Christian Heimesc20bcde2013-10-21 12:03:09 +0200189#if !defined(_WIN32) && \
190 (!defined(_LARGEFILE64_SOURCE) || _LFS64_LARGEFILE-0 == 0)
Martin v. Löwisce126ed2010-07-30 20:03:17 +0000191 ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, z_off_t));
192 ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, z_off_t));
193#endif
194
Martin v. Löwisd372aa82006-01-03 06:44:59 +0000195 /* common defaults */
196
197#ifndef OS_CODE
doko@ubuntu.com34e7e2e2017-01-31 13:49:48 +0100198# define OS_CODE 3 /* assume Unix */
Martin v. Löwisd372aa82006-01-03 06:44:59 +0000199#endif
200
201#ifndef F_OPEN
202# define F_OPEN(name, mode) fopen((name), (mode))
203#endif
204
205 /* functions */
206
Christian Heimesc20bcde2013-10-21 12:03:09 +0200207#if defined(pyr) || defined(Z_SOLO)
Martin v. Löwisd372aa82006-01-03 06:44:59 +0000208# define NO_MEMCPY
209#endif
210#if defined(SMALL_MEDIUM) && !defined(_MSC_VER) && !defined(__SC__)
211 /* Use our own functions for small and medium model with MSC <= 5.0.
212 * You may have to use the same strategy for Borland C (untested).
213 * The __SC__ check is for Symantec.
214 */
215# define NO_MEMCPY
216#endif
217#if defined(STDC) && !defined(HAVE_MEMCPY) && !defined(NO_MEMCPY)
218# define HAVE_MEMCPY
219#endif
220#ifdef HAVE_MEMCPY
221# ifdef SMALL_MEDIUM /* MSDOS small or medium model */
222# define zmemcpy _fmemcpy
223# define zmemcmp _fmemcmp
224# define zmemzero(dest, len) _fmemset(dest, 0, len)
225# else
226# define zmemcpy memcpy
227# define zmemcmp memcmp
228# define zmemzero(dest, len) memset(dest, 0, len)
229# endif
230#else
Martin v. Löwisce126ed2010-07-30 20:03:17 +0000231 void ZLIB_INTERNAL zmemcpy OF((Bytef* dest, const Bytef* source, uInt len));
232 int ZLIB_INTERNAL zmemcmp OF((const Bytef* s1, const Bytef* s2, uInt len));
233 void ZLIB_INTERNAL zmemzero OF((Bytef* dest, uInt len));
Martin v. Löwisd372aa82006-01-03 06:44:59 +0000234#endif
235
236/* Diagnostic functions */
doko@ubuntu.com34e7e2e2017-01-31 13:49:48 +0100237#ifdef ZLIB_DEBUG
Martin v. Löwisd372aa82006-01-03 06:44:59 +0000238# include <stdio.h>
Martin v. Löwisce126ed2010-07-30 20:03:17 +0000239 extern int ZLIB_INTERNAL z_verbose;
240 extern void ZLIB_INTERNAL z_error OF((char *m));
Martin v. Löwisd372aa82006-01-03 06:44:59 +0000241# define Assert(cond,msg) {if(!(cond)) z_error(msg);}
242# define Trace(x) {if (z_verbose>=0) fprintf x ;}
243# define Tracev(x) {if (z_verbose>0) fprintf x ;}
244# define Tracevv(x) {if (z_verbose>1) fprintf x ;}
245# define Tracec(c,x) {if (z_verbose>0 && (c)) fprintf x ;}
246# define Tracecv(c,x) {if (z_verbose>1 && (c)) fprintf x ;}
247#else
248# define Assert(cond,msg)
249# define Trace(x)
250# define Tracev(x)
251# define Tracevv(x)
252# define Tracec(c,x)
253# define Tracecv(c,x)
254#endif
255
Christian Heimesc20bcde2013-10-21 12:03:09 +0200256#ifndef Z_SOLO
257 voidpf ZLIB_INTERNAL zcalloc OF((voidpf opaque, unsigned items,
258 unsigned size));
259 void ZLIB_INTERNAL zcfree OF((voidpf opaque, voidpf ptr));
260#endif
Martin v. Löwisd372aa82006-01-03 06:44:59 +0000261
262#define ZALLOC(strm, items, size) \
263 (*((strm)->zalloc))((strm)->opaque, (items), (size))
264#define ZFREE(strm, addr) (*((strm)->zfree))((strm)->opaque, (voidpf)(addr))
265#define TRY_FREE(s, p) {if (p) ZFREE(s, p);}
266
Christian Heimesc20bcde2013-10-21 12:03:09 +0200267/* Reverse the bytes in a 32-bit value */
268#define ZSWAP32(q) ((((q) >> 24) & 0xff) + (((q) >> 8) & 0xff00) + \
269 (((q) & 0xff00) << 8) + (((q) & 0xff) << 24))
270
Martin v. Löwisd372aa82006-01-03 06:44:59 +0000271#endif /* ZUTIL_H */