xref: /titanic_52/usr/src/contrib/zlib/inftrees.h (revision ab9e68a238043b4ee046d74742fe13407f00e542)
1*ab9e68a2SToomas Soome /* inftrees.h -- header to use inftrees.c
2*ab9e68a2SToomas Soome  * Copyright (C) 1995-2005, 2010 Mark Adler
3*ab9e68a2SToomas Soome  * For conditions of distribution and use, see copyright notice in zlib.h
4*ab9e68a2SToomas Soome  */
5*ab9e68a2SToomas Soome 
6*ab9e68a2SToomas Soome /* WARNING: this file should *not* be used by applications. It is
7*ab9e68a2SToomas Soome    part of the implementation of the compression library and is
8*ab9e68a2SToomas Soome    subject to change. Applications should only use zlib.h.
9*ab9e68a2SToomas Soome  */
10*ab9e68a2SToomas Soome 
11*ab9e68a2SToomas Soome /* Structure for decoding tables.  Each entry provides either the
12*ab9e68a2SToomas Soome    information needed to do the operation requested by the code that
13*ab9e68a2SToomas Soome    indexed that table entry, or it provides a pointer to another
14*ab9e68a2SToomas Soome    table that indexes more bits of the code.  op indicates whether
15*ab9e68a2SToomas Soome    the entry is a pointer to another table, a literal, a length or
16*ab9e68a2SToomas Soome    distance, an end-of-block, or an invalid code.  For a table
17*ab9e68a2SToomas Soome    pointer, the low four bits of op is the number of index bits of
18*ab9e68a2SToomas Soome    that table.  For a length or distance, the low four bits of op
19*ab9e68a2SToomas Soome    is the number of extra bits to get after the code.  bits is
20*ab9e68a2SToomas Soome    the number of bits in this code or part of the code to drop off
21*ab9e68a2SToomas Soome    of the bit buffer.  val is the actual byte to output in the case
22*ab9e68a2SToomas Soome    of a literal, the base length or distance, or the offset from
23*ab9e68a2SToomas Soome    the current table to the next table.  Each entry is four bytes. */
24*ab9e68a2SToomas Soome typedef struct {
25*ab9e68a2SToomas Soome     unsigned char op;           /* operation, extra bits, table bits */
26*ab9e68a2SToomas Soome     unsigned char bits;         /* bits in this part of the code */
27*ab9e68a2SToomas Soome     unsigned short val;         /* offset in table or code value */
28*ab9e68a2SToomas Soome } code;
29*ab9e68a2SToomas Soome 
30*ab9e68a2SToomas Soome /* op values as set by inflate_table():
31*ab9e68a2SToomas Soome     00000000 - literal
32*ab9e68a2SToomas Soome     0000tttt - table link, tttt != 0 is the number of table index bits
33*ab9e68a2SToomas Soome     0001eeee - length or distance, eeee is the number of extra bits
34*ab9e68a2SToomas Soome     01100000 - end of block
35*ab9e68a2SToomas Soome     01000000 - invalid code
36*ab9e68a2SToomas Soome  */
37*ab9e68a2SToomas Soome 
38*ab9e68a2SToomas Soome /* Maximum size of the dynamic table.  The maximum number of code structures is
39*ab9e68a2SToomas Soome    1444, which is the sum of 852 for literal/length codes and 592 for distance
40*ab9e68a2SToomas Soome    codes.  These values were found by exhaustive searches using the program
41*ab9e68a2SToomas Soome    examples/enough.c found in the zlib distribtution.  The arguments to that
42*ab9e68a2SToomas Soome    program are the number of symbols, the initial root table size, and the
43*ab9e68a2SToomas Soome    maximum bit length of a code.  "enough 286 9 15" for literal/length codes
44*ab9e68a2SToomas Soome    returns returns 852, and "enough 30 6 15" for distance codes returns 592.
45*ab9e68a2SToomas Soome    The initial root table size (9 or 6) is found in the fifth argument of the
46*ab9e68a2SToomas Soome    inflate_table() calls in inflate.c and infback.c.  If the root table size is
47*ab9e68a2SToomas Soome    changed, then these maximum sizes would be need to be recalculated and
48*ab9e68a2SToomas Soome    updated. */
49*ab9e68a2SToomas Soome #define ENOUGH_LENS 852
50*ab9e68a2SToomas Soome #define ENOUGH_DISTS 592
51*ab9e68a2SToomas Soome #define ENOUGH (ENOUGH_LENS+ENOUGH_DISTS)
52*ab9e68a2SToomas Soome 
53*ab9e68a2SToomas Soome /* Type of code to build for inflate_table() */
54*ab9e68a2SToomas Soome typedef enum {
55*ab9e68a2SToomas Soome     CODES,
56*ab9e68a2SToomas Soome     LENS,
57*ab9e68a2SToomas Soome     DISTS
58*ab9e68a2SToomas Soome } codetype;
59*ab9e68a2SToomas Soome 
60*ab9e68a2SToomas Soome int ZLIB_INTERNAL inflate_table OF((codetype type, unsigned short FAR *lens,
61*ab9e68a2SToomas Soome                              unsigned codes, code FAR * FAR *table,
62*ab9e68a2SToomas Soome                              unsigned FAR *bits, unsigned short FAR *work));
63