This is the deflate Reference Manual, version 1.0.4, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:16:07 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
deflateDeflate Decompression Library
Pierre R. Mai <pmai@pmsf.de>
Pierre R. Mai <pmai@pmsf.de>
MIT
1.0.4
deflate.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
deflate/deflate.lispdeflate (system).
decompression-error (condition).
deflate-decompression-error (condition).
gzip-decompression-error (condition).
inflate-gzip-stream (function).
inflate-stream (function).
inflate-zlib-stream (function).
parse-gzip-footer (function).
parse-gzip-header (function).
parse-zlib-footer (function).
parse-zlib-header (function).
zlib-decompression-error (condition).
*code-length-entry-order* (special variable).
*std-dist-decode-tree* (special variable).
*std-lit-decode-tree* (special variable).
+adler-32-base+ (constant).
+adler-32-start-value+ (constant).
+crc-32-polynomial+ (constant).
+crc-32-start-value+ (constant).
+gzip-header-id1+ (constant).
+gzip-header-id2+ (constant).
+sliding-window-size+ (constant).
bit-stream (structure).
bit-stream-bit-count (reader).
(setf bit-stream-bit-count) (writer).
bit-stream-bits (reader).
(setf bit-stream-bits) (writer).
bit-stream-copy-block (function).
bit-stream-get-byte (function).
bit-stream-next-byte (reader).
(setf bit-stream-next-byte) (writer).
bit-stream-p (function).
bit-stream-read-bits (function).
bit-stream-stream (reader).
copy-bit-stream (function).
copy-decode-tree (function).
copy-sliding-window-stream (function).
decode-block (function).
decode-code-length-entries (function).
decode-distance-entry (function).
decode-huffman-block (function).
decode-huffman-tables (function).
decode-length-entry (function).
decode-tree (structure).
decode-tree-code-symbols (reader).
(setf decode-tree-code-symbols) (writer).
decode-tree-length-count (reader).
decode-tree-p (function).
generate-crc32-table (function).
make-bit-stream (function).
make-decode-tree (function).
make-huffman-decode-tree (function).
make-sliding-window-stream (function).
parse-zlib-checksum (function).
read-huffman-code (function).
sliding-window-stream (structure).
sliding-window-stream-buffer (reader).
sliding-window-stream-buffer-end (reader).
(setf sliding-window-stream-buffer-end) (writer).
sliding-window-stream-checksum (reader).
sliding-window-stream-checksum-value (reader).
(setf sliding-window-stream-checksum-value) (writer).
sliding-window-stream-copy-bytes (function).
sliding-window-stream-flush (function).
sliding-window-stream-p (function).
sliding-window-stream-stream (reader).
sliding-window-stream-write-byte (function).
update-adler32-checksum (function).
update-crc32-checksum (function).
Packages are listed by definition order.
deflatecommon-lisp.
decompression-error (condition).
deflate-decompression-error (condition).
gzip-decompression-error (condition).
inflate-gzip-stream (function).
inflate-stream (function).
inflate-zlib-stream (function).
parse-gzip-footer (function).
parse-gzip-header (function).
parse-zlib-footer (function).
parse-zlib-header (function).
zlib-decompression-error (condition).
*code-length-entry-order* (special variable).
*std-dist-decode-tree* (special variable).
*std-lit-decode-tree* (special variable).
+adler-32-base+ (constant).
+adler-32-start-value+ (constant).
+crc-32-polynomial+ (constant).
+crc-32-start-value+ (constant).
+gzip-header-id1+ (constant).
+gzip-header-id2+ (constant).
+sliding-window-size+ (constant).
bit-stream (structure).
bit-stream-bit-count (reader).
(setf bit-stream-bit-count) (writer).
bit-stream-bits (reader).
(setf bit-stream-bits) (writer).
bit-stream-copy-block (function).
bit-stream-get-byte (function).
bit-stream-next-byte (reader).
(setf bit-stream-next-byte) (writer).
bit-stream-p (function).
bit-stream-read-bits (function).
bit-stream-stream (reader).
copy-bit-stream (function).
copy-decode-tree (function).
copy-sliding-window-stream (function).
decode-block (function).
decode-code-length-entries (function).
decode-distance-entry (function).
decode-huffman-block (function).
decode-huffman-tables (function).
decode-length-entry (function).
decode-tree (structure).
decode-tree-code-symbols (reader).
(setf decode-tree-code-symbols) (writer).
decode-tree-length-count (reader).
decode-tree-p (function).
generate-crc32-table (function).
make-bit-stream (function).
make-decode-tree (function).
make-huffman-decode-tree (function).
make-sliding-window-stream (function).
parse-zlib-checksum (function).
read-huffman-code (function).
sliding-window-stream (structure).
sliding-window-stream-buffer (reader).
sliding-window-stream-buffer-end (reader).
(setf sliding-window-stream-buffer-end) (writer).
sliding-window-stream-checksum (reader).
sliding-window-stream-checksum-value (reader).
(setf sliding-window-stream-checksum-value) (writer).
sliding-window-stream-copy-bytes (function).
sliding-window-stream-flush (function).
sliding-window-stream-p (function).
sliding-window-stream-stream (reader).
sliding-window-stream-write-byte (function).
update-adler32-checksum (function).
update-crc32-checksum (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Inflate the RFC 1952 gzip data from the given input stream into the given output stream, which are required to have an element-type of (unsigned-byte 8). This returns the CRC-32 checksum of the file as its first return value, with any filename, modification time, and comment fields as further return values or nil if not present. Note that it is the responsibility of the caller to check whether the expanded data matches the CRC-32 checksum, unless the check-checksum keyword argument is set to true, in which case the checksum is checked internally and a gzip-decompression-error is signalled if they don’t match.
Inflate the RFC 1951 data from the given input stream into the given output stream, which are required to have an element-type of (unsigned-byte 8). If checksum is given, it indicates the checksumming algorithm to employ in calculating a checksum of the expanded content, which is then returned from this function. Valid values are :adler-32 for Adler-32 checksum (see RFC 1950), or :crc-32 for CRC-32 as per ISO 3309 (see RFC 1952, ZIP).
Inflate the RFC 1950 zlib data from the given input stream into the given output stream, which are required to have an element-type of (unsigned-byte 8). This returns the Adler-32 checksum of the file as its first return value, with the compression level as its second return value. Note that it is the responsibility of the caller to check whether the expanded data matches the Adler-32 checksum, unless the check-checksum keyword argument is set to true, in which case the checksum is checked internally and a zlib-decompression-error is signalled if they don’t match.
Parse the GZIP-style footer as per RFC 1952 from the input-stream and return the CRC-32 checksum and ISIZE fields contained in the footer as its return values.
Parse a GZIP-style header as per RFC 1952 from the input-stream and return the compression-method, text-flag, modification time, XFLAGS, OS, FEXTRA flags, filename, comment and CRC16 fields of the header as return values (or nil if any given field is not present). Checks the header for magic values and correct flags settings and signals a gzip-decompression-error in case of incorrect or unsupported magic values or flags.
Parse the ZLIB-style footer as per RFC 1950 from the input-stream and return the Adler-32 checksum contained in the footer as its return value.
Parse a ZLIB-style header as per RFC 1950 from the input-stream and return the compression-method, compression-level dictionary-id and flags fields of the header as return values. Checks the header for corruption and signals a zlib-decompression-error in case of corruption.
simple-error.
Base value for Adler-32 checksums as per RFC 1950.
Start value for Adler-32 checksums as per RFC 1950.
CRC-32 Polynomial as per RFC 1952.
Start value for CRC-32 checksums as per RFC 1952.
GZIP Header Magic Value ID1 as per RFC 1952.
GZIP Header Magic Value ID2 as per RFC 1952.
Size of sliding window for RFC 1951 Deflate compression scheme.
Order of Code Length Tree Code Lengths.
bits.
Copy a given block of bytes directly from the underlying stream.
Read another byte from the underlying stream.
Read single or multiple bits from the given bit-stream.
Decompress a block read from bit-stream into window-stream.
Decode the given number of code length entries from the bit-stream using the given decode-tree, and return a corresponding array of code lengths for further processing.
Decode the given distance symbol into a proper distance specification.
Decode the huffman code block using the huffman codes given by lit-decode-tree and dist-decode-tree.
Decode the stored huffman tables from the given bit-stream, returning the corresponding decode-trees for literals/length and distance codes.
Decode the given length symbol into a proper length specification.
Construct a huffman decode-tree for the canonical huffman code with the code lengths of each symbol given in the input array.
Read the next huffman code word from the given bit-stream and return its decoded symbol, for the huffman code given by decode-tree.
Copy a number of bytes from the current sliding window.
Flush any remaining buffered bytes from the stream.
Write a single byte to the sliding-window-stream.
structure-object.
common-lisp.
stream
This slot is read-only.
fixnum
0
(unsigned-byte 29)
0
(unsigned-byte 8)
0
structure-object.
(simple-array fixnum (*))
(make-array 16 :element-type (quote fixnum) :initial-element 0)
This slot is read-only.
(simple-array fixnum (*))
(make-array 16 :element-type (quote fixnum) :initial-element 0)
structure-object.
common-lisp.
stream
This slot is read-only.
(simple-array (unsigned-byte 8) (32768))
(make-array deflate::+sliding-window-size+ :element-type (quote (unsigned-byte 8)) :initial-element 0)
This slot is read-only.
fixnum
0
symbol
This slot is read-only.
(unsigned-byte 32)
0
| Jump to: | (
B C D F G I M P R S U |
|---|
| Jump to: | (
B C D F G I M P R S U |
|---|
| Jump to: | *
+
B C L N S |
|---|
| Jump to: | *
+
B C L N S |
|---|
| Jump to: | B C D F G P S Z |
|---|
| Jump to: | B C D F G P S Z |
|---|