The gzip-stream Reference Manual

Table of Contents

The gzip-stream Reference Manual

This is the gzip-stream Reference Manual, version 0.2.8, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 11:05:05 2021 GMT+0.

1 Systems

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

1.1 gzip-stream

Version

0.2.8

Dependencies

• salza2
• flexi-streams
• trivial-gray-streams

Source

gzip-stream.asd (file)

Components

• package.lisp (file)
• ifstar.lisp (file)
• inflate.lisp (file)
• gzip-stream.lisp (file)
• gzip.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 gzip-stream.asd

Location

gzip-stream.asd

Systems

gzip-stream (system)

Packages

gzip-system

2.1.2 gzip-stream/package.lisp

Parent

gzip-stream (system)

Location

package.lisp

Packages

gzip-stream

2.1.3 gzip-stream/ifstar.lisp

Dependency

package.lisp (file)

Parent

gzip-stream (system)

Location

ifstar.lisp

Internal Definitions

• if* (macro)
• if*-keyword-list (special variable)

2.1.4 gzip-stream/inflate.lisp

Dependency

ifstar.lisp (file)

Parent

gzip-stream (system)

Location

inflate.lisp

Internal Definitions

• *base-distance* (special variable)
• *base-length* (special variable)
• *code-index* (special variable)
• *distance-extra-bits* (special variable)
• *fixed-huffman-distance-tree* (special variable)
• *fixed-huffman-tree* (special variable)
• *length-extra-bits* (special variable)
• *maskarray* (special variable)
• bit-reader (structure)
• bit-reader-bits (function)
• (setf bit-reader-bits) (function)
• bit-reader-last-byte (function)
• (setf bit-reader-last-byte) (function)
• bit-reader-p (function)
• bit-reader-stream (function)
• (setf bit-reader-stream) (function)
• bitinfo-bitwidth (function)
• (setf bitinfo-bitwidth) (function)
• bitinfo-maxval (function)
• (setf bitinfo-maxval) (function)
• bitinfo-minval (function)
• (setf bitinfo-minval) (function)
• build-huffman-tree (function)
• copy-bit-reader (function)
• decode-huffman-tree (function)
• flush-buffer (function)
• generate-huffman-tree (function)
• generate-huffman-tree-from-vector (function)
• gz_ascii_flags (constant)
• gz_comment (constant)
• gz_extra_field (constant)
• gz_head_crc (constant)
• gz_orig_name (constant)
• gz_reserved (constant)
• inflate (function)
• make-bit-reader (function)
• make-bitinfo (function)
• new-bit-reader (function)
• process-deflate-block (function)
• process-dynamic-huffman-block (function)
• process-fixed-huffman-block (function)
• process-huffman-block (function)
• process-non-compressed-block (function)
• put-byte-in-buffer (function)
• read-bits (function)
• read-uword (function)
• reset-bit-reader (function)
• skip-gzip-header (function)
• split-on-position (function)
• z_deflated (constant)

2.1.5 gzip-stream/gzip-stream.lisp

Dependency

inflate.lisp (file)

Parent

gzip-stream (system)

Location

gzip-stream.lisp

Exported Definitions

• gunzip (function)
• gzip (function)
• gzip-input-stream (class)
• gzip-output-stream (class)
• make-gzip-input-stream (function)
• make-gzip-output-stream (function)
• with-open-gzip-file (macro)

Internal Definitions

• +buffer-size+ (constant)
• bit-reader-of (method)
• (setf bit-reader-of) (method)
• compress-buffer (method)
• (setf compress-buffer) (method)
• data-buffer-of (method)
• (setf data-buffer-of) (method)
• deflate-stream (method)
• (setf deflate-stream) (method)
• fill-buffer (function)
• input-pos (method)
• (setf input-pos) (method)
• make-buffer (function)
• read-buffer-of (method)
• (setf read-buffer-of) (method)
• under-file (method)
• (setf under-file) (method)
• underfile-of (method)
• (setf underfile-of) (method)

