## gzi - gzip Input Base Module

### Module Description

The gzi module implements the gzip inflate algorithm. The module is used for reading from a gzip file [zif] and, in a future version, stream [zis].

### Module Words

#### gzi constants

gzi.ok ( -- n )
  Decompression step is okee
gzi.done ( -- n )
  Decompression is done
gzi.more ( -- n )
  Decompression step needs more data
gzi.states ( -- n )
  Decompression step states

#### gzi structure

gzi% ( -- n )
  Get the required space for a gzi variable

#### gzip inflation variable creation, initialisation and destruction

gzi-init ( u gzi -- )
  Initialise the gzip inflation variable with an initial output buffer size u
gzi-(free) ( gzi -- )
  Free the internal, private variables from the heap
gzi-create ( "<spaces>name" u -- ; -- gzi )
  Create a named gzip inflation variable in the dictionary with an initial output buffer size u
gzi-new ( -- gzi )
  Create a new gzip inflation variable on the heap
gzi-free ( gzi -- )
  Free the variable from the heap

#### Member words

gzi-lbf@ ( gzi -- lbf )
  Get the output buffer

#### Inflate words

gzi-init-inflate ( gzi -- )
  Start the inflation of data
gzi-inflate ( gzi -- ior )
  Do the next step in inflating data, return the result code
gzi-reduce-output ( gzi -- )
  Check if the output buffer can be reduced
gzi-end-inflate ( gzi -- )
  Finish the inflation of data

#### Inspection

gzi-dump ( gzi -- )
  Dump the gzi

generated 03-Jun-2010 by ofcfrth-0.10.0