The chipz Reference Manual

Table of Contents

The chipz Reference Manual

This is the chipz Reference Manual, version 0.8, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 10:55:38 2018 GMT+0.

1 Systems

The main system appears first, followed by any subsystem dependency.

1.1 chipz

Maintainer

Nathan Froyd <froydnj@gmail.com>

Author

Nathan Froyd <froydnj@gmail.com>

License

BSD style

Description

A library for decompressing deflate, zlib, and gzip data

Version

0.8

Source

chipz.asd (file)

Components

• news (file)
• license (file)
• todo (file)
• package.lisp (file)
• doc (module)
• constants.lisp (file)
• types-and-tables.lisp (file)
• crc32.lisp (file)
• adler32.lisp (file)
• conditions.lisp (file)
• dstate.lisp (file)
• inflate-state.lisp (file)
• gzip.lisp (file)
• zlib.lisp (file)
• inflate.lisp (file)
• bzip2.lisp (file)
• decompress.lisp (file)
• stream.lisp (file)

2 Modules

Modules are listed depth-first from the system components tree.

2.1 chipz/doc

Parent

chipz (system)

Location

doc/

Components

• index.html (file)
• chipz-doc.txt (file)
• style.css (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 chipz.asd

Location

chipz.asd

Systems

chipz (system)

Packages

chipz-system

Internal Definitions

• css-file (class)
• txt-file (class)

3.1.2 chipz/package.lisp

Parent

chipz (system)

Location

package.lisp

Packages

chipz

3.1.3 chipz/constants.lisp

Dependency

package.lisp (file)

Parent

chipz (system)

Location

constants.lisp

Internal Definitions

• +100k+ (constant)
• +block-dynamic-codes+ (constant)
• +block-fixed-codes+ (constant)
• +block-invalid+ (constant)
• +block-no-compress+ (constant)
• +bz-g-size+ (constant)
• +bz-header-0+ (constant)
• +bz-header-b+ (constant)
• +bz-header-h+ (constant)
• +bz-header-z+ (constant)
• +bz-max-alpha-size+ (constant)
• +bz-max-code-len+ (constant)
• +bz-max-selectors+ (constant)
• +bz-n-groups+ (constant)
• +bz-n-iters+ (constant)
• +bz-runa+ (constant)
• +bz-runb+ (constant)
• +bzip2-crc32-table+ (constant)
• +crc32-table+ (constant)
• +default-buffer-size+ (constant)
• +deflate-max-bits+ (constant)
• +length-code-base-lengths+ (constant)
• +length-code-extra-bits+ (constant)
• +max-code-length+ (constant)
• +max-codes+ (constant)
• +max-n-code-lengths+ (constant)
• +mtfa-size+ (constant)
• +mtfl-size+ (constant)
• adler32-modulo (constant)
• define-constant (macro)

3.1.4 chipz/types-and-tables.lisp

Dependency

constants.lisp (file)

Parent

chipz (system)

Location

types-and-tables.lisp

Internal Definitions

• *code-length-code-order* (special variable)
• *distance-code-base-distances* (special variable)
• *distance-code-extra-bits* (special variable)
• *fixed-block-code-lengths* (special variable)
• *fixed-block-distance-lengths* (special variable)
• *fixed-distance-table* (special variable)
• *fixed-literal/length-table* (special variable)
• code-end-value (function)
• (setf code-end-value) (function)
• code-n-bits (function)
• (setf code-n-bits) (function)
• code-n-values (function)
• code-range-descriptor (structure)
• code-range-descriptor-p (function)
• code-start-value (function)
• (setf code-start-value) (function)
• compute-huffman-decode-structure (function)
• construct-huffman-decode-table (function)
• copy-code-range-descriptor (function)
• copy-huffman-decode-table (function)
• deflate-code (type)
• deflate-code-length (type)
• deflate-code-value (type)
• distance-base (function)
• hdt-bits (function)
• hdt-counts (function)
• hdt-offsets (function)
• hdt-symbols (function)
• huffman-decode-table (structure)
• huffman-decode-table-p (function)
• index (type)
• length-base (function)
• make-crd (function)
• make-hdt (function)
• n-distance-extra-bits (function)
• n-length-extra-bits (function)
• probably-the-fixnum (macro)
• simple-octet-vector (type)

3.1.5 chipz/crc32.lisp

Dependency

types-and-tables.lisp (file)

Parent

chipz (system)

Location

crc32.lisp

Internal Definitions

• copy-crc32 (function)
• crc32 (structure)
• crc32-crc (function)
• (setf crc32-crc) (function)
• crc32-p (function)
• make-crc32 (function)
• produce-crc32 (function)
• update-crc32 (function)

3.1.6 chipz/adler32.lisp

Dependency

types-and-tables.lisp (file)

Parent

chipz (system)

Location

adler32.lisp

Internal Definitions

• adler32 (structure)
• adler32-p (function)
• adler32-s1 (function)
• (setf adler32-s1) (function)
• adler32-s2 (function)
• (setf adler32-s2) (function)
• copy-adler32 (function)
• make-adler32 (function)
• produce-adler32 (function)
• update-adler32 (function)

3.1.7 chipz/conditions.lisp

Dependency

package.lisp (file)

Parent

chipz (system)

Location

conditions.lisp

Exported Definitions

• bzip2-error (condition)
• chipz-error (condition)
• decompression-error (condition)
• inflate-error (condition)
• invalid-bzip2-data (condition)
• invalid-checksum-error (condition)
• invalid-format-error (condition)
• invalid-gzip-header-error (condition)
• invalid-stored-block-length-error (condition)
• invalid-zlib-header-error (condition)
• premature-end-of-stream (condition)
• reserved-block-type-error (condition)

Internal Definitions

• actual-checksum (method)
• checksum-kind (method)
• expected-checksum (method)
• invalid-format (method)

3.1.8 chipz/dstate.lisp

Dependency

package.lisp (file)

Parent

chipz (system)

Location

dstate.lisp

Exported Definitions

• decompression-state (structure)
• finish-dstate (function)
• make-dstate (function)

Internal Definitions

• copy-decompression-state (function)
• decompression-state-p (function)
• dstate-bits (function)
• (setf dstate-bits) (function)
• dstate-checksum (function)
• (setf dstate-checksum) (function)
• dstate-done (function)
• (setf dstate-done) (function)
• dstate-input (function)
• (setf dstate-input) (function)
• dstate-input-end (function)
• (setf dstate-input-end) (function)
• dstate-input-index (function)
• (setf dstate-input-index) (function)
• dstate-input-start (function)
• (setf dstate-input-start) (function)
• dstate-n-bits (function)
• (setf dstate-n-bits) (function)
• dstate-output (function)
• (setf dstate-output) (function)
• dstate-output-end (function)
• (setf dstate-output-end) (function)
• dstate-output-index (function)
• (setf dstate-output-index) (function)
• dstate-output-start (function)
• (setf dstate-output-start) (function)
• dstate-state (function)
• (setf dstate-state) (function)
• dstate-update-checksum (function)
• (setf dstate-update-checksum) (function)
• make-decompression-state (function)

3.1.9 chipz/inflate-state.lisp

Dependencies

• dstate.lisp (file)
• crc32.lisp (file)
• adler32.lisp (file)

Parent

chipz (system)

Location

inflate-state.lisp

Exported Definitions

• finish-inflate-state (function)
• inflate-state (structure)
• make-inflate-state (function)

Internal Definitions

• %make-inflate-state (function)
• copy-inflate-state (function)
• inflate-state-bits (function)
• (setf inflate-state-bits) (function)
• inflate-state-checksum (function)
• (setf inflate-state-checksum) (function)
• inflate-state-code-lengths (function)
• (setf inflate-state-code-lengths) (function)
• inflate-state-codes-table (function)
• (setf inflate-state-codes-table) (function)
• inflate-state-data-format (function)
• (setf inflate-state-data-format) (function)
• inflate-state-distance (function)
• (setf inflate-state-distance) (function)
• inflate-state-distance-code (function)
• (setf inflate-state-distance-code) (function)
• inflate-state-distance-table (function)
• (setf inflate-state-distance-table) (function)
• inflate-state-done (function)
• (setf inflate-state-done) (function)
• inflate-state-final-block-p (function)
• (setf inflate-state-final-block-p) (function)
• inflate-state-header (function)
• (setf inflate-state-header) (function)
• inflate-state-input (function)
• (setf inflate-state-input) (function)
• inflate-state-input-end (function)
• (setf inflate-state-input-end) (function)
• inflate-state-input-index (function)
• (setf inflate-state-input-index) (function)
• inflate-state-input-start (function)
• (setf inflate-state-input-start) (function)
• inflate-state-length (function)
• (setf inflate-state-length) (function)
• inflate-state-length-code (function)
• (setf inflate-state-length-code) (function)
• inflate-state-literal/length-table (function)
• (setf inflate-state-literal/length-table) (function)
• inflate-state-n-bits (function)
• (setf inflate-state-n-bits) (function)
• inflate-state-n-codes (function)
• (setf inflate-state-n-codes) (function)
• inflate-state-n-distance-codes (function)
• (setf inflate-state-n-distance-codes) (function)
• inflate-state-n-length-codes (function)
• (setf inflate-state-n-length-codes) (function)
• inflate-state-n-values-read (function)
• (setf inflate-state-n-values-read) (function)
• inflate-state-output (function)
• (setf inflate-state-output) (function)
• inflate-state-output-end (function)
• (setf inflate-state-output-end) (function)
• inflate-state-output-index (function)
• (setf inflate-state-output-index) (function)
• inflate-state-output-start (function)
• (setf inflate-state-output-start) (function)
• inflate-state-p (function)
• inflate-state-state (function)
• (setf inflate-state-state) (function)
• inflate-state-update-checksum (function)
• (setf inflate-state-update-checksum) (function)
• inflate-state-window (function)
• (setf inflate-state-window) (function)
• inflate-state-window-index (function)
• (setf inflate-state-window-index) (function)
• sliding-window (type)

3.1.10 chipz/gzip.lisp

Dependencies

• inflate-state.lisp (file)
• conditions.lisp (file)

Parent

chipz (system)

Location

gzip.lisp

Internal Definitions

• +gzip-deflate-method+ (constant)
• +gzip-flag-comment+ (constant)
• +gzip-flag-crc+ (constant)
• +gzip-flag-extra+ (constant)
• +gzip-flag-name+ (constant)
• +gzip-flag-text+ (constant)
• +gzip-xfl-fast-compression+ (constant)
• +gzip-xfl-max-compression+ (constant)
• comment (method)
• (setf comment) (method)
• compression-method (method)
• (setf compression-method) (method)
• crc16 (method)
• (setf crc16) (method)
• extra-flags (method)
• (setf extra-flags) (method)
• filename (method)
• (setf filename) (method)
• flags (method)
• (setf flags) (method)
• gzip-header (class)
• mtime (method)
• (setf mtime) (method)
• os (method)
• (setf os) (method)
• write-date (method)
• (setf write-date) (method)

3.1.11 chipz/zlib.lisp

Dependencies

• inflate-state.lisp (file)
• conditions.lisp (file)

Parent

chipz (system)

Location

zlib.lisp

Internal Definitions

• +zlib-compression-method+ (constant)
• +zlib-flag-fdict+ (constant)
• +zlib-flevel-default+ (constant)
• +zlib-flevel-fast+ (constant)
• +zlib-flevel-fastest+ (constant)
• +zlib-flevel-maximum+ (constant)
• adler32 (method)
• (setf adler32) (method)
• cmf (method)
• (setf cmf) (method)
• fdict (method)
• (setf fdict) (method)
• flags (method)
• (setf flags) (method)
• zlib-compression-info (function)
• zlib-compression-method (function)
• zlib-flag-fcheck (function)
• zlib-flag-flevel (function)
• zlib-header (class)

3.1.12 chipz/inflate.lisp

Dependencies

• inflate-state.lisp (file)
• gzip.lisp (file)
• zlib.lisp (file)
• conditions.lisp (file)

Parent

chipz (system)

Location

inflate.lisp

Internal Definitions

• %inflate (function)
• %inflate-state-machine (function)
• record-code-length (function)
• update-window (function)

3.1.13 chipz/bzip2.lisp

Dependencies

• dstate.lisp (file)
• constants.lisp (file)

Parent

chipz (system)

Location

bzip2.lisp

Exported Definitions

bzip2-state (structure)

Internal Definitions

• %bzip2-decompress (function)
• %bzip2-state-machine (function)
• %make-bzip2-state (function)
• *dummy-vec* (special variable)
• bzip2-state-100k-block-size (function)
• (setf bzip2-state-100k-block-size) (function)
• bzip2-state-alpha-size (function)
• (setf bzip2-state-alpha-size) (function)
• bzip2-state-base (function)
• (setf bzip2-state-base) (function)
• bzip2-state-bits (function)
• (setf bzip2-state-bits) (function)
• bzip2-state-block-randomized-p (function)
• (setf bzip2-state-block-randomized-p) (function)
• bzip2-state-calculated-block-crc (function)
• (setf bzip2-state-calculated-block-crc) (function)
• bzip2-state-calculated-combined-crc (function)
• (setf bzip2-state-calculated-combined-crc) (function)
• bzip2-state-cftab (function)
• (setf bzip2-state-cftab) (function)
• bzip2-state-cftab-copy (function)
• (setf bzip2-state-cftab-copy) (function)
• bzip2-state-checksum (function)
• (setf bzip2-state-checksum) (function)
• bzip2-state-curr (function)
• (setf bzip2-state-curr) (function)
• bzip2-state-current-block-number (function)
• (setf bzip2-state-current-block-number) (function)
• bzip2-state-done (function)
• (setf bzip2-state-done) (function)
• bzip2-state-eob (function)
• (setf bzip2-state-eob) (function)
• bzip2-state-es (function)
• (setf bzip2-state-es) (function)
• bzip2-state-g-base (function)
• (setf bzip2-state-g-base) (function)
• bzip2-state-g-limit (function)
• (setf bzip2-state-g-limit) (function)
• bzip2-state-g-minlen (function)
• (setf bzip2-state-g-minlen) (function)
• bzip2-state-g-perm (function)
• (setf bzip2-state-g-perm) (function)
• bzip2-state-group-number (function)
• (setf bzip2-state-group-number) (function)
• bzip2-state-group-position (function)
• (setf bzip2-state-group-position) (function)
• bzip2-state-i (function)
• (setf bzip2-state-i) (function)
• bzip2-state-in-use (function)
• (setf bzip2-state-in-use) (function)
• bzip2-state-in-use-16 (function)
• (setf bzip2-state-in-use-16) (function)
• bzip2-state-input (function)
• (setf bzip2-state-input) (function)
• bzip2-state-input-end (function)
• (setf bzip2-state-input-end) (function)
• bzip2-state-input-index (function)
• (setf bzip2-state-input-index) (function)
• bzip2-state-input-start (function)
• (setf bzip2-state-input-start) (function)
• bzip2-state-j (function)
• (setf bzip2-state-j) (function)
• bzip2-state-k0 (function)
• (setf bzip2-state-k0) (function)
• bzip2-state-len (function)
• (setf bzip2-state-len) (function)
• bzip2-state-limit (function)
• (setf bzip2-state-limit) (function)
• bzip2-state-lval (function)
• (setf bzip2-state-lval) (function)
• bzip2-state-min-lengths (function)
• (setf bzip2-state-min-lengths) (function)
• bzip2-state-mtf-continuation (function)
• (setf bzip2-state-mtf-continuation) (function)
• bzip2-state-mtfa (function)
• (setf bzip2-state-mtfa) (function)
• bzip2-state-mtfbase (function)
• (setf bzip2-state-mtfbase) (function)
• bzip2-state-n (function)
• (setf bzip2-state-n) (function)
• bzip2-state-n-bits (function)
• (setf bzip2-state-n-bits) (function)
• bzip2-state-n-blocks-used (function)
• (setf bzip2-state-n-blocks-used) (function)
• bzip2-state-n-groups (function)
• (setf bzip2-state-n-groups) (function)
• bzip2-state-n-in-use (function)
• (setf bzip2-state-n-in-use) (function)
• bzip2-state-n-selectors (function)
• (setf bzip2-state-n-selectors) (function)
• bzip2-state-nblock (function)
• (setf bzip2-state-nblock) (function)
• bzip2-state-nblockmax (function)
• (setf bzip2-state-nblockmax) (function)
• bzip2-state-original-pointer (function)
• (setf bzip2-state-original-pointer) (function)
• bzip2-state-out-ch (function)
• (setf bzip2-state-out-ch) (function)
• bzip2-state-out-len (function)
• (setf bzip2-state-out-len) (function)
• bzip2-state-output (function)
• (setf bzip2-state-output) (function)
• bzip2-state-output-end (function)
• (setf bzip2-state-output-end) (function)
• bzip2-state-output-index (function)
• (setf bzip2-state-output-index) (function)
• bzip2-state-output-start (function)
• (setf bzip2-state-output-start) (function)
• bzip2-state-p (function)
• bzip2-state-perm (function)
• (setf bzip2-state-perm) (function)
• bzip2-state-rntogo (function)
• (setf bzip2-state-rntogo) (function)
• bzip2-state-rntpos (function)
• (setf bzip2-state-rntpos) (function)
• bzip2-state-selector (function)
• (setf bzip2-state-selector) (function)
• bzip2-state-selector-mtf (function)
• (setf bzip2-state-selector-mtf) (function)
• bzip2-state-seq-to-unseq (function)
• (setf bzip2-state-seq-to-unseq) (function)
• bzip2-state-small-decompression-p (function)
• (setf bzip2-state-small-decompression-p) (function)
• bzip2-state-state (function)
• (setf bzip2-state-state) (function)
• bzip2-state-stored-block-crc (function)
• (setf bzip2-state-stored-block-crc) (function)
• bzip2-state-stored-combined-crc (function)
• (setf bzip2-state-stored-combined-crc) (function)
• bzip2-state-t-position (function)
• (setf bzip2-state-t-position) (function)
• bzip2-state-tt (function)
• (setf bzip2-state-tt) (function)
• bzip2-state-unzftab (function)
• (setf bzip2-state-unzftab) (function)
• bzip2-state-update-checksum (function)
• (setf bzip2-state-update-checksum) (function)
• bzip2-state-zn (function)
• (setf bzip2-state-zn) (function)
• bzip2-state-zvec (function)
• (setf bzip2-state-zvec) (function)
• copy-bzip2-state (function)
• make-bzip2-state (function)
• make-decode-tables (function)
• make-maps (function)
• reverse-ub16 (function)
• reverse-ub4 (function)
• reverse-ub8 (function)
• undo-rle-obuf-to-output (function)

3.1.14 chipz/decompress.lisp

Dependencies

• inflate-state.lisp (file)
• inflate.lisp (file)
• bzip2.lisp (file)

Parent

chipz (system)

Location

decompress.lisp

Exported Definitions

• decompress (generic function)
• decompress (method)
• decompress (method)
• decompress (method)
• decompress (method)
• decompress (method)
• decompress (method)
• decompress (method)
• decompress (method)
• decompress (method)
• decompress (method)

Internal Definitions

• %decompress (function)
• %decompress-from-pathname (function)
• %decompress/null-stream (function)
• %decompress/null-vector (function)
• %decompress/stream-stream (function)
• %decompress/stream-vector (function)
• %decompress/vector-vector (function)
• decompress-fun-for-state (function)
• maybe-subseq (function)

3.1.15 chipz/stream.lisp

Dependencies

• inflate-state.lisp (file)
• inflate.lisp (file)

Parent

chipz (system)

Location

stream.lisp

Exported Definitions

make-decompressing-stream (function)

Internal Definitions

• *binary-input-stream-class* (special variable)
• *stream-read-byte-function* (special variable)
• *stream-read-sequence-function* (special variable)
• copy-existing-output (function)
• decompressing-stream (class)
• define-stream-read-sequence (macro)
• dfun (method)
• dstate (method)
• input-available-p (function)
• input-buffer (method)
• input-buffer-index (method)
• (setf input-buffer-index) (method)
• input-buffer-n-bytes (method)
• (setf input-buffer-n-bytes) (method)
• output-available-p (function)
• output-buffer (method)
• output-buffer-index (method)
• (setf output-buffer-index) (method)
• output-buffer-n-bytes (method)
• (setf output-buffer-n-bytes) (method)
• read-and-decompress-byte (function)
• refill-stream-input-buffer (function)
• refill-stream-output-buffer (function)
• wrapped-stream (method)

3.2 HTML

3.2.1 chipz/doc/index.html

Parent

doc (module)

Location

doc/index.html

3.3 Doc

3.3.1 chipz/doc/chipz-doc.txt

Parent

doc (module)

Location

doc/chipz-doc.txt

3.3.2 chipz/doc/style.css

Parent

doc (module)

Location

doc/style.css

3.4 Other

3.4.1 chipz/NEWS

Parent

chipz (system)

Location

NEWS

3.4.2 chipz/LICENSE

Parent

chipz (system)

Location

LICENSE

3.4.3 chipz/TODO

Parent

chipz (system)

Location

TODO

4 Packages

Packages are listed by definition order.

4.1 chipz-system

Source

chipz.asd

Use List

• asdf/interface
• common-lisp

Internal Definitions

• css-file (class)
• txt-file (class)

4.2 chipz

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• bzip2-error (condition)
• bzip2-state (structure)
• chipz-error (condition)
• decompress (generic function)
• decompress (method)
• decompress (method)
• decompress (method)
• decompress (method)
• decompress (method)
• decompress (method)
• decompress (method)
• decompress (method)
• decompress (method)
• decompress (method)
• decompression-error (condition)
• decompression-state (structure)
• finish-dstate (function)
• finish-inflate-state (function)
• inflate-error (condition)
• inflate-state (structure)
• invalid-bzip2-data (condition)
• invalid-checksum-error (condition)
• invalid-format-error (condition)
• invalid-gzip-header-error (condition)
• invalid-stored-block-length-error (condition)
• invalid-zlib-header-error (condition)
• make-decompressing-stream (function)
• make-dstate (function)
• make-inflate-state (function)
• premature-end-of-stream (condition)
• reserved-block-type-error (condition)

Internal Definitions

• %bzip2-decompress (function)
• %bzip2-state-machine (function)
• %decompress (function)
• %decompress-from-pathname (function)
• %decompress/null-stream (function)
• %decompress/null-vector (function)
• %decompress/stream-stream (function)
• %decompress/stream-vector (function)
• %decompress/vector-vector (function)
• %inflate (function)
• %inflate-state-machine (function)
• %make-bzip2-state (function)
• %make-inflate-state (function)
• *binary-input-stream-class* (special variable)
• *code-length-code-order* (special variable)
• *distance-code-base-distances* (special variable)
• *distance-code-extra-bits* (special variable)
• *dummy-vec* (special variable)
• *fixed-block-code-lengths* (special variable)
• *fixed-block-distance-lengths* (special variable)
• *fixed-distance-table* (special variable)
• *fixed-literal/length-table* (special variable)
• *stream-read-byte-function* (special variable)
• *stream-read-sequence-function* (special variable)
• +100k+ (constant)
• +block-dynamic-codes+ (constant)
• +block-fixed-codes+ (constant)
• +block-invalid+ (constant)
• +block-no-compress+ (constant)
• +bz-g-size+ (constant)
• +bz-header-0+ (constant)
• +bz-header-b+ (constant)
• +bz-header-h+ (constant)
• +bz-header-z+ (constant)
• +bz-max-alpha-size+ (constant)
• +bz-max-code-len+ (constant)
• +bz-max-selectors+ (constant)
• +bz-n-groups+ (constant)
• +bz-n-iters+ (constant)
• +bz-runa+ (constant)
• +bz-runb+ (constant)
• +bzip2-crc32-table+ (constant)
• +crc32-table+ (constant)
• +default-buffer-size+ (constant)
• +deflate-max-bits+ (constant)
• +gzip-deflate-method+ (constant)
• +gzip-flag-comment+ (constant)
• +gzip-flag-crc+ (constant)
• +gzip-flag-extra+ (constant)
• +gzip-flag-name+ (constant)
• +gzip-flag-text+ (constant)
• +gzip-xfl-fast-compression+ (constant)
• +gzip-xfl-max-compression+ (constant)
• +length-code-base-lengths+ (constant)
• +length-code-extra-bits+ (constant)
• +max-code-length+ (constant)
• +max-codes+ (constant)
• +max-n-code-lengths+ (constant)
• +mtfa-size+ (constant)
• +mtfl-size+ (constant)
• +zlib-compression-method+ (constant)
• +zlib-flag-fdict+ (constant)
• +zlib-flevel-default+ (constant)
• +zlib-flevel-fast+ (constant)
• +zlib-flevel-fastest+ (constant)
• +zlib-flevel-maximum+ (constant)
• actual-checksum (generic function)
• actual-checksum (method)
• adler32 (generic function)
• adler32 (method)
• (setf adler32) (method)
• (setf adler32) (generic function)
• adler32 (structure)
• adler32-modulo (constant)
• adler32-p (function)
• adler32-s1 (function)
• (setf adler32-s1) (function)
• adler32-s2 (function)
• (setf adler32-s2) (function)
• bzip2-state-100k-block-size (function)
• (setf bzip2-state-100k-block-size) (function)
• bzip2-state-alpha-size (function)
• (setf bzip2-state-alpha-size) (function)
• bzip2-state-base (function)
• (setf bzip2-state-base) (function)
• bzip2-state-bits (function)
• (setf bzip2-state-bits) (function)
• bzip2-state-block-randomized-p (function)
• (setf bzip2-state-block-randomized-p) (function)
• bzip2-state-calculated-block-crc (function)
• (setf bzip2-state-calculated-block-crc) (function)
• bzip2-state-calculated-combined-crc (function)
• (setf bzip2-state-calculated-combined-crc) (function)
• bzip2-state-cftab (function)
• (setf bzip2-state-cftab) (function)
• bzip2-state-cftab-copy (function)
• (setf bzip2-state-cftab-copy) (function)
• bzip2-state-checksum (function)
• (setf bzip2-state-checksum) (function)
• bzip2-state-curr (function)
• (setf bzip2-state-curr) (function)
• bzip2-state-current-block-number (function)
• (setf bzip2-state-current-block-number) (function)
• bzip2-state-done (function)
• (setf bzip2-state-done) (function)
• bzip2-state-eob (function)
• (setf bzip2-state-eob) (function)
• bzip2-state-es (function)
• (setf bzip2-state-es) (function)
• bzip2-state-g-base (function)
• (setf bzip2-state-g-base) (function)
• bzip2-state-g-limit (function)
• (setf bzip2-state-g-limit) (function)
• bzip2-state-g-minlen (function)
• (setf bzip2-state-g-minlen) (function)
• bzip2-state-g-perm (function)
• (setf bzip2-state-g-perm) (function)
• bzip2-state-group-number (function)
• (setf bzip2-state-group-number) (function)
• bzip2-state-group-position (function)
• (setf bzip2-state-group-position) (function)
• bzip2-state-i (function)
• (setf bzip2-state-i) (function)
• bzip2-state-in-use (function)
• (setf bzip2-state-in-use) (function)
• bzip2-state-in-use-16 (function)
• (setf bzip2-state-in-use-16) (function)
• bzip2-state-input (function)
• (setf bzip2-state-input) (function)
• bzip2-state-input-end (function)
• (setf bzip2-state-input-end) (function)
• bzip2-state-input-index (function)
• (setf bzip2-state-input-index) (function)
• bzip2-state-input-start (function)
• (setf bzip2-state-input-start) (function)
• bzip2-state-j (function)
• (setf bzip2-state-j) (function)
• bzip2-state-k0 (function)
• (setf bzip2-state-k0) (function)
• bzip2-state-len (function)
• (setf bzip2-state-len) (function)
• bzip2-state-limit (function)
• (setf bzip2-state-limit) (function)
• bzip2-state-lval (function)
• (setf bzip2-state-lval) (function)
• bzip2-state-min-lengths (function)
• (setf bzip2-state-min-lengths) (function)
• bzip2-state-mtf-continuation (function)
• (setf bzip2-state-mtf-continuation) (function)
• bzip2-state-mtfa (function)
• (setf bzip2-state-mtfa) (function)
• bzip2-state-mtfbase (function)
• (setf bzip2-state-mtfbase) (function)
• bzip2-state-n (function)
• (setf bzip2-state-n) (function)
• bzip2-state-n-bits (function)
• (setf bzip2-state-n-bits) (function)
• bzip2-state-n-blocks-used (function)
• (setf bzip2-state-n-blocks-used) (function)
• bzip2-state-n-groups (function)
• (setf bzip2-state-n-groups) (function)
• bzip2-state-n-in-use (function)
• (setf bzip2-state-n-in-use) (function)
• bzip2-state-n-selectors (function)
• (setf bzip2-state-n-selectors) (function)
• bzip2-state-nblock (function)
• (setf bzip2-state-nblock) (function)
• bzip2-state-nblockmax (function)
• (setf bzip2-state-nblockmax) (function)
• bzip2-state-original-pointer (function)
• (setf bzip2-state-original-pointer) (function)
• bzip2-state-out-ch (function)
• (setf bzip2-state-out-ch) (function)
• bzip2-state-out-len (function)
• (setf bzip2-state-out-len) (function)
• bzip2-state-output (function)
• (setf bzip2-state-output) (function)
• bzip2-state-output-end (function)
• (setf bzip2-state-output-end) (function)
• bzip2-state-output-index (function)
• (setf bzip2-state-output-index) (function)
• bzip2-state-output-start (function)
• (setf bzip2-state-output-start) (function)
• bzip2-state-p (function)
• bzip2-state-perm (function)
• (setf bzip2-state-perm) (function)
• bzip2-state-rntogo (function)
• (setf bzip2-state-rntogo) (function)
• bzip2-state-rntpos (function)
• (setf bzip2-state-rntpos) (function)
• bzip2-state-selector (function)
• (setf bzip2-state-selector) (function)
• bzip2-state-selector-mtf (function)
• (setf bzip2-state-selector-mtf) (function)
• bzip2-state-seq-to-unseq (function)
• (setf bzip2-state-seq-to-unseq) (function)
• bzip2-state-small-decompression-p (function)
• (setf bzip2-state-small-decompression-p) (function)
• bzip2-state-state (function)
• (setf bzip2-state-state) (function)
• bzip2-state-stored-block-crc (function)
• (setf bzip2-state-stored-block-crc) (function)
• bzip2-state-stored-combined-crc (function)
• (setf bzip2-state-stored-combined-crc) (function)
• bzip2-state-t-position (function)
• (setf bzip2-state-t-position) (function)
• bzip2-state-tt (function)
• (setf bzip2-state-tt) (function)
• bzip2-state-unzftab (function)
• (setf bzip2-state-unzftab) (function)
• bzip2-state-update-checksum (function)
• (setf bzip2-state-update-checksum) (function)
• bzip2-state-zn (function)
• (setf bzip2-state-zn) (function)
• bzip2-state-zvec (function)
• (setf bzip2-state-zvec) (function)
• checksum-kind (generic function)
• checksum-kind (method)
• cmf (generic function)
• cmf (method)
• (setf cmf) (method)
• (setf cmf) (generic function)
• code-end-value (function)
• (setf code-end-value) (function)
• code-n-bits (function)
• (setf code-n-bits) (function)
• code-n-values (function)
• code-range-descriptor (structure)
• code-range-descriptor-p (function)
• code-start-value (function)
• (setf code-start-value) (function)
• comment (generic function)
• comment (method)
• (setf comment) (method)
• (setf comment) (generic function)
• compression-method (generic function)
• compression-method (method)
• (setf compression-method) (method)
• (setf compression-method) (generic function)
• compute-huffman-decode-structure (function)
• construct-huffman-decode-table (function)
• copy-adler32 (function)
• copy-bzip2-state (function)
• copy-code-range-descriptor (function)
• copy-crc32 (function)
• copy-decompression-state (function)
• copy-existing-output (function)
• copy-huffman-decode-table (function)
• copy-inflate-state (function)
• crc16 (generic function)
• crc16 (method)
• (setf crc16) (method)
• (setf crc16) (generic function)
• crc32 (structure)
• crc32-crc (function)
• (setf crc32-crc) (function)
• crc32-p (function)
• decompress-fun-for-state (function)
• decompressing-stream (class)
• decompression-state-p (function)
• define-constant (macro)
• define-stream-read-sequence (macro)
• deflate-code (type)
• deflate-code-length (type)
• deflate-code-value (type)
• dfun (generic function)
• dfun (method)
• distance-base (function)
• dstate (generic function)
• dstate (method)
• dstate-bits (function)
• (setf dstate-bits) (function)
• dstate-checksum (function)
• (setf dstate-checksum) (function)
• dstate-done (function)
• (setf dstate-done) (function)
• dstate-input (function)
• (setf dstate-input) (function)
• dstate-input-end (function)
• (setf dstate-input-end) (function)
• dstate-input-index (function)
• (setf dstate-input-index) (function)
• dstate-input-start (function)
• (setf dstate-input-start) (function)
• dstate-n-bits (function)
• (setf dstate-n-bits) (function)
• dstate-output (function)
• (setf dstate-output) (function)
• dstate-output-end (function)
• (setf dstate-output-end) (function)
• dstate-output-index (function)
• (setf dstate-output-index) (function)
• dstate-output-start (function)
• (setf dstate-output-start) (function)
• dstate-state (function)
• (setf dstate-state) (function)
• dstate-update-checksum (function)
• (setf dstate-update-checksum) (function)
• expected-checksum (generic function)
• expected-checksum (method)
• extra-flags (generic function)
• extra-flags (method)
• (setf extra-flags) (method)
• (setf extra-flags) (generic function)
• fdict (generic function)
• fdict (method)
• (setf fdict) (method)
• (setf fdict) (generic function)
• filename (generic function)
• filename (method)
• (setf filename) (method)
• (setf filename) (generic function)
• flags (generic function)
• flags (method)
• (setf flags) (method)
• flags (method)
• (setf flags) (method)
• (setf flags) (generic function)
• gzip-header (class)
• hdt-bits (function)
• hdt-counts (function)
• hdt-offsets (function)
• hdt-symbols (function)
• huffman-decode-table (structure)
• huffman-decode-table-p (function)
• index (type)
• inflate-state-bits (function)
• (setf inflate-state-bits) (function)
• inflate-state-checksum (function)
• (setf inflate-state-checksum) (function)
• inflate-state-code-lengths (function)
• (setf inflate-state-code-lengths) (function)
• inflate-state-codes-table (function)
• (setf inflate-state-codes-table) (function)
• inflate-state-data-format (function)
• (setf inflate-state-data-format) (function)
• inflate-state-distance (function)
• (setf inflate-state-distance) (function)
• inflate-state-distance-code (function)
• (setf inflate-state-distance-code) (function)
• inflate-state-distance-table (function)
• (setf inflate-state-distance-table) (function)
• inflate-state-done (function)
• (setf inflate-state-done) (function)
• inflate-state-final-block-p (function)
• (setf inflate-state-final-block-p) (function)
• inflate-state-header (function)
• (setf inflate-state-header) (function)
• inflate-state-input (function)
• (setf inflate-state-input) (function)
• inflate-state-input-end (function)
• (setf inflate-state-input-end) (function)
• inflate-state-input-index (function)
• (setf inflate-state-input-index) (function)
• inflate-state-input-start (function)
• (setf inflate-state-input-start) (function)
• inflate-state-length (function)
• (setf inflate-state-length) (function)
• inflate-state-length-code (function)
• (setf inflate-state-length-code) (function)
• inflate-state-literal/length-table (function)
• (setf inflate-state-literal/length-table) (function)
• inflate-state-n-bits (function)
• (setf inflate-state-n-bits) (function)
• inflate-state-n-codes (function)
• (setf inflate-state-n-codes) (function)
• inflate-state-n-distance-codes (function)
• (setf inflate-state-n-distance-codes) (function)
• inflate-state-n-length-codes (function)
• (setf inflate-state-n-length-codes) (function)
• inflate-state-n-values-read (function)
• (setf inflate-state-n-values-read) (function)
• inflate-state-output (function)
• (setf inflate-state-output) (function)
• inflate-state-output-end (function)
• (setf inflate-state-output-end) (function)
• inflate-state-output-index (function)
• (setf inflate-state-output-index) (function)
• inflate-state-output-start (function)
• (setf inflate-state-output-start) (function)
• inflate-state-p (function)
• inflate-state-state (function)
• (setf inflate-state-state) (function)
• inflate-state-update-checksum (function)
• (setf inflate-state-update-checksum) (function)
• inflate-state-window (function)
• (setf inflate-state-window) (function)
• inflate-state-window-index (function)
• (setf inflate-state-window-index) (function)
• input-available-p (function)
• input-buffer (generic function)
• input-buffer (method)
• input-buffer-index (generic function)
• input-buffer-index (method)
• (setf input-buffer-index) (method)
• (setf input-buffer-index) (generic function)
• input-buffer-n-bytes (generic function)
• input-buffer-n-bytes (method)
• (setf input-buffer-n-bytes) (method)
• (setf input-buffer-n-bytes) (generic function)
• invalid-format (generic function)
• invalid-format (method)
• length-base (function)
• make-adler32 (function)
• make-bzip2-state (function)
• make-crc32 (function)
• make-crd (function)
• make-decode-tables (function)
• make-decompression-state (function)
• make-hdt (function)
• make-maps (function)
• maybe-subseq (function)
• mtime (generic function)
• mtime (method)
• (setf mtime) (method)
• (setf mtime) (generic function)
• n-distance-extra-bits (function)
• n-length-extra-bits (function)
• os (generic function)
• os (method)
• (setf os) (method)
• (setf os) (generic function)
• output-available-p (function)
• output-buffer (generic function)
• output-buffer (method)
• output-buffer-index (generic function)
• output-buffer-index (method)
• (setf output-buffer-index) (method)
• (setf output-buffer-index) (generic function)
• output-buffer-n-bytes (generic function)
• output-buffer-n-bytes (method)
• (setf output-buffer-n-bytes) (method)
• (setf output-buffer-n-bytes) (generic function)
• probably-the-fixnum (macro)
• produce-adler32 (function)
• produce-crc32 (function)
• read-and-decompress-byte (function)
• record-code-length (function)
• refill-stream-input-buffer (function)
• refill-stream-output-buffer (function)
• reverse-ub16 (function)
• reverse-ub4 (function)
• reverse-ub8 (function)
• simple-octet-vector (type)
• sliding-window (type)
• undo-rle-obuf-to-output (function)
• update-adler32 (function)
• update-crc32 (function)
• update-window (function)
• wrapped-stream (generic function)
• wrapped-stream (method)
• write-date (generic function)
• write-date (method)
• (setf write-date) (method)
• (setf write-date) (generic function)
• zlib-compression-info (function)
• zlib-compression-method (function)
• zlib-flag-fcheck (function)
• zlib-flag-flevel (function)
• zlib-header (class)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: finish-dstate STATE

Package

chipz

Source

dstate.lisp (file)

Function: finish-inflate-state STATE

Package

chipz

Source

inflate-state.lisp (file)

Function: make-decompressing-stream FORMAT STREAM

Package

chipz

Source

stream.lisp (file)

Function: make-dstate FORMAT

Return a structure suitable for uncompressing data in DATA-FORMAT; DATA-FORMAT should be:

:BZIP2 or CHIPZ:BZIP2 For decompressing data in the ‘bzip2’ format; :GZIP or CHIPZ:GZIP For decompressing data in the ‘gzip’ format; :ZLIB or CHIPZ:ZLIB For decompressing data in the ‘zlib’ format; :DEFLATE or CHIPZ:DEFLATE For decompressing data in the ‘deflate’ format.

The usual value of DATA-FORMAT will be one of CHIPZ:BZIP2 or CHIPZ:GZIP.

Package

chipz

Source

dstate.lisp (file)

Function: make-inflate-state FORMAT

Return a INFLATE-STATE structure suitable for uncompressing data in FORMAT; FORMAT should be:

:GZIP or CHIPZ:GZIP For decompressing data in the ‘gzip’ format; :ZLIB or CHIPZ:ZLIB For decompressing data in the ‘zlib’ format; :DEFLATE or CHIPZ:DEFLATE For decompressing data in the ‘deflate’ format.

The usual value of FORMAT will be one of CHIPZ:GZIP or CHIPZ:ZLIB.

Package

chipz

Source

inflate-state.lisp (file)

5.1.2 Generic functions

Generic Function: decompress OUTPUT STATE INPUT &key INPUT-START INPUT-END OUTPUT-START OUTPUT-END BUFFER-SIZE &allow-other-keys

Package

chipz

Source

decompress.lisp (file)

Methods

Method: decompress (OUTPUT stream) (STATE decompression-state) (INPUT stream) &key

Method: decompress (OUTPUT stream) (STATE decompression-state) (INPUT vector) &key INPUT-START INPUT-END

Method: decompress (OUTPUT vector) (STATE decompression-state) (INPUT vector) &key INPUT-START INPUT-END OUTPUT-START OUTPUT-END

Method: decompress (OUTPUT null) (STATE decompression-state) (INPUT stream) &key BUFFER-SIZE

Method: decompress (OUTPUT null) (STATE decompression-state) (INPUT vector) &key INPUT-START INPUT-END BUFFER-SIZE

Method: decompress (OUTPUT stream) (STATE decompression-state) (INPUT pathname) &key BUFFER-SIZE

Method: decompress (OUTPUT pathname) (STATE decompression-state) (INPUT pathname) &key BUFFER-SIZE

Method: decompress (OUTPUT null) (STATE decompression-state) (INPUT pathname) &key

Method: decompress OUTPUT FORMAT INPUT &rest KEYS

Method: decompress OUTPUT FORMAT (INPUT list) &rest KEYS

5.1.3 Conditions

Condition: bzip2-error ()

The base condition of conditions signaled when decompressing BZIP2-related formats.

Package

chipz

Source

conditions.lisp (file)

Direct superclasses

decompression-error (condition)

Direct subclasses

invalid-bzip2-data (condition)

Condition: chipz-error ()

The base condition of the CHIPZ library. All other conditions inherit from this error.

Package

chipz

Source

conditions.lisp (file)

Direct superclasses

simple-error (condition)

Direct subclasses

• decompression-error (condition)
• invalid-format-error (condition)

Condition: decompression-error ()

The base condition of all conditions signaled during decompression.

Package

chipz

Source

conditions.lisp (file)

Direct superclasses

chipz-error (condition)

Direct subclasses

• invalid-checksum-error (condition)
• premature-end-of-stream (condition)
• inflate-error (condition)
• bzip2-error (condition)

Condition: inflate-error ()

The base condition of conditions signaled when decompressing DEFLATE-related formats.

Package

chipz

Source

conditions.lisp (file)

Direct superclasses

decompression-error (condition)

Direct subclasses

• invalid-zlib-header-error (condition)
• invalid-gzip-header-error (condition)
• reserved-block-type-error (condition)
• invalid-stored-block-length-error (condition)

Condition: invalid-bzip2-data ()

Signaled when invalid bzip2 data is found.

Package

chipz

Source

conditions.lisp (file)

Direct superclasses

bzip2-error (condition)

Condition: invalid-checksum-error ()

Signaled when the checksum of decompressed data does not match the expected value.

Package

chipz

Source

conditions.lisp (file)

Direct superclasses

decompression-error (condition)

Direct methods

• checksum-kind (method)
• actual-checksum (method)
• expected-checksum (method)

Direct slots

Slot: expected-checksum

Initargs

:stored

Readers

expected-checksum (generic function)

Slot: actual-checksum

Initargs

:computed

Readers

actual-checksum (generic function)

Slot: kind

Initargs

:kind

Readers

checksum-kind (generic function)

Condition: invalid-format-error ()

Signaled when an invalid format name is passed to MAKE-DSTATE, MAKE-INFLATE-STATE, or DECOMPRESS.

Package

chipz

Source

conditions.lisp (file)

Direct superclasses

chipz-error (condition)

Direct methods

invalid-format (method)

Direct slots

Slot: format

Initargs

:format

Readers

invalid-format (generic function)

Condition: invalid-gzip-header-error ()

Signaled when a gzip header does not have the proper ID.

Package

chipz

Source

conditions.lisp (file)

Direct superclasses

inflate-error (condition)

Condition: invalid-stored-block-length-error ()

Signaled when a stored block’s length does not pass the consistency check.

Package

chipz

Source

conditions.lisp (file)

Direct superclasses

inflate-error (condition)

Condition: invalid-zlib-header-error ()

Signaled when a zlib header does not pass the consistency check.

Package

chipz

Source

conditions.lisp (file)

Direct superclasses

inflate-error (condition)

Condition: premature-end-of-stream ()

Signaled when FINISH-DSTATE is called on a state that
has not actually reached the end of the input being decompressed.

Package

chipz

Source

conditions.lisp (file)

Direct superclasses

decompression-error (condition)

Condition: reserved-block-type-error ()

Signaled when an invalid deflate block is found.

Package

chipz

Source

conditions.lisp (file)

Direct superclasses

inflate-error (condition)

5.1.4 Structures

Structure: bzip2-state ()

Package

chipz

Source

bzip2.lisp (file)

Direct superclasses

decompression-state (structure)

Direct methods

print-object (method)

Direct slots

Slot: out-ch

Type

(unsigned-byte 8)

Initform

0

Readers

bzip2-state-out-ch (function)

Writers

(setf bzip2-state-out-ch) (function)

Slot: out-len

Type

(integer 0 260)

Initform

0

Readers

bzip2-state-out-len (function)

Writers

(setf bzip2-state-out-len) (function)

Slot: block-randomized-p

Readers

bzip2-state-block-randomized-p (function)

Writers

(setf bzip2-state-block-randomized-p) (function)

Slot: rntogo

Type

(unsigned-byte 32)

Initform

0

Readers

bzip2-state-rntogo (function)

Writers

(setf bzip2-state-rntogo) (function)

Slot: rntpos

Type

(unsigned-byte 32)

Initform

0

Readers

bzip2-state-rntpos (function)

Writers

(setf bzip2-state-rntpos) (function)

Slot: 100k-block-size

Type

(integer 1 9)

Initform

1

Readers

bzip2-state-100k-block-size (function)

Writers

(setf bzip2-state-100k-block-size) (function)

Slot: small-decompression-p

Readers

bzip2-state-small-decompression-p (function)

Writers

(setf bzip2-state-small-decompression-p) (function)

Slot: current-block-number

Initform

0

Readers

bzip2-state-current-block-number (function)

Writers

(setf bzip2-state-current-block-number) (function)

Slot: original-pointer

Initform

0

Readers

bzip2-state-original-pointer (function)

Writers

(setf bzip2-state-original-pointer) (function)

Slot: t-position

Type

(integer 0 (900000))

Initform

0

Readers

bzip2-state-t-position (function)

Writers

(setf bzip2-state-t-position) (function)

Slot: k0

Initform

0

Readers

bzip2-state-k0 (function)

Writers

(setf bzip2-state-k0) (function)

Slot: unzftab

Type

(simple-array (unsigned-byte 32) (256))

Initform

(make-array 256 :element-type (quote (unsigned-byte 32)))

Readers

bzip2-state-unzftab (function)

Writers

(setf bzip2-state-unzftab) (function)

Slot: n-blocks-used

Initform

0

Readers

bzip2-state-n-blocks-used (function)

Writers

(setf bzip2-state-n-blocks-used) (function)

Slot: cftab

Type

(simple-array (unsigned-byte 32) (257))

Initform

(make-array 257 :element-type (quote (unsigned-byte 32)))

Readers

bzip2-state-cftab (function)

Writers

(setf bzip2-state-cftab) (function)

Slot: cftab-copy

Type

(simple-array (unsigned-byte 32) (257))

Initform

(make-array 257 :element-type (quote (unsigned-byte 32)))

Readers

bzip2-state-cftab-copy (function)

Writers

(setf bzip2-state-cftab-copy) (function)

Slot: tt

Type

(simple-array (unsigned-byte 32) (*))

Initform

(make-array 0 :element-type (quote (unsigned-byte 32)))

Readers

bzip2-state-tt (function)

Writers

(setf bzip2-state-tt) (function)

Slot: stored-block-crc

Type

(unsigned-byte 32)

Initform

0

Readers

bzip2-state-stored-block-crc (function)

Writers

(setf bzip2-state-stored-block-crc) (function)

Slot: stored-combined-crc

Type

(unsigned-byte 32)

Initform

0

Readers

bzip2-state-stored-combined-crc (function)

Writers

(setf bzip2-state-stored-combined-crc) (function)

Slot: calculated-block-crc

Type

(unsigned-byte 32)

Initform

4294967295

Readers

bzip2-state-calculated-block-crc (function)

Writers

(setf bzip2-state-calculated-block-crc) (function)

Slot: calculated-combined-crc

Type

(unsigned-byte 32)

Initform

0

Readers

bzip2-state-calculated-combined-crc (function)

Writers

(setf bzip2-state-calculated-combined-crc) (function)

Slot: n-in-use

Type

(integer 0 256)

Initform

0

Readers

bzip2-state-n-in-use (function)

Writers

(setf bzip2-state-n-in-use) (function)

Slot: in-use

Type

(simple-array t (256))

Initform

(make-array 256 :initial-element nil)

Readers

bzip2-state-in-use (function)

Writers

(setf bzip2-state-in-use) (function)

Slot: in-use-16

Type

(unsigned-byte 16)

Initform

0

Readers

bzip2-state-in-use-16 (function)

Writers

(setf bzip2-state-in-use-16) (function)

Slot: seq-to-unseq

Type

(simple-array (unsigned-byte 8) (256))

Initform

(make-array 256 :element-type (quote (unsigned-byte 8)))

Readers

bzip2-state-seq-to-unseq (function)

Writers

(setf bzip2-state-seq-to-unseq) (function)

Slot: mtfa

Type

(simple-array (unsigned-byte 8) (4096))

Initform

(make-array chipz::+mtfa-size+ :element-type (quote (unsigned-byte 8)))

Readers

bzip2-state-mtfa (function)

Writers

(setf bzip2-state-mtfa) (function)

Slot: mtfbase

Type

(simple-array (unsigned-byte 16) (16))

Initform

(make-array (/ 256 chipz::+mtfl-size+) :element-type (quote (unsigned-byte 16)))

Readers

bzip2-state-mtfbase (function)

Writers

(setf bzip2-state-mtfbase) (function)

Slot: selector

Type

(simple-array (unsigned-byte 8) (18002))

Initform

(make-array chipz::+bz-max-selectors+ :element-type (quote (unsigned-byte 8)))

Readers

bzip2-state-selector (function)

Writers

(setf bzip2-state-selector) (function)

Slot: selector-mtf

Type

(simple-array (unsigned-byte 8) (18002))

Initform

(make-array chipz::+bz-max-selectors+ :element-type (quote (unsigned-byte 8)))

Readers

bzip2-state-selector-mtf (function)

Writers

(setf bzip2-state-selector-mtf) (function)

Slot: len

Type

(simple-array (unsigned-byte 8) (6 258))

Initform

(make-array (quote (6 258)) :element-type (quote (unsigned-byte 8)))

Readers

bzip2-state-len (function)

Writers

(setf bzip2-state-len) (function)

Slot: mtf-continuation

Type

(or null function)

Readers

bzip2-state-mtf-continuation (function)

Writers

(setf bzip2-state-mtf-continuation) (function)

Slot: limit

Type

(simple-array t (6))

Initform

(let ((chipz::w (make-array chipz::+bz-n-groups+))) (dotimes (chipz::i chipz::+bz-n-groups+ chipz::w) (setf (aref chipz::w chipz::i) (make-array chipz::+bz-max-alpha-size+ :element-type (quote (unsigned-byte 32))))))

Readers

bzip2-state-limit (function)

Writers

(setf bzip2-state-limit) (function)

Slot: base

Type

(simple-array t (6))

Initform

(let ((chipz::w (make-array chipz::+bz-n-groups+))) (dotimes (chipz::i chipz::+bz-n-groups+ chipz::w) (setf (aref chipz::w chipz::i) (make-array chipz::+bz-max-alpha-size+ :element-type (quote (unsigned-byte 32))))))

Readers

bzip2-state-base (function)

Writers

(setf bzip2-state-base) (function)

Slot: perm

Type

(simple-array t (6))

Initform

(let ((chipz::w (make-array chipz::+bz-n-groups+))) (dotimes (chipz::i chipz::+bz-n-groups+ chipz::w) (setf (aref chipz::w chipz::i) (make-array chipz::+bz-max-alpha-size+ :element-type (quote (unsigned-byte 32))))))

Readers

bzip2-state-perm (function)

Writers

(setf bzip2-state-perm) (function)

Slot: min-lengths

Type

(simple-array (unsigned-byte 32) (6))

Initform

(make-array 6 :element-type (quote (unsigned-byte 32)))

Readers

bzip2-state-min-lengths (function)

Writers

(setf bzip2-state-min-lengths) (function)

Slot: i

Initform

0

Readers

bzip2-state-i (function)

Writers

(setf bzip2-state-i) (function)

Slot: j

Initform

0

Readers

bzip2-state-j (function)

Writers

(setf bzip2-state-j) (function)

Slot: alpha-size

Type

(integer 0 258)

Initform

0

Readers

bzip2-state-alpha-size (function)

Writers

(setf bzip2-state-alpha-size) (function)

Slot: n-groups

Initform

0

Readers

bzip2-state-n-groups (function)

Writers

(setf bzip2-state-n-groups) (function)

Slot: n-selectors

Initform

0

Readers

bzip2-state-n-selectors (function)

Writers

(setf bzip2-state-n-selectors) (function)

Slot: eob

Type

(integer 0 257)

Initform

0

Readers

bzip2-state-eob (function)

Writers

(setf bzip2-state-eob) (function)

Slot: group-number

Type

fixnum

Initform

0

Readers

bzip2-state-group-number (function)

Writers

(setf bzip2-state-group-number) (function)

Slot: group-position

Type

fixnum

Initform

0

Readers

bzip2-state-group-position (function)

Writers

(setf bzip2-state-group-position) (function)

Slot: lval

Type

fixnum

Initform

0

Readers

bzip2-state-lval (function)

Writers

(setf bzip2-state-lval) (function)

Slot: nblockmax

Type

(integer 0 900000)

Initform

0

Readers

bzip2-state-nblockmax (function)

Writers

(setf bzip2-state-nblockmax) (function)

Slot: nblock

Type

(integer 0 (900000))

Initform

0

Readers

bzip2-state-nblock (function)

Writers

(setf bzip2-state-nblock) (function)

Slot: es

Type

fixnum

Initform

0

Readers

bzip2-state-es (function)

Writers

(setf bzip2-state-es) (function)

Slot: n

Type

fixnum

Initform

0

Readers

bzip2-state-n (function)

Writers

(setf bzip2-state-n) (function)

Slot: curr

Type

(integer 0 20)

Initform

0

Readers

bzip2-state-curr (function)

Writers

(setf bzip2-state-curr) (function)

Slot: zn

Type

(integer 0 20)

Initform

0

Readers

bzip2-state-zn (function)

Writers

(setf bzip2-state-zn) (function)

Slot: zvec

Type

(integer 0 1048576)

Initform

0

Readers

bzip2-state-zvec (function)

Writers

(setf bzip2-state-zvec) (function)

Slot: g-minlen

Type

(integer 0 23)

Initform

0

Readers

bzip2-state-g-minlen (function)

Writers

(setf bzip2-state-g-minlen) (function)

Slot: g-limit

Type

(simple-array (unsigned-byte 32) (258))

Initform

chipz::*dummy-vec*

Readers

bzip2-state-g-limit (function)

Writers

(setf bzip2-state-g-limit) (function)

Slot: g-base

Type

(simple-array (unsigned-byte 32) (258))

Initform

chipz::*dummy-vec*

Readers

bzip2-state-g-base (function)

Writers

(setf bzip2-state-g-base) (function)

Slot: g-perm

Type

(simple-array (unsigned-byte 32) (258))

Initform

chipz::*dummy-vec*

Readers

bzip2-state-g-perm (function)

Writers

(setf bzip2-state-g-perm) (function)

Structure: decompression-state ()

Package

chipz

Source

dstate.lisp (file)

Direct superclasses

structure-object (structure)

Direct subclasses

• inflate-state (structure)
• bzip2-state (structure)

Direct methods

• decompress (method)
• decompress (method)
• decompress (method)
• decompress (method)
• decompress (method)
• decompress (method)
• decompress (method)
• decompress (method)

Direct slots

Slot: state

Type

(or null function)

Readers

dstate-state (function)

Writers

(setf dstate-state) (function)

Slot: done

Readers

dstate-done (function)

Writers

(setf dstate-done) (function)

Slot: input

Type

chipz::simple-octet-vector

Initform

(make-array 1 :element-type (quote (unsigned-byte 8)))

Readers

dstate-input (function)

Writers

(setf dstate-input) (function)

Slot: input-start

Type

(and fixnum (integer 0 *))

Initform

0

Readers

dstate-input-start (function)

Writers

(setf dstate-input-start) (function)

Slot: input-index

Type

(and fixnum (integer 0 *))

Initform

0

Readers

dstate-input-index (function)

Writers

(setf dstate-input-index) (function)

Slot: input-end

Type

(and fixnum (integer 0 *))

Initform

0

Readers

dstate-input-end (function)

Writers

(setf dstate-input-end) (function)

Slot: output

Type

chipz::simple-octet-vector

Initform

(make-array 1 :element-type (quote (unsigned-byte 8)))

Readers

dstate-output (function)

Writers

(setf dstate-output) (function)

Slot: output-start

Type

(and fixnum (integer 0 *))

Initform

0

Readers

dstate-output-start (function)

Writers

(setf dstate-output-start) (function)

Slot: output-index

Type

(and fixnum (integer 0 *))

Initform

0

Readers

dstate-output-index (function)

Writers

(setf dstate-output-index) (function)

Slot: output-end

Type

(and fixnum (integer 0 *))

Initform

0

Readers

dstate-output-end (function)

Writers

(setf dstate-output-end) (function)

Slot: checksum

Readers

dstate-checksum (function)

Writers

(setf dstate-checksum) (function)

Slot: update-checksum

Type

(or null function)

Readers

dstate-update-checksum (function)

Writers

(setf dstate-update-checksum) (function)

Slot: bits

Type

(unsigned-byte 32)

Initform

0

Readers

dstate-bits (function)

Writers

(setf dstate-bits) (function)

Slot: n-bits

Type

(integer 0 32)

Initform

0

Readers

dstate-n-bits (function)

Writers

(setf dstate-n-bits) (function)

Structure: inflate-state ()

Package

chipz

Source

inflate-state.lisp (file)

Direct superclasses

decompression-state (structure)

Direct methods

print-object (method)

Direct slots

Slot: final-block-p

Type

(member t nil)

Readers

inflate-state-final-block-p (function)

Writers

(setf inflate-state-final-block-p) (function)

Slot: length

Initform

0

Readers

inflate-state-length (function)

Writers

(setf inflate-state-length) (function)

Slot: distance

Initform

0

Readers

inflate-state-distance (function)

Writers

(setf inflate-state-distance) (function)

Slot: length-code

Type

(integer 0 28)

Initform

0

Readers

inflate-state-length-code (function)

Writers

(setf inflate-state-length-code) (function)

Slot: distance-code

Type

(integer 0 31)

Initform

0

Readers

inflate-state-distance-code (function)

Writers

(setf inflate-state-distance-code) (function)

Slot: n-length-codes

Initform

0

Readers

inflate-state-n-length-codes (function)

Writers

(setf inflate-state-n-length-codes) (function)

Slot: n-distance-codes

Initform

0

Readers

inflate-state-n-distance-codes (function)

Writers

(setf inflate-state-n-distance-codes) (function)

Slot: n-codes

Initform

0

Readers

inflate-state-n-codes (function)

Writers

(setf inflate-state-n-codes) (function)

Slot: n-values-read

Initform

0

Readers

inflate-state-n-values-read (function)

Writers

(setf inflate-state-n-values-read) (function)

Slot: code-lengths

Type

(simple-vector 288)

Initform

(make-array 288)

Readers

inflate-state-code-lengths (function)

Writers

(setf inflate-state-code-lengths) (function)

Slot: window

Type

chipz::sliding-window

Initform

(make-array 32768 :element-type (quote (unsigned-byte 8)))

Readers

inflate-state-window (function)

Writers

(setf inflate-state-window) (function)

Slot: window-index

Type

(mod 32768)

Initform

0

Readers

inflate-state-window-index (function)

Writers

(setf inflate-state-window-index) (function)

Slot: codes-table

Readers

inflate-state-codes-table (function)

Writers

(setf inflate-state-codes-table) (function)

Slot: literal/length-table

Type

chipz::huffman-decode-table

Initform

chipz::*fixed-literal/length-table*

Readers

inflate-state-literal/length-table (function)

Writers

(setf inflate-state-literal/length-table) (function)

Slot: distance-table

Type

chipz::huffman-decode-table

Initform

chipz::*fixed-distance-table*

Readers

inflate-state-distance-table (function)

Writers

(setf inflate-state-distance-table) (function)

Slot: header

Readers

inflate-state-header (function)

Writers

(setf inflate-state-header) (function)

Slot: data-format

Type

(member chipz:deflate chipz:zlib chipz:gzip)

Initform

(quote chipz:deflate)

Readers

inflate-state-data-format (function)

Writers

(setf inflate-state-data-format) (function)

5.2 Internal definitions

5.2.1 Constants

Constant: +100k+

Package

chipz

Source

constants.lisp (file)

Constant: +block-dynamic-codes+

Package

chipz

Source

constants.lisp (file)

Constant: +block-fixed-codes+

Package

chipz

Source

constants.lisp (file)

Constant: +block-invalid+

Package

chipz

Source

constants.lisp (file)

Constant: +block-no-compress+

Package

chipz

Source

constants.lisp (file)

Constant: +bz-g-size+

Package

chipz

Source

constants.lisp (file)

Constant: +bz-header-0+

Package

chipz

Source

constants.lisp (file)

Constant: +bz-header-b+

Package

chipz

Source

constants.lisp (file)

Constant: +bz-header-h+

Package

chipz

Source

constants.lisp (file)

Constant: +bz-header-z+

Package

chipz

Source

constants.lisp (file)

Constant: +bz-max-alpha-size+

Package

chipz

Source

constants.lisp (file)

Constant: +bz-max-code-len+

Package

chipz

Source

constants.lisp (file)

Constant: +bz-max-selectors+

Package

chipz

Source

constants.lisp (file)

Constant: +bz-n-groups+

Package

chipz

Source

constants.lisp (file)

Constant: +bz-n-iters+

Package

chipz

Source

constants.lisp (file)

Constant: +bz-runa+

Package

chipz

Source

constants.lisp (file)

Constant: +bz-runb+

Package

chipz

Source

constants.lisp (file)

Constant: +bzip2-crc32-table+

Package

chipz

Source

constants.lisp (file)

Constant: +crc32-table+

Package

chipz

Source

constants.lisp (file)

Constant: +default-buffer-size+

Package

chipz

Source

constants.lisp (file)