xref: /third_party/zlib/zutil.h (revision 275793ea) 
1/* zutil.h -- internal interface and configuration of the compression library
2 * Copyright (C) 1995-2024 Jean-loup Gailly, Mark Adler
3 * 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
16#ifdef HAVE_HIDDEN
17#  define ZLIB_INTERNAL __attribute__((visibility ("hidden")))
18#else
19#  define ZLIB_INTERNAL
20#endif
21
22#include "zlib.h"
23
24#if defined(STDC) && !defined(Z_SOLO)
25#  if !(defined(_WIN32_WCE) && defined(_MSC_VER))
26#    include <stddef.h>
27#  endif
28#  include <string.h>
29#  include <stdlib.h>
30#endif
31
32#ifndef local
33#  define local static
34#endif
35/* since "static" is used to mean two completely different things in C, we
36   define "local" for the non-static meaning of "static", for readability
37   (compile with -Dlocal if your debugger can't find static symbols) */
38
39typedef unsigned char  uch;
40typedef uch FAR uchf;
41typedef unsigned short ush;
42typedef ush FAR ushf;
43typedef unsigned long  ulg;
44
45#if !defined(Z_U8) && !defined(Z_SOLO) && defined(STDC)
46#  include <limits.h>
47#  if (ULONG_MAX == 0xffffffffffffffff)
48#    define Z_U8 unsigned long
49#  elif (ULLONG_MAX == 0xffffffffffffffff)
50#    define Z_U8 unsigned long long
51#  elif (UINT_MAX == 0xffffffffffffffff)
52#    define Z_U8 unsigned
53#  endif
54#endif
55
56extern z_const char * const z_errmsg[10]; /* indexed by 2-zlib_error */
57/* (size given to avoid silly warnings with Visual C++) */
58
59#define ERR_MSG(err) z_errmsg[(err) < -6 || (err) > 2 ? 9 : 2 - (err)]
60
61#define ERR_RETURN(strm,err) \
62  return (strm->msg = ERR_MSG(err), (err))
63/* To be used only when the state is known to be valid */
64
65        /* common constants */
66
67#ifndef DEF_WBITS
68#  define DEF_WBITS MAX_WBITS
69#endif
70/* default windowBits for decompression. MAX_WBITS is for compression only */
71
72#if MAX_MEM_LEVEL >= 8
73#  define DEF_MEM_LEVEL 8
74#else
75#  define DEF_MEM_LEVEL  MAX_MEM_LEVEL
76#endif
77/* default memLevel */
78
79#define STORED_BLOCK 0
80#define STATIC_TREES 1
81#define DYN_TREES    2
82/* The three kinds of block type */
83
84#define MIN_MATCH  3
85#define MAX_MATCH  258
86/* The minimum and maximum match lengths */
87
88#define PRESET_DICT 0x20 /* preset dictionary flag in zlib header */
89
90        /* target dependencies */
91
92#if defined(MSDOS) || (defined(WINDOWS) && !defined(WIN32))
93#  define OS_CODE  0x00
94#  ifndef Z_SOLO
95#    if defined(__TURBOC__) || defined(__BORLANDC__)
96#      if (__STDC__ == 1) && (defined(__LARGE__) || defined(__COMPACT__))
97         /* Allow compilation with ANSI keywords only enabled */
98         void _Cdecl farfree( void *block );
99         void *_Cdecl farmalloc( unsigned long nbytes );
100#      else
101#        include <alloc.h>
102#      endif
103#    else /* MSC or DJGPP */
104#      include <malloc.h>
105#    endif
106#  endif
107#endif
108
109#ifdef AMIGA
110#  define OS_CODE  1
111#endif
112
113#if defined(VAXC) || defined(VMS)
114#  define OS_CODE  2
115#  define F_OPEN(name, mode) \
116     fopen((name), (mode), "mbc=60", "ctx=stm", "rfm=fix", "mrs=512")
117#endif
118
119#ifdef __370__
120#  if __TARGET_LIB__ < 0x20000000
121#    define OS_CODE 4
122#  elif __TARGET_LIB__ < 0x40000000
123#    define OS_CODE 11
124#  else
125#    define OS_CODE 8
126#  endif
127#endif
128
129#if defined(ATARI) || defined(atarist)
130#  define OS_CODE  5
131#endif
132
133#ifdef OS2
134#  define OS_CODE  6
135#  if defined(M_I86) && !defined(Z_SOLO)
136#    include <malloc.h>
137#  endif
138#endif
139
140#if defined(MACOS)
141#  define OS_CODE  7
142#endif
143
144#ifdef __acorn
145#  define OS_CODE 13
146#endif
147
148#if defined(WIN32) && !defined(__CYGWIN__)
149#  define OS_CODE  10
150#endif
151
152#ifdef _BEOS_
153#  define OS_CODE  16
154#endif
155
156#ifdef __TOS_OS400__
157#  define OS_CODE 18
158#endif
159
160#ifdef __APPLE__
161#  define OS_CODE 19
162#endif
163
164#if defined(__BORLANDC__) && !defined(MSDOS)
165  #pragma warn -8004
166  #pragma warn -8008
167  #pragma warn -8066
168#endif
169
170/* provide prototypes for these when building zlib without LFS */
171#if !defined(_WIN32) && \
172    (!defined(_LARGEFILE64_SOURCE) || _LFS64_LARGEFILE-0 == 0)
173    ZEXTERN uLong ZEXPORT adler32_combine64(uLong, uLong, z_off_t);
174    ZEXTERN uLong ZEXPORT crc32_combine64(uLong, uLong, z_off_t);
175    ZEXTERN uLong ZEXPORT crc32_combine_gen64(z_off_t);
176#endif
177
178        /* common defaults */
179
180#ifndef OS_CODE
181#  define OS_CODE  3     /* assume Unix */
182#endif
183
184#ifndef F_OPEN
185#  define F_OPEN(name, mode) fopen((name), (mode))
186#endif
187
188         /* functions */
189
190#if defined(pyr) || defined(Z_SOLO)
191#  define NO_MEMCPY
192#endif
193#if defined(SMALL_MEDIUM) && !defined(_MSC_VER) && !defined(__SC__)
194 /* Use our own functions for small and medium model with MSC <= 5.0.
195  * You may have to use the same strategy for Borland C (untested).
196  * The __SC__ check is for Symantec.
197  */
198#  define NO_MEMCPY
199#endif
200#if defined(STDC) && !defined(HAVE_MEMCPY) && !defined(NO_MEMCPY)
201#  define HAVE_MEMCPY
202#endif
203#ifdef HAVE_MEMCPY
204#  ifdef SMALL_MEDIUM /* MSDOS small or medium model */
205#    define zmemcpy _fmemcpy
206#    define zmemcmp _fmemcmp
207#    define zmemzero(dest, len) _fmemset(dest, 0, len)
208#  else
209#    define zmemcpy memcpy
210#    define zmemcmp memcmp
211#    define zmemzero(dest, len) memset(dest, 0, len)
212#  endif
213#else
214   void ZLIB_INTERNAL zmemcpy(Bytef* dest, const Bytef* source, uInt len);
215   int ZLIB_INTERNAL zmemcmp(const Bytef* s1, const Bytef* s2, uInt len);
216   void ZLIB_INTERNAL zmemzero(Bytef* dest, uInt len);
217#endif
218
219/* Diagnostic functions */
220#ifdef ZLIB_DEBUG
221#  include <stdio.h>
222   extern int ZLIB_INTERNAL z_verbose;
223   extern void ZLIB_INTERNAL z_error(char *m);
224#  define Assert(cond,msg) {if(!(cond)) z_error(msg);}
225#  define Trace(x) {if (z_verbose>=0) fprintf x ;}
226#  define Tracev(x) {if (z_verbose>0) fprintf x ;}
227#  define Tracevv(x) {if (z_verbose>1) fprintf x ;}
228#  define Tracec(c,x) {if (z_verbose>0 && (c)) fprintf x ;}
229#  define Tracecv(c,x) {if (z_verbose>1 && (c)) fprintf x ;}
230#else
231#  define Assert(cond,msg)
232#  define Trace(x)
233#  define Tracev(x)
234#  define Tracevv(x)
235#  define Tracec(c,x)
236#  define Tracecv(c,x)
237#endif
238
239#ifndef Z_SOLO
240   voidpf ZLIB_INTERNAL zcalloc(voidpf opaque, unsigned items,
241                                unsigned size);
242   void ZLIB_INTERNAL zcfree(voidpf opaque, voidpf ptr);
243#endif
244
245#define ZALLOC(strm, items, size) \
246           (*((strm)->zalloc))((strm)->opaque, (items), (size))
247#define ZFREE(strm, addr)  (*((strm)->zfree))((strm)->opaque, (voidpf)(addr))
248#define TRY_FREE(s, p) {if (p) ZFREE(s, p);}
249
250/* Reverse the bytes in a 32-bit value */
251#define ZSWAP32(q) ((((q) >> 24) & 0xff) + (((q) >> 8) & 0xff00) + \
252                    (((q) & 0xff00) << 8) + (((q) & 0xff) << 24))
253
254#endif /* ZUTIL_H */
255