2.1.6 gzip-stream/gzip.lisp

Dependency

gzip-stream.lisp (file)

Parent

gzip-stream (system)

Location

gzip.lisp

Exported Definitions

• gunzip-sequence (method)
• gunzip-sequence (method)
• gzip-sequence (method)
• gzip-sequence (method)

Internal Definitions

• gunzip-byte-array (function)
• gunzip-string (function)
• gzip-byte-array (function)
• gzip-string (function)

3 Packages

Packages are listed by definition order.

3.1 gzip-system

Source

gzip-stream.asd

Use List

• asdf/interface
• common-lisp

3.2 gzip-stream

Source

package.lisp (file)

Use List

• trivial-gray-streams
• flexi-streams
• common-lisp

Exported Definitions

• gunzip (function)
• gunzip-sequence (generic function)
• gunzip-sequence (method)
• gunzip-sequence (method)
• gzip (function)
• gzip-input-stream (class)
• gzip-output-stream (class)
• gzip-sequence (generic function)
• gzip-sequence (method)
• gzip-sequence (method)
• make-gzip-input-stream (function)
• make-gzip-output-stream (function)
• with-open-gzip-file (macro)

Internal Definitions

• *base-distance* (special variable)
• *base-length* (special variable)
• *code-index* (special variable)
• *distance-extra-bits* (special variable)
• *fixed-huffman-distance-tree* (special variable)
• *fixed-huffman-tree* (special variable)
• *length-extra-bits* (special variable)
• *maskarray* (special variable)
• +buffer-size+ (constant)
• bit-reader (structure)
• bit-reader-bits (function)
• (setf bit-reader-bits) (function)
• bit-reader-last-byte (function)
• (setf bit-reader-last-byte) (function)
• bit-reader-of (generic function)
• bit-reader-of (method)
• (setf bit-reader-of) (method)
• (setf bit-reader-of) (generic function)
• bit-reader-p (function)
• bit-reader-stream (function)
• (setf bit-reader-stream) (function)
• bitinfo-bitwidth (function)
• (setf bitinfo-bitwidth) (function)
• bitinfo-maxval (function)
• (setf bitinfo-maxval) (function)
• bitinfo-minval (function)
• (setf bitinfo-minval) (function)
• build-huffman-tree (function)
• compress-buffer (generic function)
• compress-buffer (method)
• (setf compress-buffer) (method)
• (setf compress-buffer) (generic function)
• copy-bit-reader (function)
• copy-bitinfo (function)
• data-buffer-of (generic function)
• data-buffer-of (method)
• (setf data-buffer-of) (method)
• (setf data-buffer-of) (generic function)
• decode-huffman-tree (function)
• deflate-stream (generic function)
• deflate-stream (method)
• (setf deflate-stream) (method)
• (setf deflate-stream) (generic function)
• fill-buffer (function)
• flush-buffer (function)
• generate-huffman-tree (function)
• generate-huffman-tree-from-vector (function)
• gunzip-byte-array (function)
• gunzip-string (function)
• gz_ascii_flags (constant)
• gz_comment (constant)
• gz_extra_field (constant)
• gz_head_crc (constant)
• gz_orig_name (constant)
• gz_reserved (constant)
• gzip-byte-array (function)
• gzip-string (function)
• if* (macro)
• if*-keyword-list (special variable)
• inflate (function)
• input-pos (generic function)
• input-pos (method)
• (setf input-pos) (method)
• (setf input-pos) (generic function)
• make-bit-reader (function)
• make-bitinfo (function)
• make-buffer (function)
• new-bit-reader (function)
• process-deflate-block (function)
• process-dynamic-huffman-block (function)
• process-fixed-huffman-block (function)
• process-huffman-block (function)
• process-non-compressed-block (function)
• put-byte-in-buffer (function)
• read-bits (function)
• read-buffer-of (generic function)
• read-buffer-of (method)
• (setf read-buffer-of) (method)
• (setf read-buffer-of) (generic function)
• read-uword (function)
• reset-bit-reader (function)
• skip-gzip-header (function)
• split-on-position (function)
• under-file (generic function)
• under-file (method)
• (setf under-file) (method)
• (setf under-file) (generic function)
• underfile-of (generic function)
• underfile-of (method)
• (setf underfile-of) (method)
• (setf underfile-of) (generic function)
• z_deflated (constant)

