1 /* gzip.h -- common declarations for all gzip modules
3 Copyright (C) 1997, 1998, 1999, 2001, 2006 Free Software Foundation, Inc.
4 Copyright (C) 1992-1993 Jean-loup Gailly.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software Foundation,
18 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
20 #if defined(__STDC__) || defined(PROTO)
21 # define OF(args) args
33 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 8) || __STRICT_ANSI__
34 # define __attribute__(x)
38 #ifndef ATTRIBUTE_NORETURN
39 # define ATTRIBUTE_NORETURN __attribute__ ((__noreturn__))
42 /* I don't like nested includes, but the following headers are used
46 #include <sys/types.h> /* for off_t, time_t */
47 #if defined HAVE_STRING_H || defined STDC_HEADERS
49 # if !defined STDC_HEADERS && defined HAVE_MEMORY_H && !defined __GNUC__
52 # define memzero(s, n) memset ((voidp)(s), 0, (n))
56 # define strrchr rindex
57 # define memcpy(d, s, n) bcopy((s), (d), (n))
58 # define memcmp(s1, s2, n) bcmp((s1), (s2), (n))
59 # define memzero(s, n) bzero((s), (n))
63 # define RETSIGTYPE void
68 typedef unsigned char uch;
69 typedef unsigned short ush;
70 typedef unsigned long ulg;
72 /* Return codes from gzip */
77 /* Compression methods (see algorithm.doc) */
82 /* methods 4 to 7 reserved */
85 extern int method; /* compression method */
87 /* To save memory for 16 bit systems, some arrays are overlaid between
88 * the various modules:
89 * deflate: prev+head window d_buf l_buf outbuf
90 * unlzw: tab_prefix tab_suffix stack inbuf outbuf
91 * inflate: window inbuf
92 * unpack: window inbuf prefix_len
93 * unlzh: left+right window c_table inbuf c_len
94 * For compression, input is done in window[]. For decompression, output
95 * is done in window except for unlzw.
100 # define INBUFSIZ 0x2000 /* input buffer size */
102 # define INBUFSIZ 0x8000 /* input buffer size */
105 #define INBUF_EXTRA 64 /* required by unlzw() */
109 # define OUTBUFSIZ 8192 /* output buffer size */
111 # define OUTBUFSIZ 16384 /* output buffer size */
114 #define OUTBUF_EXTRA 2048 /* required by unlzw() */
118 # define DIST_BUFSIZE 0x2000 /* buffer for distances, see trees.c */
120 # define DIST_BUFSIZE 0x8000 /* buffer for distances, see trees.c */
125 # define EXTERN(type, array) extern type * near array
126 # define DECLARE(type, array, size) type * near array
127 # define ALLOC(type, array, size) { \
128 array = (type*)fcalloc((size_t)(((size)+1L)/2), 2*sizeof(type)); \
129 if (!array) xalloc_die (); \
131 # define FREE(array) {if (array != NULL) fcfree(array), array=NULL;}
133 # define EXTERN(type, array) extern type array[]
134 # define DECLARE(type, array, size) type array[size]
135 # define ALLOC(type, array, size)
139 EXTERN(uch, inbuf); /* input buffer */
140 EXTERN(uch, outbuf); /* output buffer */
141 EXTERN(ush, d_buf); /* buffer for distances, see trees.c */
142 EXTERN(uch, window); /* Sliding window and suffix table (unlzw) */
143 #define tab_suffix window
145 # define tab_prefix prev /* hash link (see deflate.c) */
146 # define head (prev+WSIZE) /* hash head (see deflate.c) */
147 EXTERN(ush, tab_prefix); /* prefix code (see unlzw.c) */
149 # define tab_prefix0 prev
150 # define head tab_prefix1
151 EXTERN(ush, tab_prefix0); /* prefix for even codes */
152 EXTERN(ush, tab_prefix1); /* prefix for odd codes */
155 extern unsigned insize; /* valid bytes in inbuf */
156 extern unsigned inptr; /* index of next byte to be processed in inbuf */
157 extern unsigned outcnt; /* bytes in output buffer */
158 extern int rsync; /* deflate into rsyncable chunks */
160 extern off_t bytes_in; /* number of input bytes */
161 extern off_t bytes_out; /* number of output bytes */
162 extern off_t header_bytes;/* number of bytes in gzip header */
164 extern int ifd; /* input file descriptor */
165 extern int ofd; /* output file descriptor */
166 extern char ifname[]; /* input file name or "stdin" */
167 extern char ofname[]; /* output file name or "stdout" */
168 extern char *program_name; /* program name */
170 extern struct timespec time_stamp; /* original time stamp (modification time) */
171 extern off_t ifile_size; /* input file size, -1 for devices (debug only) */
173 typedef int file_t; /* Do not use stdio */
174 #define NO_FILE (-1) /* in memory compression */
177 #define PACK_MAGIC "\037\036" /* Magic header for packed files */
178 #define GZIP_MAGIC "\037\213" /* Magic header for gzip files, 1F 8B */
179 #define OLD_GZIP_MAGIC "\037\236" /* Magic header for gzip 0.5 = freeze 1.x */
180 #define LZH_MAGIC "\037\240" /* Magic header for SCO LZH Compress files*/
181 #define PKZIP_MAGIC "\120\113\003\004" /* Magic header for pkzip files */
184 #define ASCII_FLAG 0x01 /* bit 0 set: file probably ascii text */
185 #define CONTINUATION 0x02 /* bit 1 set: continuation of multi-part gzip file */
186 #define EXTRA_FIELD 0x04 /* bit 2 set: extra field present */
187 #define ORIG_NAME 0x08 /* bit 3 set: original file name present */
188 #define COMMENT 0x10 /* bit 4 set: file comment present */
189 #define ENCRYPTED 0x20 /* bit 5 set: file is encrypted */
190 #define RESERVED 0xC0 /* bit 6,7: reserved */
192 /* internal file attribute */
193 #define UNKNOWN 0xffff
198 # define WSIZE 0x8000 /* window size--must be a power of two, and */
199 #endif /* at least 32K for zip's deflate method */
202 #define MAX_MATCH 258
203 /* The minimum and maximum match lengths */
205 #define MIN_LOOKAHEAD (MAX_MATCH+MIN_MATCH+1)
206 /* Minimum amount of lookahead, except at the end of the input file.
207 * See deflate.c for comments about the MIN_MATCH+1.
210 #define MAX_DIST (WSIZE-MIN_LOOKAHEAD)
211 /* In order to simplify the code, particularly on 16 bit machines, match
212 * distances are limited to MAX_DIST instead of WSIZE.
215 extern int decrypt; /* flag to turn on decryption */
216 extern int exit_code; /* program exit code */
217 extern int verbose; /* be verbose (-v) */
218 extern int quiet; /* be quiet (-q) */
219 extern int level; /* compression level */
220 extern int test; /* check .z file integrity */
221 extern int to_stdout; /* output to stdout (-c) */
222 extern int save_orig_name; /* set if original name must be saved */
224 #define get_byte() (inptr < insize ? inbuf[inptr++] : fill_inbuf(0))
225 #define try_byte() (inptr < insize ? inbuf[inptr++] : fill_inbuf(1))
227 /* put_byte is used for the compressed output, put_ubyte for the
228 * uncompressed output. However unlzw() uses window for its
229 * suffix table instead of its output buffer, so it does not use put_ubyte
230 * (to be cleaned up).
232 #define put_byte(c) {outbuf[outcnt++]=(uch)(c); if (outcnt==OUTBUFSIZ)\
234 #define put_ubyte(c) {window[outcnt++]=(uch)(c); if (outcnt==WSIZE)\
237 /* Output a 16 bit value, lsb first */
238 #define put_short(w) \
239 { if (outcnt < OUTBUFSIZ-2) { \
240 outbuf[outcnt++] = (uch) ((w) & 0xff); \
241 outbuf[outcnt++] = (uch) ((ush)(w) >> 8); \
243 put_byte((uch)((w) & 0xff)); \
244 put_byte((uch)((ush)(w) >> 8)); \
248 /* Output a 32 bit value to the bit stream, lsb first */
249 #define put_long(n) { \
250 put_short((n) & 0xffff); \
251 put_short(((ulg)(n)) >> 16); \
254 #define seekable() 0 /* force sequential output */
255 #define translate_eol 0 /* no option -a yet */
257 #define tolow(c) (isupper (c) ? tolower (c) : (c)) /* force to lower case */
259 /* Macros for getting two-byte and four-byte header values */
260 #define SH(p) ((ush)(uch)((p)[0]) | ((ush)(uch)((p)[1]) << 8))
261 #define LG(p) ((ulg)(SH(p)) | ((ulg)(SH((p)+2)) << 16))
263 /* Diagnostic functions */
265 # define Assert(cond,msg) {if (!(cond)) gzip_error (msg);}
266 # define Trace(x) fprintf x
267 # define Tracev(x) {if (verbose) fprintf x ;}
268 # define Tracevv(x) {if (verbose>1) fprintf x ;}
269 # define Tracec(c,x) {if (verbose && (c)) fprintf x ;}
270 # define Tracecv(c,x) {if (verbose>1 && (c)) fprintf x ;}
272 # define Assert(cond,msg)
277 # define Tracecv(c,x)
280 #define WARN(msg) {if (!quiet) fprintf msg ; \
281 if (exit_code == OK) exit_code = WARNING;}
284 extern int zip OF((int in, int out));
285 extern int file_read OF((char *buf, unsigned size));
288 extern int unzip OF((int in, int out));
289 extern int check_zipfile OF((int in));
292 extern int unpack OF((int in, int out));
295 extern int unlzh OF((int in, int out));
298 void abort_gzip OF((void)) ATTRIBUTE_NORETURN;
301 void lm_init OF((int pack_level, ush *flags));
302 off_t deflate OF((void));
305 void ct_init OF((ush *attr, int *method));
306 int ct_tally OF((int dist, int lc));
307 off_t flush_block OF((char *buf, ulg stored_len, int pad, int eof));
310 void bi_init OF((file_t zipfile));
311 void send_bits OF((int value, int length));
312 unsigned bi_reverse OF((unsigned value, int length));
313 void bi_windup OF((void));
314 void copy_block OF((char *buf, unsigned len, int header));
315 extern int (*read_buf) OF((char *buf, unsigned size));
318 extern int copy OF((int in, int out));
319 extern ulg updcrc OF((uch *s, unsigned n));
320 extern void clear_bufs OF((void));
321 extern int fill_inbuf OF((int eof_ok));
322 extern void flush_outbuf OF((void));
323 extern void flush_window OF((void));
324 extern void write_buf OF((int fd, voidp buf, unsigned cnt));
325 extern int read_buffer OF((int fd, voidp buf, unsigned int cnt));
326 extern char *strlwr OF((char *s));
327 extern char *gzip_base_name OF((char *fname));
328 extern int xunlink OF((char *fname));
329 extern void make_simple_name OF((char *name));
330 extern char *add_envopt OF((int *argcp, char ***argvp, char *env));
331 extern void gzip_error OF((char *m));
332 extern void xalloc_die OF((void)) ATTRIBUTE_NORETURN;
333 extern void warning OF((char *m));
334 extern void read_error OF((void));
335 extern void write_error OF((void));
336 extern void display_ratio OF((off_t num, off_t den, FILE *file));
337 extern void fprint_off OF((FILE *, off_t, int));
340 extern int inflate OF((void));
343 extern int yesno OF((void));