The chipz Reference Manual

3.1.1 chipz/chipz.asd

Source

chipz.asd.

Parent Component

chipz (system).

ASDF Systems

chipz.

Packages

chipz-system.

Internals

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

---

3.1.2 chipz/package.lisp

Source

chipz.asd.

Parent Component

chipz (system).

Packages

chipz.

---

3.1.3 chipz/constants.lisp

Dependency

package.lisp (file).

Source

chipz.asd.

Parent Component

chipz (system).

Internals

• +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).

Source

chipz.asd.

Parent Component

chipz (system).

Internals

• *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 (reader).
• (setf code-end-value) (writer).
• code-n-bits (reader).
• (setf code-n-bits) (writer).
• code-n-values (function).
• code-range-descriptor (structure).
• code-range-descriptor-p (function).
• code-start-value (reader).
• (setf code-start-value) (writer).
• 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 (reader).
• hdt-counts (reader).
• hdt-offsets (reader).
• hdt-symbols (reader).
• 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).

Source

chipz.asd.

Parent Component

chipz (system).

Internals

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

---

3.1.6 chipz/adler32.lisp

Dependency

types-and-tables.lisp (file).

Source

chipz.asd.

Parent Component

chipz (system).

Internals

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

---

3.1.7 chipz/conditions.lisp

Dependency

package.lisp (file).

Source

chipz.asd.

Parent Component

chipz (system).

Public Interface

• 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).

Internals

• actual-checksum (reader method).
• checksum-kind (reader method).
• code-lengths-bounds-error (condition).
• code-lengths-start-with-repetition-error (condition).
• expected-checksum (reader method).
• illegal-code (reader method).
• illegal-code (reader method).
• illegal-distance-code-error (condition).
• illegal-length-code-error (condition).
• invalid-format (reader method).
• unassigned-huffman-code-error (condition).

---

3.1.8 chipz/dstate.lisp

Dependency

package.lisp (file).

Source

chipz.asd.

Parent Component

chipz (system).

Public Interface

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

Internals

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

---

3.1.9 chipz/inflate-state.lisp

Dependencies

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

Source

chipz.asd.

Parent Component

chipz (system).

Public Interface

• finish-inflate-state (function).
• inflate-state (structure).
• make-inflate-state (function).
• print-object (method).

Internals

• %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 (reader).
• (setf inflate-state-code-lengths) (writer).
• inflate-state-codes-table (reader).
• (setf inflate-state-codes-table) (writer).
• inflate-state-data-format (reader).
• (setf inflate-state-data-format) (writer).
• inflate-state-distance (reader).
• (setf inflate-state-distance) (writer).
• inflate-state-distance-code (reader).
• (setf inflate-state-distance-code) (writer).
• inflate-state-distance-table (reader).
• (setf inflate-state-distance-table) (writer).
• inflate-state-done (function).
• (setf inflate-state-done) (function).
• inflate-state-final-block-p (reader).
• (setf inflate-state-final-block-p) (writer).
• inflate-state-header (reader).
• (setf inflate-state-header) (writer).
• 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 (reader).
• (setf inflate-state-length) (writer).
• inflate-state-length-code (reader).
• (setf inflate-state-length-code) (writer).
• inflate-state-literal/length-table (reader).
• (setf inflate-state-literal/length-table) (writer).
• inflate-state-n-bits (function).
• (setf inflate-state-n-bits) (function).
• inflate-state-n-codes (reader).
• (setf inflate-state-n-codes) (writer).
• inflate-state-n-distance-codes (reader).
• (setf inflate-state-n-distance-codes) (writer).
• inflate-state-n-length-codes (reader).
• (setf inflate-state-n-length-codes) (writer).
• inflate-state-n-values-read (reader).
• (setf inflate-state-n-values-read) (writer).
• 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 (reader).
• (setf inflate-state-window) (writer).
• inflate-state-window-index (reader).
• (setf inflate-state-window-index) (writer).
• sliding-window (type).

---

3.1.10 chipz/gzip.lisp

Dependencies

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

Source

chipz.asd.

Parent Component

chipz (system).

Internals

• +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 (reader method).
• (setf comment) (writer method).
• compression-method (reader method).
• (setf compression-method) (writer method).
• crc16 (reader method).
• (setf crc16) (writer method).
• extra-flags (reader method).
• (setf extra-flags) (writer method).
• filename (reader method).
• (setf filename) (writer method).
• flags (reader method).
• (setf flags) (writer method).
• gzip-header (class).
• mtime (reader method).
• (setf mtime) (writer method).
• os (reader method).
• (setf os) (writer method).
• write-date (reader method).
• (setf write-date) (writer method).