4 Definitions

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

4.1 Exported definitions

4.1.1 Macros

Macro: with-open-gzip-file (VAR PATH &rest OPEN-ARGS &key DIRECTION &allow-other-keys) &body BODY

Package

gzip-stream

Source

gzip-stream.lisp (file)

4.1.2 Functions

Function: gunzip IN-FILE OUT-FILE

Extracts the contents of GZIP file IN-FILE and writes the output to OUT-FILE.

Package

gzip-stream

Source

gzip-stream.lisp (file)

Function: gzip IN-FILE OUT-FILE

GZIPS the contents of in-file and writes the output to outfile.

Package

gzip-stream

Source

gzip-stream.lisp (file)

Function: make-gzip-input-stream STREAM

Package

gzip-stream

Source

gzip-stream.lisp (file)

Function: make-gzip-output-stream STREAM

Package

gzip-stream

Source

gzip-stream.lisp (file)

4.1.3 Generic functions

Generic Function: gunzip-sequence SEQUENCE

Package

gzip-stream

Methods

Method: gunzip-sequence (SEQUENCE vector)

Source

gzip.lisp (file)

Method: gunzip-sequence (SEQUENCE string)

Source

gzip.lisp (file)

Generic Function: gzip-sequence SEQUENCE

Package

gzip-stream

Methods

Method: gzip-sequence (SEQUENCE vector)

Source

gzip.lisp (file)

Method: gzip-sequence (SEQUENCE string)

Source

gzip.lisp (file)

4.1.4 Classes

Class: gzip-input-stream ()

Package

gzip-stream

Source

gzip-stream.lisp (file)

Direct superclasses

• fundamental-binary-input-stream (class)
• trivial-gray-stream-mixin (class)

Direct methods

• stream-clear-input (method)
• stream-listen (method)
• stream-read-line (method)
• stream-read-char (method)
• stream-read-sequence (method)
• stream-read-byte (method)
• close (method)
• stream-element-type (method)
• initialize-instance (method)
• bit-reader-of (method)
• bit-reader-of (method)
• data-buffer-of (method)
• data-buffer-of (method)
• read-buffer-of (method)
• read-buffer-of (method)
• underfile-of (method)
• underfile-of (method)

Direct slots

Slot: underfile

Initargs

:understream

Readers

underfile-of (generic function)

Writers

(setf underfile-of) (generic function)

Slot: read-buffer

Initform

(flexi-streams:make-in-memory-input-stream "")

Readers

read-buffer-of (generic function)

Writers

(setf read-buffer-of) (generic function)

Slot: data-buffer

Initform

(gzip-stream::make-buffer)

Readers

data-buffer-of (generic function)

Writers

(setf data-buffer-of) (generic function)

Slot: bit-reader

Readers

bit-reader-of (generic function)

Writers

(setf bit-reader-of) (generic function)

Slot: last-end

Initform

0

Class: gzip-output-stream ()

Package

gzip-stream

Source

gzip-stream.lisp (file)

Direct superclasses

• fundamental-binary-output-stream (class)
• trivial-gray-stream-mixin (class)

Direct methods

• stream-write-string (method)
• stream-write-char (method)
• stream-line-column (method)
• stream-element-type (method)
• close (method)
• stream-clear-output (method)
• stream-finish-output (method)
• stream-force-output (method)
• stream-write-sequence (method)
• stream-write-byte (method)
• initialize-instance (method)
• compress-buffer (method)
• compress-buffer (method)
• deflate-stream (method)
• deflate-stream (method)
• input-pos (method)
• input-pos (method)
• under-file (method)
• under-file (method)

