Fix copyright.
[rsync/rsync.git] / zlib / zutil.h
1 /* zutil.h -- internal interface and configuration of the compression library
2  * Copyright (C) 1995-2002 Jean-loup Gailly.
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 _Z_UTIL_H
14 #define _Z_UTIL_H
15
16 #include "../rsync.h"
17 #include "zlib.h"
18
19 #if 0
20 #ifdef STDC
21 #  include <stddef.h>
22 #  include <string.h>
23 #  include <stdlib.h>
24 #endif
25 #ifdef NO_ERRNO_H
26     extern int errno;
27 #else
28 #   include <errno.h>
29 #endif
30 #endif
31
32 #ifndef local
33 #  define local static
34 #endif
35 /* compile with -Dlocal if your debugger can't find static symbols */
36
37 typedef unsigned char  uch;
38 typedef uch FAR uchf;
39 typedef unsigned short ush;
40 typedef ush FAR ushf;
41 typedef unsigned long  ulg;
42
43 extern const char *z_errmsg[10]; /* indexed by 2-zlib_error */
44 /* (size given to avoid silly warnings with Visual C++) */
45
46 #define ERR_MSG(err) z_errmsg[Z_NEED_DICT-(err)]
47
48 #define ERR_RETURN(strm,err) \
49   return (strm->msg = (char*)ERR_MSG(err), (err))
50 /* To be used only when the state is known to be valid */
51
52         /* common constants */
53
54 #ifndef DEF_WBITS
55 #  define DEF_WBITS MAX_WBITS
56 #endif
57 /* default windowBits for decompression. MAX_WBITS is for compression only */
58
59 #if MAX_MEM_LEVEL >= 8
60 #  define DEF_MEM_LEVEL 8
61 #else
62 #  define DEF_MEM_LEVEL  MAX_MEM_LEVEL
63 #endif
64 /* default memLevel */
65
66 #define STORED_BLOCK 0
67 #define STATIC_TREES 1
68 #define DYN_TREES    2
69 /* The three kinds of block type */
70
71 #define MIN_MATCH  3
72 #define MAX_MATCH  258
73 /* The minimum and maximum match lengths */
74
75 #define PRESET_DICT 0x20 /* preset dictionary flag in zlib header */
76
77         /* target dependencies */
78
79 #ifdef MSDOS
80 #  define OS_CODE  0x00
81 #  if defined(__TURBOC__) || defined(__BORLANDC__)
82 #    if(__STDC__ == 1) && (defined(__LARGE__) || defined(__COMPACT__))
83        /* Allow compilation with ANSI keywords only enabled */
84        void _Cdecl farfree( void *block );
85        void *_Cdecl farmalloc( unsigned long nbytes );
86 #    else
87 #     include <alloc.h>
88 #    endif
89 #  else /* MSC or DJGPP */
90 #    include <malloc.h>
91 #  endif
92 #endif
93
94 #ifdef OS2
95 #  define OS_CODE  0x06
96 #endif
97
98 #ifdef WIN32 /* Window 95 & Windows NT */
99 #  define OS_CODE  0x0b
100 #endif
101
102 #if defined(VAXC) || defined(VMS)
103 #  define OS_CODE  0x02
104 #  define F_OPEN(name, mode) \
105      fopen((name), (mode), "mbc=60", "ctx=stm", "rfm=fix", "mrs=512")
106 #endif
107
108 #ifdef AMIGA
109 #  define OS_CODE  0x01
110 #endif
111
112 #if defined(ATARI) || defined(atarist)
113 #  define OS_CODE  0x05
114 #endif
115
116 #if defined(MACOS) || defined(TARGET_OS_MAC)
117 #  define OS_CODE  0x07
118 #  if defined(__MWERKS__) && __dest_os != __be_os && __dest_os != __win32_os
119 #    include <unix.h> /* for fdopen */
120 #  else
121 #    ifndef fdopen
122 #      define fdopen(fd,mode) NULL /* No fdopen() */
123 #    endif
124 #  endif
125 #endif
126
127 #ifdef __50SERIES /* Prime/PRIMOS */
128 #  define OS_CODE  0x0F
129 #endif
130
131 #ifdef TOPS20
132 #  define OS_CODE  0x0a
133 #endif
134
135 #if defined(_BEOS_) || defined(RISCOS)
136 #  define fdopen(fd,mode) NULL /* No fdopen() */
137 #endif
138
139 #if (defined(_MSC_VER) && (_MSC_VER > 600))
140 #  define fdopen(fd,type)  _fdopen(fd,type)
141 #endif
142
143
144         /* Common defaults */
145
146 #ifndef OS_CODE
147 #  define OS_CODE  0x03  /* assume Unix */
148 #endif
149
150 #ifndef F_OPEN
151 #  define F_OPEN(name, mode) fopen((name), (mode))
152 #endif
153
154          /* functions */
155
156 #ifdef HAVE_STRERROR
157    extern char *strerror OF((int));
158 #  define zstrerror(errnum) strerror(errnum)
159 #else
160 #  define zstrerror(errnum) ""
161 #endif
162
163 #if defined(pyr)
164 #  define NO_MEMCPY
165 #endif
166 #if defined(SMALL_MEDIUM) && !defined(_MSC_VER) && !defined(__SC__)
167  /* Use our own functions for small and medium model with MSC <= 5.0.
168   * You may have to use the same strategy for Borland C (untested).
169   * The __SC__ check is for Symantec.
170   */
171 #  define NO_MEMCPY
172 #endif
173 #if defined(STDC) && !defined(HAVE_MEMCPY) && !defined(NO_MEMCPY)
174 #  define HAVE_MEMCPY
175 #endif
176 #ifdef HAVE_MEMCPY
177 #  ifdef SMALL_MEDIUM /* MSDOS small or medium model */
178 #    define zmemcpy _fmemcpy
179 #    define zmemcmp _fmemcmp
180 #    define zmemzero(dest, len) _fmemset(dest, 0, len)
181 #  else
182 #    define zmemcpy memcpy
183 #    define zmemcmp memcmp
184 #    define zmemzero(dest, len) memset(dest, 0, len)
185 #  endif
186 #else
187    extern void zmemcpy  OF((Bytef* dest, const Bytef* source, uInt len));
188    extern int  zmemcmp  OF((const Bytef* s1, const Bytef* s2, uInt len));
189    extern void zmemzero OF((Bytef* dest, uInt len));
190 #endif
191
192 /* Diagnostic functions */
193 #ifdef DEBUG
194 #  include <stdio.h>
195    extern int z_verbose;
196    extern void z_error    OF((char *m));
197 #  define Assert(cond,msg) {if(!(cond)) z_error(msg);}
198 #  define Trace(x) {if (z_verbose>=0) fprintf x ;}
199 #  define Tracev(x) {if (z_verbose>0) fprintf x ;}
200 #  define Tracevv(x) {if (z_verbose>1) fprintf x ;}
201 #  define Tracec(c,x) {if (z_verbose>0 && (c)) fprintf x ;}
202 #  define Tracecv(c,x) {if (z_verbose>1 && (c)) fprintf x ;}
203 #else
204 #  define Assert(cond,msg)
205 #  define Trace(x)
206 #  define Tracev(x)
207 #  define Tracevv(x)
208 #  define Tracec(c,x)
209 #  define Tracecv(c,x)
210 #endif
211
212
213 typedef uLong (ZEXPORT *check_func) OF((uLong check, const Bytef *buf,
214                                        uInt len));
215 voidpf zcalloc OF((voidpf opaque, unsigned items, unsigned size));
216 void   zcfree  OF((voidpf opaque, voidpf ptr));
217
218 #define ZALLOC(strm, items, size) \
219            (*((strm)->zalloc))((strm)->opaque, (items), (size))
220 #define ZFREE(strm, addr)  (*((strm)->zfree))((strm)->opaque, (voidpf)(addr))
221 #define TRY_FREE(s, p) {if (p) ZFREE(s, p);}
222
223 #endif /* _Z_UTIL_H */