---

3.1.11 chipz/zlib.lisp

Dependencies

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

Source

chipz.asd.

Parent Component

chipz (system).

Internals

• +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 (reader method).
• (setf adler32) (writer method).
• cmf (reader method).
• (setf cmf) (writer method).
• fdict (reader method).
• (setf fdict) (writer method).
• flags (reader method).
• (setf flags) (writer 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).

Source

chipz.asd.

Parent Component

chipz (system).

Internals

• %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).

Source

chipz.asd.

Parent Component

chipz (system).

Public Interface

• bzip2-state (structure).
• print-object (method).

Internals

• %bzip2-decompress (function).
• %bzip2-state-machine (function).
• %make-bzip2-state (function).
• *dummy-vec* (special variable).
• bzip2-state-100k-block-size (reader).
• (setf bzip2-state-100k-block-size) (writer).
• bzip2-state-alpha-size (reader).
• (setf bzip2-state-alpha-size) (writer).
• bzip2-state-base (reader).
• (setf bzip2-state-base) (writer).
• bzip2-state-bits (function).
• (setf bzip2-state-bits) (function).
• bzip2-state-block-randomized-p (reader).
• (setf bzip2-state-block-randomized-p) (writer).
• bzip2-state-calculated-block-crc (reader).
• (setf bzip2-state-calculated-block-crc) (writer).
• bzip2-state-calculated-combined-crc (reader).
• (setf bzip2-state-calculated-combined-crc) (writer).
• bzip2-state-cftab (reader).
• (setf bzip2-state-cftab) (writer).
• bzip2-state-cftab-copy (reader).
• (setf bzip2-state-cftab-copy) (writer).
• bzip2-state-checksum (function).
• (setf bzip2-state-checksum) (function).
• bzip2-state-curr (reader).
• (setf bzip2-state-curr) (writer).
• bzip2-state-current-block-number (reader).
• (setf bzip2-state-current-block-number) (writer).
• bzip2-state-done (function).
• (setf bzip2-state-done) (function).
• bzip2-state-eob (reader).
• (setf bzip2-state-eob) (writer).
• bzip2-state-es (reader).
• (setf bzip2-state-es) (writer).
• bzip2-state-g-base (reader).
• (setf bzip2-state-g-base) (writer).
• bzip2-state-g-limit (reader).
• (setf bzip2-state-g-limit) (writer).
• bzip2-state-g-minlen (reader).
• (setf bzip2-state-g-minlen) (writer).
• bzip2-state-g-perm (reader).
• (setf bzip2-state-g-perm) (writer).
• bzip2-state-group-number (reader).
• (setf bzip2-state-group-number) (writer).
• bzip2-state-group-position (reader).
• (setf bzip2-state-group-position) (writer).
• bzip2-state-i (reader).
• (setf bzip2-state-i) (writer).
• bzip2-state-in-use (reader).
• (setf bzip2-state-in-use) (writer).
• bzip2-state-in-use-16 (reader).
• (setf bzip2-state-in-use-16) (writer).
• 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 (reader).
• (setf bzip2-state-j) (writer).
• bzip2-state-k0 (reader).
• (setf bzip2-state-k0) (writer).
• bzip2-state-len (reader).
• (setf bzip2-state-len) (writer).
• bzip2-state-limit (reader).
• (setf bzip2-state-limit) (writer).
• bzip2-state-lval (reader).
• (setf bzip2-state-lval) (writer).
• bzip2-state-min-lengths (reader).
• (setf bzip2-state-min-lengths) (writer).
• bzip2-state-mtf-continuation (reader).
• (setf bzip2-state-mtf-continuation) (writer).
• bzip2-state-mtfa (reader).
• (setf bzip2-state-mtfa) (writer).
• bzip2-state-mtfbase (reader).
• (setf bzip2-state-mtfbase) (writer).
• bzip2-state-n (reader).
• (setf bzip2-state-n) (writer).
• bzip2-state-n-bits (function).
• (setf bzip2-state-n-bits) (function).
• bzip2-state-n-blocks-used (reader).
• (setf bzip2-state-n-blocks-used) (writer).
• bzip2-state-n-groups (reader).
• (setf bzip2-state-n-groups) (writer).
• bzip2-state-n-in-use (reader).
• (setf bzip2-state-n-in-use) (writer).
• bzip2-state-n-selectors (reader).
• (setf bzip2-state-n-selectors) (writer).
• bzip2-state-nblock (reader).
• (setf bzip2-state-nblock) (writer).
• bzip2-state-nblockmax (reader).
• (setf bzip2-state-nblockmax) (writer).
• bzip2-state-original-pointer (reader).
• (setf bzip2-state-original-pointer) (writer).
• bzip2-state-out-ch (reader).
• (setf bzip2-state-out-ch) (writer).
• bzip2-state-out-len (reader).
• (setf bzip2-state-out-len) (writer).
• 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 (reader).
• (setf bzip2-state-perm) (writer).
• bzip2-state-rntogo (reader).
• (setf bzip2-state-rntogo) (writer).
• bzip2-state-rntpos (reader).
• (setf bzip2-state-rntpos) (writer).
• bzip2-state-selector (reader).
• (setf bzip2-state-selector) (writer).
• bzip2-state-selector-mtf (reader).
• (setf bzip2-state-selector-mtf) (writer).
• bzip2-state-seq-to-unseq (reader).
• (setf bzip2-state-seq-to-unseq) (writer).
• bzip2-state-small-decompression-p (reader).
• (setf bzip2-state-small-decompression-p) (writer).
• bzip2-state-state (function).
• (setf bzip2-state-state) (function).
• bzip2-state-stored-block-crc (reader).
• (setf bzip2-state-stored-block-crc) (writer).
• bzip2-state-stored-combined-crc (reader).
• (setf bzip2-state-stored-combined-crc) (writer).
• bzip2-state-t-position (reader).
• (setf bzip2-state-t-position) (writer).
• bzip2-state-tt (reader).
• (setf bzip2-state-tt) (writer).
• bzip2-state-unzftab (reader).
• (setf bzip2-state-unzftab) (writer).
• bzip2-state-update-checksum (function).
• (setf bzip2-state-update-checksum) (function).
• bzip2-state-zn (reader).
• (setf bzip2-state-zn) (writer).
• bzip2-state-zvec (reader).
• (setf bzip2-state-zvec) (writer).
• 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).