Direct slots

Slot: underlying-file

Initargs

:understream

Readers

under-file (generic function)

Writers

(setf under-file) (generic function)

Slot: input-buffer

Initform

(gzip-stream::make-buffer)

Slot: input-pos

Type

fixnum

Initform

0

Readers

input-pos (generic function)

Writers

(setf input-pos) (generic function)

Slot: deflate-stream

Readers

deflate-stream (generic function)

Writers

(setf deflate-stream) (generic function)

Slot: size

Type

fixnum

Initform

0

Slot: crc-high

Initform

65535

Slot: crc-low

Initform

65535

Slot: compress-buffer

Initargs

:buffer

Readers

compress-buffer (generic function)

Writers

(setf compress-buffer) (generic function)

4.2 Internal definitions

4.2.1 Constants

Constant: +buffer-size+

Package

gzip-stream

Source

gzip-stream.lisp (file)

Constant: gz_ascii_flags

Package

gzip-stream

Source

inflate.lisp (file)

Constant: gz_comment

Package

gzip-stream

Source

inflate.lisp (file)

Constant: gz_extra_field

Package

gzip-stream

Source

inflate.lisp (file)

Constant: gz_head_crc

Package

gzip-stream

Source

inflate.lisp (file)

Constant: gz_orig_name

Package

gzip-stream

Source

inflate.lisp (file)

Constant: gz_reserved

Package

gzip-stream

Source

inflate.lisp (file)

Constant: z_deflated

Package

gzip-stream

Source

inflate.lisp (file)

4.2.2 Special variables

Special Variable: *base-distance*

Package

gzip-stream

Source

inflate.lisp (file)

Special Variable: *base-length*

Package

gzip-stream

Source

inflate.lisp (file)

Special Variable: *code-index*

Package

gzip-stream

Source

inflate.lisp (file)

Special Variable: *distance-extra-bits*

Package

gzip-stream

Source

inflate.lisp (file)

Special Variable: *fixed-huffman-distance-tree*

Package

gzip-stream

Source

inflate.lisp (file)

Special Variable: *fixed-huffman-tree*

Package

gzip-stream

Source

inflate.lisp (file)

Special Variable: *length-extra-bits*

Package

gzip-stream

Source

inflate.lisp (file)

Special Variable: *maskarray*

Package

gzip-stream

Source

inflate.lisp (file)

Special Variable: if*-keyword-list

Package

gzip-stream

Source

ifstar.lisp (file)

4.2.3 Macros

Macro: if* &rest ARGS

Package

gzip-stream

Source

ifstar.lisp (file)

4.2.4 Functions

Function: bit-reader-bits INSTANCE

Function: (setf bit-reader-bits) VALUE INSTANCE

Package

gzip-stream

Source

inflate.lisp (file)

Function: bit-reader-last-byte INSTANCE

Function: (setf bit-reader-last-byte) VALUE INSTANCE

Package

gzip-stream

Source

inflate.lisp (file)

Function: bit-reader-p OBJECT

Package

gzip-stream

Source

inflate.lisp (file)

Function: bit-reader-stream INSTANCE

Function: (setf bit-reader-stream) VALUE INSTANCE

Package

gzip-stream

Source

inflate.lisp (file)

Function: bitinfo-bitwidth STRUCTURE

Function: (setf bitinfo-bitwidth) VALUE STRUCTURE

Package

gzip-stream

Source

inflate.lisp (file)

Function: bitinfo-maxval STRUCTURE

Function: (setf bitinfo-maxval) VALUE STRUCTURE

Package

gzip-stream

Source

inflate.lisp (file)

Function: bitinfo-minval STRUCTURE

Function: (setf bitinfo-minval) VALUE STRUCTURE

Package

gzip-stream