Source

chipz.asd.

Parent Component

chipz (system).

Public Interface

decompress (generic function).

Internals

• %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).

Source

chipz.asd.

Parent Component

chipz (system).

Public Interface

• make-decompressing-stream (function).
• stream-read-byte (method).
• stream-read-sequence (method).

Internals

• *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 (reader method).
• dstate (reader method).
• input-available-p (function).
• input-buffer (reader method).
• input-buffer-index (reader method).
• (setf input-buffer-index) (writer method).
• input-buffer-n-bytes (reader method).
• (setf input-buffer-n-bytes) (writer method).
• output-available-p (function).
• output-buffer (reader method).
• output-buffer-index (reader method).
• (setf output-buffer-index) (writer method).
• output-buffer-n-bytes (reader method).
• (setf output-buffer-n-bytes) (writer method).
• read-and-decompress-byte (function).
• refill-stream-input-buffer (function).
• refill-stream-output-buffer (function).
• wrapped-stream (reader method).

---

3.2.1 chipz/doc/index.html

Source

chipz.asd.

Parent Component

doc (module).

---

3.3.1 chipz/doc/chipz-doc.txt

Source

chipz.asd.

Parent Component

doc (module).

---

3.3.2 chipz/doc/style.css

Source

chipz.asd.

Parent Component

doc (module).

---

3.4.1 chipz/NEWS

Source

chipz.asd.

Parent Component

chipz (system).

---

3.4.2 chipz/LICENSE

Source

chipz.asd.

Parent Component

chipz (system).

---

3.4.3 chipz/TODO

Source

chipz.asd.

Parent Component

chipz (system).

---

5.1.1 Ordinary functions

Function: finish-dstate (state) ¶

Package

chipz.

Source

dstate.lisp.

Function: finish-inflate-state (state) ¶

Package

chipz.

Source

inflate-state.lisp.

Function: make-decompressing-stream (format stream) ¶

Package

chipz.

Source

stream.lisp.

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.

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.

---

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.

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 Standalone methods

Method: print-object ((object bzip2-state) stream) ¶

Source

bzip2.lisp.

Method: print-object ((object inflate-state) stream) ¶

Source

inflate-state.lisp.

Method: stream-read-byte ((stream decompressing-stream)) ¶

Package

sb-gray.

Source

stream.lisp.

Method: stream-read-sequence ((stream decompressing-stream) seq &optional start end) ¶

Package

sb-gray.

Source

stream.lisp.

---

5.1.4 Conditions

Condition: bzip2-error ¶

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

Package

chipz.

Source

conditions.lisp.

Direct superclasses

decompression-error.

Direct subclasses

invalid-bzip2-data.

Condition: chipz-error ¶

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

Package

chipz.

Source

conditions.lisp.

Direct superclasses

simple-error.

Direct subclasses

• decompression-error.
• invalid-format-error.

Condition: decompression-error ¶

The base condition of all conditions signaled during decompression.

Package

chipz.

Source

conditions.lisp.

Direct superclasses

chipz-error.

Direct subclasses

• bzip2-error.
• inflate-error.
• invalid-checksum-error.
• premature-end-of-stream.

Condition: inflate-error ¶

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

Package

chipz.

Source

conditions.lisp.

Direct superclasses

decompression-error.

Direct subclasses

• code-lengths-bounds-error.
• code-lengths-start-with-repetition-error.
• illegal-distance-code-error.
• illegal-length-code-error.
• invalid-gzip-header-error.
• invalid-stored-block-length-error.
• invalid-zlib-header-error.
• reserved-block-type-error.
• unassigned-huffman-code-error.

Condition: invalid-bzip2-data ¶

Signaled when invalid bzip2 data is found.

Package

chipz.

Source

conditions.lisp.

Direct superclasses

bzip2-error.

Condition: invalid-checksum-error ¶

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

Package

chipz.

Source

conditions.lisp.

Direct superclasses

decompression-error.

Direct methods

• actual-checksum.
• checksum-kind.
• expected-checksum.

Direct slots

Slot: expected-checksum ¶

Initargs

:stored

Readers

expected-checksum.

Writers

This slot is read-only.

Slot: actual-checksum ¶

Initargs

:computed

Readers

actual-checksum.

Writers

This slot is read-only.

Slot: kind ¶

Initargs

:kind

Readers

checksum-kind.

Writers

This slot is read-only.

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.

Direct superclasses

chipz-error.

Direct methods

invalid-format.

Direct slots

Slot: format ¶

Package

common-lisp.

Initargs

:format

Readers

invalid-format.

Writers

This slot is read-only.

Condition: invalid-gzip-header-error ¶

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

Package

chipz.

Source

conditions.lisp.

Direct superclasses

inflate-error.

Condition: invalid-stored-block-length-error ¶

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

Package

chipz.

Source

conditions.lisp.

Direct superclasses

inflate-error.

Condition: invalid-zlib-header-error ¶

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

Package

chipz.

Source

conditions.lisp.

Direct superclasses

inflate-error.

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.

Direct superclasses

decompression-error.

Condition: reserved-block-type-error ¶

Signaled when an invalid deflate block is found.

Package

chipz.

Source

conditions.lisp.

Direct superclasses

inflate-error.

---

5.1.5 Structures

Structure: bzip2-state ¶

Package

chipz.

Source

bzip2.lisp.

Direct superclasses

decompression-state.

Direct methods

print-object.

Direct slots

Slot: out-ch ¶

Type

(unsigned-byte 8)

Initform

0

Readers

bzip2-state-out-ch.

Writers

(setf bzip2-state-out-ch).

Slot: out-len ¶

Type

(integer 0 260)

Initform

0

Readers

bzip2-state-out-len.

Writers

(setf bzip2-state-out-len).

Slot: block-randomized-p ¶

Readers

bzip2-state-block-randomized-p.

Writers

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

Slot: rntogo ¶

Type

(unsigned-byte 32)

Initform

0

Readers

bzip2-state-rntogo.

Writers

(setf bzip2-state-rntogo).

Slot: rntpos ¶

Type

(unsigned-byte 32)

Initform

0

Readers

bzip2-state-rntpos.

Writers

(setf bzip2-state-rntpos).

Slot: 100k-block-size ¶

Type

(integer 1 9)

Initform

1

Readers

bzip2-state-100k-block-size.

Writers

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

Slot: small-decompression-p ¶

Readers

bzip2-state-small-decompression-p.

Writers

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

Slot: current-block-number ¶

Initform