Source

inflate.lisp (file)

Function: build-huffman-tree MINVAL MINMAXES VALUECODE VALUEWIDTH POS

Package

gzip-stream

Source

inflate.lisp (file)

Function: copy-bit-reader INSTANCE

Package

gzip-stream

Source

inflate.lisp (file)

Function: copy-bitinfo SEQUENCE

Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.

Package

gzip-stream

Source

SYS:SRC;CODE;SEQ.LISP (not found)

Function: decode-huffman-tree BR TREE MINBITS

Package

gzip-stream

Source

inflate.lisp (file)

Function: fill-buffer STREAM

Package

gzip-stream

Source

gzip-stream.lisp (file)

Function: flush-buffer OP BUFFER END

Package

gzip-stream

Source

inflate.lisp (file)

Function: generate-huffman-tree BITINFO

Package

gzip-stream

Source

inflate.lisp (file)

Function: generate-huffman-tree-from-vector VECTOR START END

Package

gzip-stream

Source

inflate.lisp (file)

Function: gunzip-byte-array SEQUENCE

Package

gzip-stream

Source

gzip.lisp (file)

Function: gunzip-string STRING

Package

gzip-stream

Source

gzip.lisp (file)

Function: gzip-byte-array SEQUENCE

Package

gzip-stream

Source

gzip.lisp (file)

Function: gzip-string SEQUENCE

Package

gzip-stream

Source

gzip.lisp (file)

Function: inflate P OP

Package

gzip-stream

Source

inflate.lisp (file)

Function: make-bit-reader &key (STREAM STREAM) (LAST-BYTE LAST-BYTE) (BITS BITS)

Package

gzip-stream

Source

inflate.lisp (file)

Function: make-bitinfo &key (MINVAL MINVAL) (MAXVAL MAXVAL) (BITWIDTH BITWIDTH)

Package

gzip-stream

Source

inflate.lisp (file)

Function: make-buffer ()

Package

gzip-stream

Source

gzip-stream.lisp (file)

Function: new-bit-reader STREAM

Package

gzip-stream

Source

inflate.lisp (file)

Function: process-deflate-block BR OP BUFFER END

Package

gzip-stream

Source

inflate.lisp (file)

Function: process-dynamic-huffman-block BR OP BUFFER END

Package

gzip-stream

Source

inflate.lisp (file)

Function: process-fixed-huffman-block BR OP BUFFER END

Package

gzip-stream

Source

inflate.lisp (file)

Function: process-huffman-block BR OP LENGTHLIT-TREE MINWIDTH DISTANCE-TREE MINDISTWIDTH BUFFER END

Package

gzip-stream

Source

inflate.lisp (file)

Function: process-non-compressed-block BR OP BUFFER END

Package

gzip-stream

Source

inflate.lisp (file)

Function: put-byte-in-buffer OP BYTE BUFFER END

Package

gzip-stream

Source

inflate.lisp (file)

Function: read-bits BR COUNT

Package

gzip-stream

Source

inflate.lisp (file)

Function: read-uword STREAM

Package

gzip-stream

Source

inflate.lisp (file)

Function: reset-bit-reader BR

Package

gzip-stream

Source

inflate.lisp (file)

Function: skip-gzip-header P

Package

gzip-stream

Source

inflate.lisp (file)

Function: split-on-position MINVAL MINMAXES VALUECODE VALUEWIDTH POS

Package

gzip-stream

Source

inflate.lisp (file)

4.2.5 Generic functions

Generic Function: bit-reader-of OBJECT

Generic Function: (setf bit-reader-of) NEW-VALUE OBJECT

Package

gzip-stream

Methods

Method: bit-reader-of (GZIP-INPUT-STREAM gzip-input-stream)

automatically generated reader method

Source

gzip-stream.lisp (file)

Method: (setf bit-reader-of) NEW-VALUE (GZIP-INPUT-STREAM gzip-input-stream)