0

Readers

bzip2-state-current-block-number.

Writers

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

Slot: original-pointer ¶

Initform

0

Readers

bzip2-state-original-pointer.

Writers

(setf bzip2-state-original-pointer).

Slot: t-position ¶

Type

(integer 0 (900000))

Initform

0

Readers

bzip2-state-t-position.

Writers

(setf bzip2-state-t-position).

Slot: k0 ¶

Initform

0

Readers

bzip2-state-k0.

Writers

(setf bzip2-state-k0).

Slot: unzftab ¶

Type

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

Initform

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

Readers

bzip2-state-unzftab.

Writers

(setf bzip2-state-unzftab).

Slot: n-blocks-used ¶

Initform

0

Readers

bzip2-state-n-blocks-used.

Writers

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

Slot: cftab ¶

Type

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

Initform

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

Readers

bzip2-state-cftab.

Writers

(setf bzip2-state-cftab).

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.

Writers

(setf bzip2-state-cftab-copy).

Slot: tt ¶

Type

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

Initform

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

Readers

bzip2-state-tt.

Writers

(setf bzip2-state-tt).

Slot: stored-block-crc ¶

Type

(unsigned-byte 32)

Initform

0

Readers

bzip2-state-stored-block-crc.

Writers

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

Slot: stored-combined-crc ¶

Type

(unsigned-byte 32)

Initform

0

Readers

bzip2-state-stored-combined-crc.

Writers

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

Slot: calculated-block-crc ¶

Type

(unsigned-byte 32)

Initform

4294967295

Readers

bzip2-state-calculated-block-crc.

Writers

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

Slot: calculated-combined-crc ¶

Type

(unsigned-byte 32)

Initform

0

Readers

bzip2-state-calculated-combined-crc.

Writers

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

Slot: n-in-use ¶

Type

(integer 0 256)

Initform

0

Readers

bzip2-state-n-in-use.

Writers

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

Slot: in-use ¶

Type

(simple-array t (256))

Initform

(make-array 256 :initial-element nil)

Readers

bzip2-state-in-use.

Writers

(setf bzip2-state-in-use).

Slot: in-use-16 ¶

Type

(unsigned-byte 16)

Initform

0

Readers

bzip2-state-in-use-16.

Writers

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

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.

Writers

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

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.

Writers

(setf bzip2-state-mtfa).

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.

Writers

(setf bzip2-state-mtfbase).

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.

Writers

(setf bzip2-state-selector).

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.

Writers

(setf bzip2-state-selector-mtf).

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.

Writers

(setf bzip2-state-len).

Slot: mtf-continuation ¶

Type

(or null function)

Readers

bzip2-state-mtf-continuation.

Writers

(setf bzip2-state-mtf-continuation).

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.

Writers

(setf bzip2-state-limit).

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.

Writers

(setf bzip2-state-base).

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.

Writers

(setf bzip2-state-perm).

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.

Writers

(setf bzip2-state-min-lengths).

Slot: i ¶

Initform

0

Readers

bzip2-state-i.

Writers

(setf bzip2-state-i).

Slot: j ¶

Initform

0

Readers

bzip2-state-j.

Writers

(setf bzip2-state-j).

Slot: alpha-size ¶

Type

(integer 0 258)

Initform

0

Readers

bzip2-state-alpha-size.

Writers

(setf bzip2-state-alpha-size).

Slot: n-groups ¶

Initform

0

Readers

bzip2-state-n-groups.

Writers

(setf bzip2-state-n-groups).

Slot: n-selectors ¶

Initform

0

Readers

bzip2-state-n-selectors.

Writers

(setf bzip2-state-n-selectors).

Slot: eob ¶

Type

(integer 0 257)

Initform

0

Readers

bzip2-state-eob.

Writers

(setf bzip2-state-eob).

Slot: group-number ¶

Type

fixnum

Initform

0

Readers

bzip2-state-group-number.

Writers

(setf bzip2-state-group-number).

Slot: group-position ¶

Type

fixnum

Initform

0

Readers

bzip2-state-group-position.

Writers

(setf bzip2-state-group-position).

Slot: lval ¶

Type

fixnum

Initform

0

Readers

bzip2-state-lval.

Writers

(setf bzip2-state-lval).

Slot: nblockmax ¶

Type

(integer 0 900000)

Initform

0

Readers

bzip2-state-nblockmax.

Writers

(setf bzip2-state-nblockmax).

Slot: nblock ¶

Type

(integer 0 900000)

Initform

0

Readers

bzip2-state-nblock.

Writers

(setf bzip2-state-nblock).

Slot: es ¶

Type

fixnum

Initform

0

Readers

bzip2-state-es.

Writers

(setf bzip2-state-es).

Slot: n ¶

Type

fixnum

Initform

0

Readers

bzip2-state-n.

Writers

(setf bzip2-state-n).

Slot: curr ¶

Type

(integer 0 20)

Initform

0

Readers

bzip2-state-curr.

Writers

(setf bzip2-state-curr).

Slot: zn ¶

Type

(integer 0 20)

Initform

0

Readers

bzip2-state-zn.

Writers

(setf bzip2-state-zn).

Slot: zvec ¶

Type

(integer 0 1048576)

Initform

0

Readers

bzip2-state-zvec.

Writers

(setf bzip2-state-zvec).

Slot: g-minlen ¶

Type

(integer 0 23)

Initform

0

Readers

bzip2-state-g-minlen.

Writers

(setf bzip2-state-g-minlen).

Slot: g-limit ¶

Type

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

Initform

chipz::*dummy-vec*

Readers

bzip2-state-g-limit.

Writers

(setf bzip2-state-g-limit).

Slot: g-base ¶

Type

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

Initform

chipz::*dummy-vec*

Readers

bzip2-state-g-base.

Writers

(setf bzip2-state-g-base).

Slot: g-perm ¶

Type

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

Initform

chipz::*dummy-vec*

Readers

bzip2-state-g-perm.

Writers

(setf bzip2-state-g-perm).

Structure: decompression-state ¶

Package

chipz.

Source

dstate.lisp.

Direct superclasses

structure-object.

Direct subclasses

• bzip2-state.
• inflate-state.

Direct methods

• decompress.
• decompress.
• decompress.
• decompress.
• decompress.
• decompress.
• decompress.
• decompress.

Direct slots

Slot: state ¶

Type

(or null function)

Readers

dstate-state.

Writers

(setf dstate-state).

Slot: done ¶

Readers

dstate-done.

Writers

(setf dstate-done).

Slot: input ¶

Type

chipz::simple-octet-vector

Initform

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

Readers

dstate-input.

Writers

(setf dstate-input).

Slot: input-start ¶

Type

(and fixnum (integer 0 *))

Initform

0

Readers

dstate-input-start.

Writers

(setf dstate-input-start).

Slot: input-index ¶

Type

(and fixnum (integer 0 *))

Initform

0

Readers

dstate-input-index.

Writers

(setf dstate-input-index).

Slot: input-end ¶

Type

(and fixnum (integer 0 *))

Initform

0

Readers

dstate-input-end.

Writers

(setf dstate-input-end).

Slot: output ¶

Type

chipz::simple-octet-vector

Initform

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

Readers

dstate-output.

Writers

(setf dstate-output).

Slot: output-start ¶

Type

(and fixnum (integer 0 *))

Initform

0

Readers

dstate-output-start.

Writers

(setf dstate-output-start).

Slot: output-index ¶

Type

(and fixnum (integer 0 *))

Initform

0

Readers

dstate-output-index.

Writers

(setf dstate-output-index).

Slot: output-end ¶

Type

(and fixnum (integer 0 *))

Initform

0

Readers

dstate-output-end.

Writers

(setf dstate-output-end).

Slot: checksum ¶

Readers

dstate-checksum.

Writers

(setf dstate-checksum).

Slot: update-checksum ¶

Type

(or null function)

Readers

dstate-update-checksum.

Writers

(setf dstate-update-checksum).

Slot: bits ¶

Type

(unsigned-byte 32)

Initform

0

Readers

dstate-bits.

Writers

(setf dstate-bits).

Slot: n-bits ¶

Type

(integer 0 32)

Initform

0

Readers

dstate-n-bits.

Writers

(setf dstate-n-bits).

Structure: inflate-state ¶

Package

chipz.

Source

inflate-state.lisp.

Direct superclasses

decompression-state.

Direct methods

print-object.

Direct slots

Slot: final-block-p ¶

Type

(member t nil)

Readers

inflate-state-final-block-p.

Writers

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

Slot: length ¶

Package

common-lisp.

Initform

0

Readers

inflate-state-length.

Writers

(setf inflate-state-length).

Slot: distance ¶

Initform