automatically generated writer method

Source

gzip-stream.lisp (file)

Generic Function: compress-buffer OBJECT

Generic Function: (setf compress-buffer) NEW-VALUE OBJECT

Package

gzip-stream

Methods

Method: compress-buffer (GZIP-OUTPUT-STREAM gzip-output-stream)

automatically generated reader method

Source

gzip-stream.lisp (file)

Method: (setf compress-buffer) NEW-VALUE (GZIP-OUTPUT-STREAM gzip-output-stream)

automatically generated writer method

Source

gzip-stream.lisp (file)

Generic Function: data-buffer-of OBJECT

Generic Function: (setf data-buffer-of) NEW-VALUE OBJECT

Package

gzip-stream

Methods

Method: data-buffer-of (GZIP-INPUT-STREAM gzip-input-stream)

automatically generated reader method

Source

gzip-stream.lisp (file)

Method: (setf data-buffer-of) NEW-VALUE (GZIP-INPUT-STREAM gzip-input-stream)

automatically generated writer method

Source

gzip-stream.lisp (file)

Generic Function: deflate-stream OBJECT

Generic Function: (setf deflate-stream) NEW-VALUE OBJECT

Package

gzip-stream

Methods

Method: deflate-stream (GZIP-OUTPUT-STREAM gzip-output-stream)

automatically generated reader method

Source

gzip-stream.lisp (file)

Method: (setf deflate-stream) NEW-VALUE (GZIP-OUTPUT-STREAM gzip-output-stream)

automatically generated writer method

Source

gzip-stream.lisp (file)

Generic Function: input-pos OBJECT

Generic Function: (setf input-pos) NEW-VALUE OBJECT

Package

gzip-stream

Methods

Method: input-pos (GZIP-OUTPUT-STREAM gzip-output-stream)

automatically generated reader method

Source

gzip-stream.lisp (file)

Method: (setf input-pos) NEW-VALUE (GZIP-OUTPUT-STREAM gzip-output-stream)

automatically generated writer method

Source

gzip-stream.lisp (file)

Generic Function: read-buffer-of OBJECT

Generic Function: (setf read-buffer-of) NEW-VALUE OBJECT

Package

gzip-stream

Methods

Method: read-buffer-of (GZIP-INPUT-STREAM gzip-input-stream)

automatically generated reader method

Source

gzip-stream.lisp (file)

Method: (setf read-buffer-of) NEW-VALUE (GZIP-INPUT-STREAM gzip-input-stream)

automatically generated writer method

Source

gzip-stream.lisp (file)

Generic Function: under-file OBJECT

Generic Function: (setf under-file) NEW-VALUE OBJECT

Package

gzip-stream

Methods

Method: under-file (GZIP-OUTPUT-STREAM gzip-output-stream)

automatically generated reader method

Source

gzip-stream.lisp (file)

Method: (setf under-file) NEW-VALUE (GZIP-OUTPUT-STREAM gzip-output-stream)

automatically generated writer method

Source

gzip-stream.lisp (file)

Generic Function: underfile-of OBJECT

Generic Function: (setf underfile-of) NEW-VALUE OBJECT

Package

gzip-stream

Methods

Method: underfile-of (GZIP-INPUT-STREAM gzip-input-stream)

automatically generated reader method

Source

gzip-stream.lisp (file)

Method: (setf underfile-of) NEW-VALUE (GZIP-INPUT-STREAM gzip-input-stream)

automatically generated writer method

Source

gzip-stream.lisp (file)

4.2.6 Structures

Structure: bit-reader ()

Package

gzip-stream

Source

inflate.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: stream

Readers

bit-reader-stream (function)

Writers

(setf bit-reader-stream) (function)

Slot: last-byte

Readers

bit-reader-last-byte (function)

Writers

(setf bit-reader-last-byte) (function)

Slot: bits

Readers

bit-reader-bits (function)

Writers

(setf bit-reader-bits) (function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types