0

Readers

inflate-state-distance.

Writers

(setf inflate-state-distance).

Slot: length-code ¶

Type

(integer 0 28)

Initform

0

Readers

inflate-state-length-code.

Writers

(setf inflate-state-length-code).

Slot: distance-code ¶

Type

(integer 0 31)

Initform

0

Readers

inflate-state-distance-code.

Writers

(setf inflate-state-distance-code).

Slot: n-length-codes ¶

Initform

0

Readers

inflate-state-n-length-codes.

Writers

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

Slot: n-distance-codes ¶

Initform

0

Readers

inflate-state-n-distance-codes.

Writers

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

Slot: n-codes ¶

Initform

0

Readers

inflate-state-n-codes.

Writers

(setf inflate-state-n-codes).

Slot: n-values-read ¶

Initform

0

Readers

inflate-state-n-values-read.

Writers

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

Slot: code-lengths ¶

Type

(simple-vector 320)

Initform

(make-array 320)

Readers

inflate-state-code-lengths.

Writers

(setf inflate-state-code-lengths).

Slot: window ¶

Type

chipz::sliding-window

Initform

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

Readers

inflate-state-window.

Writers

(setf inflate-state-window).

Slot: window-index ¶

Type

(mod 32768)

Initform

0

Readers

inflate-state-window-index.

Writers

(setf inflate-state-window-index).

Slot: codes-table ¶

Readers

inflate-state-codes-table.

Writers

(setf inflate-state-codes-table).

Slot: literal/length-table ¶

Type

chipz::huffman-decode-table

Initform

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

Readers

inflate-state-literal/length-table.

Writers

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

Slot: distance-table ¶

Type

chipz::huffman-decode-table

Initform

chipz::*fixed-distance-table*

Readers

inflate-state-distance-table.

Writers

(setf inflate-state-distance-table).

Slot: header ¶

Readers

inflate-state-header.

Writers

(setf inflate-state-header).

Slot: data-format ¶

Type

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

Initform

(quote chipz:deflate)

Readers

inflate-state-data-format.

Writers

(setf inflate-state-data-format).

---

5.2.1 Constants

Constant: +100k+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +block-dynamic-codes+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +block-fixed-codes+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +block-invalid+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +block-no-compress+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +bz-g-size+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +bz-header-0+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +bz-header-b+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +bz-header-h+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +bz-header-z+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +bz-max-alpha-size+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +bz-max-code-len+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +bz-max-selectors+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +bz-n-groups+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +bz-n-iters+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +bz-runa+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +bz-runb+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +bzip2-crc32-table+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +crc32-table+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +default-buffer-size+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +deflate-max-bits+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +gzip-deflate-method+ ¶

Package

chipz.

Source

gzip.lisp.

Constant: +gzip-flag-comment+ ¶

Package

chipz.

Source

gzip.lisp.

Constant: +gzip-flag-crc+ ¶

Package

chipz.

Source

gzip.lisp.

Constant: +gzip-flag-extra+ ¶

Package

chipz.

Source

gzip.lisp.

Constant: +gzip-flag-name+ ¶

Package

chipz.

Source

gzip.lisp.

Constant: +gzip-flag-text+ ¶

Package

chipz.

Source

gzip.lisp.

Constant: +gzip-xfl-fast-compression+ ¶

Package

chipz.

Source

gzip.lisp.

Constant: +gzip-xfl-max-compression+ ¶

Package

chipz.

Source

gzip.lisp.

Constant: +length-code-base-lengths+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +length-code-extra-bits+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +max-code-length+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +max-codes+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +max-n-code-lengths+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +mtfa-size+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +mtfl-size+ ¶

Package

chipz.

Source

constants.lisp.

Constant: +zlib-compression-method+ ¶

Package

chipz.

Source

zlib.lisp.

Constant: +zlib-flag-fdict+ ¶

Package

chipz.

Source

zlib.lisp.

Constant: +zlib-flevel-default+ ¶

Package

chipz.

Source

zlib.lisp.

Constant: +zlib-flevel-fast+ ¶

Package

chipz.

Source

zlib.lisp.

Constant: +zlib-flevel-fastest+ ¶

Package

chipz.

Source

zlib.lisp.

Constant: +zlib-flevel-maximum+ ¶

Package

chipz.

Source

zlib.lisp.

Constant: adler32-modulo ¶

Package

chipz.

Source

constants.lisp.

---