The zippy Reference Manual

3.1.1 zippy/zippy.asd

Source

zippy.asd.

Parent Component

zippy (system).

ASDF Systems

zippy.

---

3.1.2 zippy/package.lisp

Source

zippy.asd.

Parent Component

zippy (system).

Packages

org.shirakumo.zippy.

---

3.1.3 zippy/conditions.lisp

Dependency

package.lisp (file).

Source

zippy.asd.

Parent Component

zippy (system).

Public Interface

• compression-method (reader method).
• decoding-error (condition).
• encoding-error (condition).
• encryption-method (reader method).
• integer-too-large (condition).
• malformed-file (condition).
• message (reader method).
• mismatched-type-signature (condition).
• object (reader method).
• object (reader method).
• out-of-bounds-seek (condition).
• parameter (reader method).
• password-required (condition).
• required-version (reader method).
• required-version-mismatched (condition).
• signature (reader method).
• signature (reader method).
• specified-version (reader method).
• stream-closed (condition).
• target (reader method).
• unknown-block-signature (condition).
• unknown-enum-value (condition).
• unknown-structure-type (condition).
• unsupported-compression-method (condition).
• unsupported-encryption-method (condition).
• value (reader method).
• zip64-required (condition).
• zippy-condition (condition).

---

3.1.4 zippy/toolkit.lisp

Dependency

conditions.lisp (file).

Source

zippy.asd.

Parent Component

zippy (system).

Public Interface

• *compatibility* (special variable).
• *default-buffer-size* (special variable).

Internals

• *default-version-made* (special variable).
• *default-version-needed* (special variable).
• alist-table (function).
• alist-vector (function).
• bitfield (function).
• cap (function).
• debitfield (function).
• default-attributes-for (function).
• enbitfield (function).
• enlist (function).
• ensure-buffer (function).
• ensure-password (function).
• n-bit-p (function).
• version< (function).

---

3.1.5 zippy/parser.lisp

Dependency

toolkit.lisp (file).

Source

zippy.asd.

Parent Component

zippy (system).

Public Interface

• decode-structure (function).
• define-byte-structure (macro).
• encode-structure (function).
• read-structure (function).
• write-structure (function).

Internals

• *structures* (special variable).
• binary-type-decoder (function).
• binary-type-encoder (function).
• binary-type-reader (function).
• binary-type-size (function).
• binary-type-type (function).
• binary-type-writer (function).
• decode-file-attribute (function).
• decode-msdos-timestamp (function).
• decode-string (function).
• decode-version (function).
• encode-file-attribute (function).
• encode-msdos-timestamp (function).
• encode-string (function).
• encode-version (function).
• generate-record-decoder (function).
• generate-record-encoder (function).
• generate-record-reader (function).
• generate-record-writer (function).
• integer-binary-type (function).

---

3.1.6 zippy/io.lisp

Dependency

parser.lisp (file).

Source

zippy.asd.

Parent Component

zippy (system).

Public Interface

• end (function).
• has-more (function).
• index (function).
• io (type).
• output (function).
• parse-structure (macro).
• parse-structure* (function).
• seek (function).
• size (method).
• size (method).
• start (function).
• ub32 (function).
• vector-input (structure).
• vector-input-end (reader).
• vector-input-index (reader).
• (setf vector-input-index) (writer).
• vector-input-start (reader).
• vector-input-vector (reader).
• with-io (macro).
• write-structure* (function).

Internals

• call-with-io (function).
• copy-directory-input (function).
• copy-vector-input (function).
• directory-input (structure).
• directory-input-p (function).
• make-directory-input (function).
• make-vector-input (function).
• vector-input-p (function).

---

3.1.7 zippy/tables.lisp

Dependency

io.lisp (file).

Source

zippy.asd.

Parent Component

zippy (system).

Public Interface

• compression-method-id (function).
• compression-method-name (function).
• encryption-method-id (function).
• encryption-method-name (function).
• file-attribute-id (function).
• file-attribute-name (function).

Internals

• *compression-method-map* (special variable).
• *encryption-method-map* (special variable).
• *file-attribute-compatibility-map* (special variable).

---

3.1.8 zippy/compression.lisp

Dependency

tables.lisp (file).

Source

zippy.asd.

Parent Component

zippy (system).

Public Interface

• call-with-completed-compressed-buffer (generic function).
• call-with-compressed-buffer (generic function).
• call-with-decompressed-buffer (generic function).
• make-compression-state (generic function).
• make-decompression-state (generic function).

Internals

• copy-deflate-state (function).
• deflate-state (structure).
• deflate-state-available (reader).
• (setf deflate-state-available) (writer).
• deflate-state-bits-remaining (function).
• (setf deflate-state-bits-remaining) (function).
• deflate-state-bytes-to-copy (function).
• (setf deflate-state-bytes-to-copy) (function).
• deflate-state-copy-offset (function).
• (setf deflate-state-copy-offset) (function).
• deflate-state-current-huffman-tree (function).
• (setf deflate-state-current-huffman-tree) (function).
• deflate-state-current-state (function).
• (setf deflate-state-current-state) (function).
• deflate-state-dht-hclen (function).
• (setf deflate-state-dht-hclen) (function).
• deflate-state-dht-hlit (function).
• (setf deflate-state-dht-hlit) (function).
• deflate-state-dht-hlit+hdist (function).
• (setf deflate-state-dht-hlit+hdist) (function).
• deflate-state-dht-last-len (function).
• (setf deflate-state-dht-last-len) (function).
• deflate-state-dht-len-codes (function).
• (setf deflate-state-dht-len-codes) (function).
• deflate-state-dht-len-tree (function).
• (setf deflate-state-dht-len-tree) (function).
• deflate-state-dht-lit/len/dist (function).
• (setf deflate-state-dht-lit/len/dist) (function).
• deflate-state-dht-lit/len/dist-index (function).
• (setf deflate-state-dht-lit/len/dist-index) (function).
• deflate-state-dynamic-huffman-tree (function).
• (setf deflate-state-dynamic-huffman-tree) (function).
• deflate-state-finished (function).
• (setf deflate-state-finished) (function).
• deflate-state-input-state (reader).
• (setf deflate-state-input-state) (writer).
• deflate-state-input-underrun (function).
• (setf deflate-state-input-underrun) (function).
• deflate-state-last-block-flag (function).
• (setf deflate-state-last-block-flag) (function).
• deflate-state-last-read (reader).
• (setf deflate-state-last-read) (writer).
• deflate-state-output-buffer (function).
• (setf deflate-state-output-buffer) (function).
• deflate-state-output-offset (function).
• (setf deflate-state-output-offset) (function).
• deflate-state-output-overflow (function).
• (setf deflate-state-output-overflow) (function).
• deflate-state-p (function).
• deflate-state-partial-bits (function).
• (setf deflate-state-partial-bits) (function).
• deflate-state-window (function).
• (setf deflate-state-window) (function).
• make-deflate-state (function).

---

3.1.9 zippy/encryption.lisp

Dependency

compression.lisp (file).

Source

zippy.asd.

Parent Component

zippy (system).

Public Interface

• call-with-completed-encrypted-buffer (generic function).
• call-with-decrypted-buffer (generic function).
• call-with-encrypted-buffer (generic function).
• make-decryption-state (generic function).
• make-encryption-state (generic function).

Internals

• copy-stream-decryption-state (function).
• copy-vector-decryption-state (function).
• make-stream-decryption-state (function).
• make-vector-decryption-state (function).
• stream-decryption-state (structure).
• stream-decryption-state-buffer (reader).
• (setf stream-decryption-state-buffer) (writer).
• stream-decryption-state-end (reader).
• (setf stream-decryption-state-end) (writer).
• stream-decryption-state-index (reader).
• (setf stream-decryption-state-index) (writer).
• stream-decryption-state-p (function).
• stream-decryption-state-start (reader).
• (setf stream-decryption-state-start) (writer).
• vector-decryption-state (structure).
• vector-decryption-state-consumed (reader).
• (setf vector-decryption-state-consumed) (writer).
• vector-decryption-state-p (function).

---

3.1.10 zippy/pkware-encryption.lisp

Dependency

encryption.lisp (file).

Source

zippy.asd.

Parent Component

zippy (system).

Public Interface

• call-with-decrypted-buffer (method).
• call-with-decrypted-buffer (method).
• make-decryption-state (method).
• make-decryption-state (method).

Internals

• %make-pkware-decrypt-state (function).
• copy-pkware-decrypt-state (function).
• crc32-rotate (function).
• make-pkware-decrypt-state (function).
• pkware-decrypt-byte (function).
• pkware-decrypt-state (structure).
• pkware-decrypt-state-buffer (reader).
• (setf pkware-decrypt-state-buffer) (writer).
• pkware-decrypt-state-k0 (reader).
• (setf pkware-decrypt-state-k0) (writer).
• pkware-decrypt-state-k1 (reader).
• (setf pkware-decrypt-state-k1) (writer).
• pkware-decrypt-state-k2 (reader).
• (setf pkware-decrypt-state-k2) (writer).
• pkware-decrypt-state-p (function).
• update-pkware-state (function).

---

3.1.11 zippy/structures.lisp

Dependency

pkware-encryption.lisp (file).

Source

zippy.asd.

Parent Component

zippy (system).

Public Interface

• aes-extra-data (structure).
• data-stream-alignment (structure).
• encryption-header (structure).
• infozip-unicode-comment (structure).
• infozip-unicode-path (structure).
• key-provider-record (structure).
• microsoft-open-packaging-growth-hint (structure).
• mvs (structure).
• ntfs (structure).
• openvms (structure).
• os/2 (structure).
• patch-descriptor (structure).
• pkcs7-encryption-recipient-certificate-list (structure).
• pkcs7-store (structure).
• policy-decryption-key-record (structure).
• policy-key-data-record (structure).
• record-management-controls (structure).
• unix (structure).
• x509-central-directory (structure).
• x509-file (structure).
• zip64-extended-information (structure).
• zipit-macintosh-long (structure).
• zipit-macintosh-short-dir (structure).
• zipit-macintosh-short-file (structure).

Internals

• aes-extra-data-compression-method (reader).
• (setf aes-extra-data-compression-method) (writer).
• aes-extra-data-encryption-strength (reader).
• (setf aes-extra-data-encryption-strength) (writer).
• aes-extra-data-p (function).
• aes-extra-data-size (reader).
• (setf aes-extra-data-size) (writer).
• aes-extra-data-vendor (reader).
• (setf aes-extra-data-vendor) (writer).
• aes-extra-data-version (reader).
• (setf aes-extra-data-version) (writer).
• central-directory-entry (structure).
• central-directory-entry-compressed-size (reader).
• (setf central-directory-entry-compressed-size) (writer).
• central-directory-entry-compression-method (reader).
• (setf central-directory-entry-compression-method) (writer).
• central-directory-entry-crc-32 (reader).
• (setf central-directory-entry-crc-32) (writer).
• central-directory-entry-disk-number-start (reader).
• (setf central-directory-entry-disk-number-start) (writer).
• central-directory-entry-external-file-attributes (reader).
• (setf central-directory-entry-external-file-attributes) (writer).
• central-directory-entry-extra (reader).
• (setf central-directory-entry-extra) (writer).
• central-directory-entry-extra-field-length (reader).
• (setf central-directory-entry-extra-field-length) (writer).
• central-directory-entry-file-comment (reader).
• (setf central-directory-entry-file-comment) (writer).
• central-directory-entry-file-comment-length (reader).
• (setf central-directory-entry-file-comment-length) (writer).
• central-directory-entry-file-name (reader).
• (setf central-directory-entry-file-name) (writer).
• central-directory-entry-file-name-length (reader).
• (setf central-directory-entry-file-name-length) (writer).
• central-directory-entry-flags (reader).
• (setf central-directory-entry-flags) (writer).
• central-directory-entry-internal-file-attributes (reader).
• (setf central-directory-entry-internal-file-attributes) (writer).
• central-directory-entry-last-modified-date (reader).
• (setf central-directory-entry-last-modified-date) (writer).
• central-directory-entry-last-modified-time (reader).
• (setf central-directory-entry-last-modified-time) (writer).
• central-directory-entry-local-header-offset (reader).
• (setf central-directory-entry-local-header-offset) (writer).
• central-directory-entry-p (function).
• central-directory-entry-uncompressed-size (reader).
• (setf central-directory-entry-uncompressed-size) (writer).
• central-directory-entry-version-made (reader).
• (setf central-directory-entry-version-made) (writer).
• central-directory-entry-version-needed (reader).
• (setf central-directory-entry-version-needed) (writer).
• copy-aes-extra-data (function).
• copy-central-directory-entry (function).
• copy-data-descriptor (function).
• copy-data-descriptor/64 (function).
• copy-data-stream-alignment (function).
• copy-decryption-header (function).
• copy-digital-signature (function).
• copy-encryption-header (function).
• copy-end-of-central-directory (function).
• copy-end-of-central-directory-locator/64 (function).
• copy-end-of-central-directory/64 (function).
• copy-extra-data (function).
• copy-infozip-unicode-comment (function).
• copy-infozip-unicode-path (function).
• copy-key-provider-record (function).
• copy-local-file (function).
• copy-microsoft-open-packaging-growth-hint (function).
• copy-mvs (function).
• copy-ntfs (function).
• copy-openvms (function).
• copy-os/2 (function).
• copy-patch-descriptor (function).
• copy-pkcs7-encryption-recipient-certificate-list (function).
• copy-pkcs7-store (function).
• copy-policy-decryption-key-record (function).
• copy-policy-key-data-record (function).
• copy-record-management-controls (function).
• copy-unix (function).
• copy-x509-central-directory (function).
• copy-x509-file (function).
• copy-zip64-extended-information (function).
• copy-zipit-macintosh-long (function).
• copy-zipit-macintosh-short-dir (function).
• copy-zipit-macintosh-short-file (function).
• data-descriptor (structure).
• data-descriptor-compressed-size (reader).
• (setf data-descriptor-compressed-size) (writer).
• data-descriptor-crc-32 (reader).
• (setf data-descriptor-crc-32) (writer).
• data-descriptor-p (function).
• data-descriptor-uncompressed-size (reader).
• (setf data-descriptor-uncompressed-size) (writer).
• data-descriptor/64 (structure).
• data-descriptor/64-compressed-size (reader).
• (setf data-descriptor/64-compressed-size) (writer).
• data-descriptor/64-crc-32 (reader).
• (setf data-descriptor/64-crc-32) (writer).
• data-descriptor/64-p (function).
• data-descriptor/64-uncompressed-size (reader).
• (setf data-descriptor/64-uncompressed-size) (writer).
• data-stream-alignment-alignment (reader).
• (setf data-stream-alignment-alignment) (writer).
• data-stream-alignment-p (function).
• data-stream-alignment-padding (reader).
• (setf data-stream-alignment-padding) (writer).
• data-stream-alignment-size (reader).
• (setf data-stream-alignment-size) (writer).
• decode-aes-extra-data (function).
• decode-central-directory-entry (function).
• decode-data-descriptor (function).
• decode-data-descriptor/64 (function).
• decode-data-stream-alignment (function).
• decode-decryption-header (function).
• decode-digital-signature (function).
• decode-encryption-header (function).
• decode-end-of-central-directory (function).
• decode-end-of-central-directory-locator/64 (function).
• decode-end-of-central-directory/64 (function).
• decode-extra-data (function).
• decode-infozip-unicode-comment (function).
• decode-infozip-unicode-path (function).
• decode-key-provider-record (function).
• decode-local-file (function).
• decode-microsoft-open-packaging-growth-hint (function).
• decode-mvs (function).
• decode-ntfs (function).
• decode-openvms (function).
• decode-os/2 (function).
• decode-patch-descriptor (function).
• decode-pkcs7-encryption-recipient-certificate-list (function).
• decode-pkcs7-store (function).
• decode-policy-decryption-key-record (function).
• decode-policy-key-data-record (function).
• decode-record-management-controls (function).
• decode-unix (function).
• decode-x509-central-directory (function).
• decode-x509-file (function).
• decode-zip64-extended-information (function).
• decode-zipit-macintosh-long (function).
• decode-zipit-macintosh-short-dir (function).
• decode-zipit-macintosh-short-file (function).
• decryption-header (structure).
• decryption-header-bit-length (reader).
• (setf decryption-header-bit-length) (writer).
• decryption-header-crc (reader).
• (setf decryption-header-crc) (writer).
• decryption-header-encryption-algorithm (reader).
• (setf decryption-header-encryption-algorithm) (writer).
• decryption-header-flags (reader).
• (setf decryption-header-flags) (writer).
• decryption-header-format (reader).
• (setf decryption-header-format) (writer).
• decryption-header-iv (reader).
• (setf decryption-header-iv) (writer).
• decryption-header-iv-size (reader).
• (setf decryption-header-iv-size) (writer).
• decryption-header-p (function).
• decryption-header-random-data (reader).
• (setf decryption-header-random-data) (writer).
• decryption-header-random-data-size (reader).
• (setf decryption-header-random-data-size) (writer).
• decryption-header-reserved (reader).
• (setf decryption-header-reserved) (writer).
• decryption-header-reserved-size (reader).
• (setf decryption-header-reserved-size) (writer).
• decryption-header-size (reader).
• (setf decryption-header-size) (writer).
• decryption-header-validation (reader).
• (setf decryption-header-validation) (writer).
• decryption-header-validation-size (reader).
• (setf decryption-header-validation-size) (writer).
• digital-signature (structure).
• digital-signature-data (reader).
• (setf digital-signature-data) (writer).
• digital-signature-p (function).
• digital-signature-size (reader).
• (setf digital-signature-size) (writer).
• encode-aes-extra-data (function).
• encode-central-directory-entry (function).
• encode-data-descriptor (function).
• encode-data-descriptor/64 (function).
• encode-data-stream-alignment (function).
• encode-decryption-header (function).
• encode-digital-signature (function).
• encode-encryption-header (function).
• encode-end-of-central-directory (function).
• encode-end-of-central-directory-locator/64 (function).
• encode-end-of-central-directory/64 (function).
• encode-extra-data (function).
• encode-infozip-unicode-comment (function).
• encode-infozip-unicode-path (function).
• encode-key-provider-record (function).
• encode-local-file (function).
• encode-microsoft-open-packaging-growth-hint (function).
• encode-mvs (function).
• encode-ntfs (function).
• encode-openvms (function).
• encode-os/2 (function).
• encode-patch-descriptor (function).
• encode-pkcs7-encryption-recipient-certificate-list (function).
• encode-pkcs7-store (function).
• encode-policy-decryption-key-record (function).
• encode-policy-key-data-record (function).
• encode-record-management-controls (function).
• encode-unix (function).
• encode-x509-central-directory (function).
• encode-x509-file (function).
• encode-zip64-extended-information (function).
• encode-zipit-macintosh-long (function).
• encode-zipit-macintosh-short-dir (function).
• encode-zipit-macintosh-short-file (function).
• encryption-header-bit-length (reader).
• (setf encryption-header-bit-length) (writer).
• encryption-header-certificate (reader).
• (setf encryption-header-certificate) (writer).
• encryption-header-encryption-algorithm (reader).
• (setf encryption-header-encryption-algorithm) (writer).
• encryption-header-flags (reader).
• (setf encryption-header-flags) (writer).
• encryption-header-format (reader).
• (setf encryption-header-format) (writer).
• encryption-header-p (function).
• encryption-header-size (reader).
• (setf encryption-header-size) (writer).
• end-of-central-directory (structure).
• end-of-central-directory-central-directory-disk (reader).
• (setf end-of-central-directory-central-directory-disk) (writer).
• end-of-central-directory-central-directory-entries (reader).
• (setf end-of-central-directory-central-directory-entries) (writer).
• end-of-central-directory-central-directory-size (reader).
• (setf end-of-central-directory-central-directory-size) (writer).
• end-of-central-directory-central-directory-start (reader).
• (setf end-of-central-directory-central-directory-start) (writer).
• end-of-central-directory-disk-entries (reader).
• (setf end-of-central-directory-disk-entries) (writer).
• end-of-central-directory-file-comment (reader).
• (setf end-of-central-directory-file-comment) (writer).
• end-of-central-directory-file-comment-length (reader).
• (setf end-of-central-directory-file-comment-length) (writer).
• end-of-central-directory-locator/64 (structure).
• end-of-central-directory-locator/64-central-directory-disk (reader).
• (setf end-of-central-directory-locator/64-central-directory-disk) (writer).
• end-of-central-directory-locator/64-central-directory-start (reader).
• (setf end-of-central-directory-locator/64-central-directory-start) (writer).
• end-of-central-directory-locator/64-number-of-disks (reader).
• (setf end-of-central-directory-locator/64-number-of-disks) (writer).
• end-of-central-directory-locator/64-p (function).
• end-of-central-directory-number-of-disk (reader).
• (setf end-of-central-directory-number-of-disk) (writer).
• end-of-central-directory-p (function).
• end-of-central-directory/64 (structure).
• end-of-central-directory/64-central-directory-disk (reader).
• (setf end-of-central-directory/64-central-directory-disk) (writer).
• end-of-central-directory/64-central-directory-entries (reader).
• (setf end-of-central-directory/64-central-directory-entries) (writer).
• end-of-central-directory/64-central-directory-size (reader).
• (setf end-of-central-directory/64-central-directory-size) (writer).
• end-of-central-directory/64-central-directory-start (reader).
• (setf end-of-central-directory/64-central-directory-start) (writer).
• end-of-central-directory/64-data-sector (reader).
• (setf end-of-central-directory/64-data-sector) (writer).
• end-of-central-directory/64-disk-entries (reader).
• (setf end-of-central-directory/64-disk-entries) (writer).
• end-of-central-directory/64-number-of-disk (reader).
• (setf end-of-central-directory/64-number-of-disk) (writer).
• end-of-central-directory/64-p (function).
• end-of-central-directory/64-size (reader).
• (setf end-of-central-directory/64-size) (writer).
• end-of-central-directory/64-version-made (reader).
• (setf end-of-central-directory/64-version-made) (writer).
• end-of-central-directory/64-version-needed (reader).
• (setf end-of-central-directory/64-version-needed) (writer).
• extra-data (structure).
• extra-data-extra (reader).
• (setf extra-data-extra) (writer).
• extra-data-extra-field-length (reader).
• (setf extra-data-extra-field-length) (writer).
• extra-data-p (function).
• infozip-unicode-comment-comment (reader).
• (setf infozip-unicode-comment-comment) (writer).
• infozip-unicode-comment-crc-32 (reader).
• (setf infozip-unicode-comment-crc-32) (writer).
• infozip-unicode-comment-p (function).
• infozip-unicode-comment-size (reader).
• (setf infozip-unicode-comment-size) (writer).
• infozip-unicode-comment-version (reader).
• (setf infozip-unicode-comment-version) (writer).
• infozip-unicode-path-crc-32 (reader).
• (setf infozip-unicode-path-crc-32) (writer).
• infozip-unicode-path-name (reader).
• (setf infozip-unicode-path-name) (writer).
• infozip-unicode-path-p (function).
• infozip-unicode-path-size (reader).
• (setf infozip-unicode-path-size) (writer).
• infozip-unicode-path-version (reader).
• (setf infozip-unicode-path-version) (writer).
• key-provider-record-data (reader).
• (setf key-provider-record-data) (writer).
• key-provider-record-p (function).
• key-provider-record-size (reader).
• (setf key-provider-record-size) (writer).
• local-file (structure).
• local-file-compressed-size (reader).
• (setf local-file-compressed-size) (writer).
• local-file-compression-method (reader).
• (setf local-file-compression-method) (writer).
• local-file-crc-32 (reader).
• (setf local-file-crc-32) (writer).
• local-file-extra (reader).
• (setf local-file-extra) (writer).
• local-file-extra-field-length (reader).
• (setf local-file-extra-field-length) (writer).
• local-file-file-name (reader).
• (setf local-file-file-name) (writer).
• local-file-file-name-length (reader).
• (setf local-file-file-name-length) (writer).
• local-file-flags (reader).
• (setf local-file-flags) (writer).
• local-file-last-modified-date (reader).
• (setf local-file-last-modified-date) (writer).
• local-file-last-modified-time (reader).
• (setf local-file-last-modified-time) (writer).
• local-file-p (function).
• local-file-uncompressed-size (reader).
• (setf local-file-uncompressed-size) (writer).
• local-file-version (reader).
• (setf local-file-version) (writer).
• make-aes-extra-data (function).
• make-central-directory-entry (function).
• make-data-descriptor (function).
• make-data-descriptor/64 (function).
• make-data-stream-alignment (function).
• make-decryption-header (function).
• make-digital-signature (function).
• make-encryption-header (function).
• make-end-of-central-directory (function).
• make-end-of-central-directory-locator/64 (function).
• make-end-of-central-directory/64 (function).
• make-extra-data (function).
• make-infozip-unicode-comment (function).
• make-infozip-unicode-path (function).
• make-key-provider-record (function).
• make-local-file (function).
• make-microsoft-open-packaging-growth-hint (function).
• make-mvs (function).
• make-ntfs (function).
• make-openvms (function).
• make-os/2 (function).
• make-patch-descriptor (function).
• make-pkcs7-encryption-recipient-certificate-list (function).
• make-pkcs7-store (function).
• make-policy-decryption-key-record (function).
• make-policy-key-data-record (function).
• make-record-management-controls (function).
• make-unix (function).
• make-x509-central-directory (function).
• make-x509-file (function).
• make-zip64-extended-information (function).
• make-zipit-macintosh-long (function).
• make-zipit-macintosh-short-dir (function).
• make-zipit-macintosh-short-file (function).
• microsoft-open-packaging-growth-hint-p (function).
• microsoft-open-packaging-growth-hint-padding (reader).
• (setf microsoft-open-packaging-growth-hint-padding) (writer).
• microsoft-open-packaging-growth-hint-padding-value (reader).
• (setf microsoft-open-packaging-growth-hint-padding-value) (writer).
• microsoft-open-packaging-growth-hint-signature (reader).
• (setf microsoft-open-packaging-growth-hint-signature) (writer).
• microsoft-open-packaging-growth-hint-size (reader).
• (setf microsoft-open-packaging-growth-hint-size) (writer).
• mvs-data (reader).
• (setf mvs-data) (writer).
• mvs-id (reader).
• (setf mvs-id) (writer).
• mvs-p (function).
• mvs-size (reader).
• (setf mvs-size) (writer).
• ntfs-data (reader).
• (setf ntfs-data) (writer).
• ntfs-p (function).
• ntfs-reserved (reader).
• (setf ntfs-reserved) (writer).
• ntfs-size (reader).
• (setf ntfs-size) (writer).
• openvms-crc (reader).
• (setf openvms-crc) (writer).
• openvms-data (reader).
• (setf openvms-data) (writer).
• openvms-p (function).
• openvms-size (reader).
• (setf openvms-size) (writer).
• os/2-compression-type (reader).
• (setf os/2-compression-type) (writer).
• os/2-crc (reader).
• (setf os/2-crc) (writer).
• os/2-data (reader).
• (setf os/2-data) (writer).
• os/2-p (function).
• os/2-size (reader).
• (setf os/2-size) (writer).
• os/2-uncompressed-size (reader).
• (setf os/2-uncompressed-size) (writer).
• patch-descriptor-flags (reader).
• (setf patch-descriptor-flags) (writer).
• patch-descriptor-new-crc (reader).
• (setf patch-descriptor-new-crc) (writer).
• patch-descriptor-new-size (reader).
• (setf patch-descriptor-new-size) (writer).
• patch-descriptor-old-crc (reader).
• (setf patch-descriptor-old-crc) (writer).
• patch-descriptor-old-size (reader).
• (setf patch-descriptor-old-size) (writer).
• patch-descriptor-p (function).
• patch-descriptor-size (reader).
• (setf patch-descriptor-size) (writer).
• patch-descriptor-version (reader).
• (setf patch-descriptor-version) (writer).
• pkcs7-encryption-recipient-certificate-list-p (function).
• pkcs7-encryption-recipient-certificate-list-size (reader).
• (setf pkcs7-encryption-recipient-certificate-list-size) (writer).
• pkcs7-encryption-recipient-certificate-list-store (reader).
• (setf pkcs7-encryption-recipient-certificate-list-store) (writer).
• pkcs7-encryption-recipient-certificate-list-version (reader).
• (setf pkcs7-encryption-recipient-certificate-list-version) (writer).
• pkcs7-store-data (reader).
• (setf pkcs7-store-data) (writer).
• pkcs7-store-p (function).
• pkcs7-store-size (reader).
• (setf pkcs7-store-size) (writer).
• policy-decryption-key-record-data (reader).
• (setf policy-decryption-key-record-data) (writer).
• policy-decryption-key-record-p (function).
• policy-decryption-key-record-size (reader).
• (setf policy-decryption-key-record-size) (writer).
• policy-key-data-record-data (reader).
• (setf policy-key-data-record-data) (writer).
• policy-key-data-record-p (function).
• policy-key-data-record-size (reader).
• (setf policy-key-data-record-size) (writer).
• read-aes-extra-data (function).
• read-central-directory-entry (function).
• read-data-descriptor (function).
• read-data-descriptor/64 (function).
• read-data-stream-alignment (function).
• read-decryption-header (function).
• read-digital-signature (function).
• read-encryption-header (function).
• read-end-of-central-directory (function).
• read-end-of-central-directory-locator/64 (function).
• read-end-of-central-directory/64 (function).
• read-extra-data (function).
• read-infozip-unicode-comment (function).
• read-infozip-unicode-path (function).
• read-key-provider-record (function).
• read-local-file (function).
• read-microsoft-open-packaging-growth-hint (function).
• read-mvs (function).
• read-ntfs (function).
• read-openvms (function).
• read-os/2 (function).
• read-patch-descriptor (function).
• read-pkcs7-encryption-recipient-certificate-list (function).
• read-pkcs7-store (function).
• read-policy-decryption-key-record (function).
• read-policy-key-data-record (function).
• read-record-management-controls (function).
• read-unix (function).
• read-x509-central-directory (function).
• read-x509-file (function).
• read-zip64-extended-information (function).
• read-zipit-macintosh-long (function).
• read-zipit-macintosh-short-dir (function).
• read-zipit-macintosh-short-file (function).
• record-management-controls-data (reader).
• (setf record-management-controls-data) (writer).
• record-management-controls-p (function).
• record-management-controls-size (reader).
• (setf record-management-controls-size) (writer).
• unix-atime (reader).
• (setf unix-atime) (writer).
• unix-data (reader).
• (setf unix-data) (writer).
• unix-gid (reader).
• (setf unix-gid) (writer).
• unix-mtime (reader).
• (setf unix-mtime) (writer).
• unix-p (function).
• unix-size (reader).
• (setf unix-size) (writer).
• unix-uid (reader).
• (setf unix-uid) (writer).
• write-aes-extra-data (function).
• write-central-directory-entry (function).
• write-data-descriptor (function).
• write-data-descriptor/64 (function).
• write-data-stream-alignment (function).
• write-decryption-header (function).
• write-digital-signature (function).
• write-encryption-header (function).
• write-end-of-central-directory (function).
• write-end-of-central-directory-locator/64 (function).
• write-end-of-central-directory/64 (function).
• write-extra-data (function).
• write-infozip-unicode-comment (function).
• write-infozip-unicode-path (function).
• write-key-provider-record (function).
• write-local-file (function).
• write-microsoft-open-packaging-growth-hint (function).
• write-mvs (function).
• write-ntfs (function).
• write-openvms (function).
• write-os/2 (function).
• write-patch-descriptor (function).
• write-pkcs7-encryption-recipient-certificate-list (function).
• write-pkcs7-store (function).
• write-policy-decryption-key-record (function).
• write-policy-key-data-record (function).
• write-record-management-controls (function).
• write-unix (function).
• write-x509-central-directory (function).
• write-x509-file (function).
• write-zip64-extended-information (function).
• write-zipit-macintosh-long (function).
• write-zipit-macintosh-short-dir (function).
• write-zipit-macintosh-short-file (function).
• x509-central-directory-data (reader).
• (setf x509-central-directory-data) (writer).
• x509-central-directory-p (function).
• x509-central-directory-size (reader).
• (setf x509-central-directory-size) (writer).
• x509-file-data (reader).
• (setf x509-file-data) (writer).
• x509-file-p (function).
• x509-file-size (reader).
• (setf x509-file-size) (writer).
• zip64-extended-information-compressed-size (reader).
• (setf zip64-extended-information-compressed-size) (writer).
• zip64-extended-information-header-offset (reader).
• (setf zip64-extended-information-header-offset) (writer).
• zip64-extended-information-original-size (reader).
• (setf zip64-extended-information-original-size) (writer).
• zip64-extended-information-p (function).
• zip64-extended-information-size (reader).
• (setf zip64-extended-information-size) (writer).
• zip64-extended-information-starting-disk (reader).
• (setf zip64-extended-information-starting-disk) (writer).
• zipit-macintosh-long-creator (reader).
• (setf zipit-macintosh-long-creator) (writer).
• zipit-macintosh-long-file-name (reader).
• (setf zipit-macintosh-long-file-name) (writer).
• zipit-macintosh-long-file-type (reader).
• (setf zipit-macintosh-long-file-type) (writer).
• zipit-macintosh-long-length (reader).
• (setf zipit-macintosh-long-length) (writer).
• zipit-macintosh-long-p (function).
• zipit-macintosh-long-signature (reader).
• (setf zipit-macintosh-long-signature) (writer).
• zipit-macintosh-long-size (reader).
• (setf zipit-macintosh-long-size) (writer).
• zipit-macintosh-short-dir-flags (reader).
• (setf zipit-macintosh-short-dir-flags) (writer).
• zipit-macintosh-short-dir-p (function).
• zipit-macintosh-short-dir-signature (reader).
• (setf zipit-macintosh-short-dir-signature) (writer).
• zipit-macintosh-short-dir-size (reader).
• (setf zipit-macintosh-short-dir-size) (writer).
• zipit-macintosh-short-dir-view (reader).
• (setf zipit-macintosh-short-dir-view) (writer).
• zipit-macintosh-short-file-creator (reader).
• (setf zipit-macintosh-short-file-creator) (writer).
• zipit-macintosh-short-file-file-type (reader).
• (setf zipit-macintosh-short-file-file-type) (writer).
• zipit-macintosh-short-file-flags (reader).
• (setf zipit-macintosh-short-file-flags) (writer).
• zipit-macintosh-short-file-p (function).
• zipit-macintosh-short-file-signature (reader).
• (setf zipit-macintosh-short-file-signature) (writer).
• zipit-macintosh-short-file-size (reader).
• (setf zipit-macintosh-short-file-size) (writer).

---

3.1.12 zippy/zippy.lisp

Dependency

structures.lisp (file).

Source

zippy.asd.

Parent Component

zippy (system).

Public Interface

• attributes (reader method).
• (setf attributes) (writer method).
• close (method).
• comment (reader method).
• comment (reader method).
• (setf comment) (writer method).
• (setf comment) (writer method).
• compress-zip (function).
• compression-method (reader method).
• (setf compression-method) (writer method).
• content (reader method).
• (setf content) (writer method).
• crc-32 (reader method).
• (setf crc-32) (writer method).
• disk (reader method).
• (setf disk) (writer method).
• disks (reader method).
• (setf disks) (writer method).
• encryption-method (reader method).
• (setf encryption-method) (writer method).
• entries (reader method).
• (setf entries) (writer method).
• entry-to-file (function).
• entry-to-stream (function).
• entry-to-vector (function).
• extra-fields (reader method).
• (setf extra-fields) (writer method).
• extract-zip (function).
• file-name (reader method).
• (setf file-name) (writer method).
• last-modified (reader method).
• (setf last-modified) (writer method).
• move-in-memory (function).
• offset (reader method).
• (setf offset) (writer method).
• print-object (method).
• print-object (method).
• size (reader method).
• (setf size) (writer method).
• uncompressed-size (reader method).
• (setf uncompressed-size) (writer method).
• version (reader method).
• (setf version) (writer method).
• with-zip-file (macro).
• zip-entry (class).
• zip-file (reader method).
• (setf zip-file) (writer method).
• zip-file (class).

Internals

ensure-zip-file (function).

---

3.1.13 zippy/decode.lisp

Dependency

zippy.lisp (file).

Source

zippy.asd.

Parent Component

zippy (system).

Public Interface

• archive-file-required (condition).
• decode-entry (function).
• decode-file (function).
• disk (reader method).
• open-zip-file (function).

Internals

• %make-chunk-decoder (function).
• call-with-input-zip-file (function).
• cde-to-entry (function).
• chunk-decoder (structure).
• chunk-decoder-buffer (reader).
• (setf chunk-decoder-buffer) (writer).
• chunk-decoder-decompression-state (reader).
• (setf chunk-decoder-decompression-state) (writer).
• chunk-decoder-decryption-state (reader).
• (setf chunk-decoder-decryption-state) (writer).
• chunk-decoder-end (reader).
• (setf chunk-decoder-end) (writer).
• chunk-decoder-input (reader).
• (setf chunk-decoder-input) (writer).
• chunk-decoder-p (function).
• chunk-decoder-size (reader).
• (setf chunk-decoder-size) (writer).
• chunk-decoder-start (reader).
• (setf chunk-decoder-start) (writer).
• copy-chunk-decoder (function).
• decode-central-directory (function).
• decode-chunk (function).
• decode-extra-fields (function).
• entry-raw-bytes (function).
• lf-to-entry (function).
• make-chunk-decoder (function).
• prepare-reading (function).
• process-extra-field (function).

---

3.1.14 zippy/encode.lisp

Dependency

decode.lisp (file).

Source

zippy.asd.

Parent Component

zippy (system).

Public Interface

encode-file (function).

Internals

• *zip64-needed* (special variable).
• add-extra-entry (function).
• backfill-from-content (function).
• cap-and-note-zip64 (function).
• determine-min-version (function).
• encode-entry-payload (function).
• entry-compression-id (function).
• entry-flags (function).
• entry-to-cd (function).
• entry-to-dd (function).
• entry-to-lf (function).
• entry-version (function).
• n-bit-and-note-zip64-p (function).

---

3.1.15 zippy/documentation.lisp

Dependency

encode.lisp (file).

Source

zippy.asd.

Parent Component

zippy (system).

---

5.1.1 Special variables

Special Variable: *compatibility* ¶

The default file attribute compatibility flag.

Package

org.shirakumo.zippy.

Source

toolkit.lisp.

Special Variable: *default-buffer-size* ¶

Default buffer size when working on compressed data.

For example this can be bound around calls to DECODE-ENTRY to give a more accurate size for the temporary buffer being allocated to decode a particular file.

See DECODE-ENTRY
See ENCODE-FILE
See MAKE-DECRYPTION-STATE
See MAKE-DECOMPRESSION-STATE

Package

org.shirakumo.zippy.

Source

toolkit.lisp.

---

5.1.2 Macros

Macro: define-byte-structure (name &body records) ¶

Define a new byte-coded structure.

NAME can either be the name of the structure, or a list of the name and the signature that identifies the record uniquely. If a signature is given, the structure is registered and can be used with the standard functions DECODE/READ/ENCODE/WRITE-STRUCTURE.

Each RECORD must be a list matching

(NAME TYPE &optional COUNT)

Where NAME identifies the field, TYPE identifies the name field’s bit type, and COUNT the number of expected entries for a variable sized record. If COUNT is specified, it may be an arbitrary expression that can reference earlier record values by name, and the resulting slot value will be an octet vector of that length.

The special record name SIZE may be used to identify a field that identifies the maximal size of the remaining structure payload. Any structure fields that would come after the dynamically read size has run out will be initialised to NIL.

TYPE may be one of ub8 ub16 ub32 ub64

This will generate a structure of NAME with the given records as slots, as well as four functions to encode and decode the structure, and one function to construct it. These functions are constructed according to the following schema:

(MAKE/DECODE/READ/ENCODE/WRITE)-NAME

The given function names are interned in the current package.

See DECODE-STRUCTURE
See READ-STRUCTURE
See ENCODE-STRUCTURE
See WRITE-STRUCTURE

Package

org.shirakumo.zippy.

Source

parser.lisp.

Macro: parse-structure (structure-type io-var) ¶

Parse the given structure type from the IO.

This advances the IO index.

See IO

Package

org.shirakumo.zippy.

Source

io.lisp.

Macro: with-io ((io target &rest args) &body body) ¶

Wraps TARGET in an appropriate IO context.

TARGET may be a string or pathname, a stream, or a vector. In the case of a pathname or string, IF-EXISTS and DIRECTION can be passed as arguments for OPEN. In the case off a vector, START and END may be passed to designate a sub-range of the vector.

See IO

Package

org.shirakumo.zippy.

Source

io.lisp.

Macro: with-zip-file ((file input &key start end) &body body) ¶

Open a zip file lexically and cleans up on exit.

If decoding is successful, FILE will be bound to the resulting ZIP-FILE instance. This instance is only valid within BODY. After leaving the BODY, you may still access metadata and zip entries, but you may not use DECODE-ENTRY to extract an entry’s payload.

See DECODE-ENTRY
See DECODE-FILE
See OPEN-ZIP-FILE

Package

org.shirakumo.zippy.

Source

zippy.lisp.

---

5.1.3 Ordinary functions

Function: compress-zip (file target &key start end if-exists strip-root password) ¶

Compresses the contents of the zip file to the given output.

FILE should be a ZIP-FILE.
TARGET should be a suitable target for WITH-IO.

See WITH-IO
See ENCODE-FILE
See ZIP-FILE

Package

org.shirakumo.zippy.

Source

zippy.lisp.

Function: compression-method-id (name) ¶

Returns the compression method ID for the given name.

If The name is not known, an error is signalled.

Package

org.shirakumo.zippy.

Source

tables.lisp.

Function: compression-method-name (id) ¶

Returns the compression method name for the given ID.

The name should be one of
:store
:shrink
:reduce-1
:reduce-2
:reduce-3
:reduce-4
:implode
:tokenizing
:deflate
:deflate64
:pkware-implode
:reserved
:bzip2
:reserved
:lzma
:reserved
:cmpsc
:reserved
:terse
:lz77
:zstd
:jpeg
:wavpack
:ppmd
:ae-x

If the ID is not known, an error is signalled.

Package

org.shirakumo.zippy.

Source

tables.lisp.

Function: decode-entry (function entry &key password) ¶

Decode the data payload of the ZIP-ENTRY

FUNCTION will be called repeatedly with three arguments:
An octet buffer with the raw data
A start index to the beginning of valid data
An end index to the end of valid data
It must return an integer indicating the last index that was consumed in the octet buffer. If the index is the same as START, DECODE-ENTRY will return with a value greater than zero.

PASSWORD should be supplied if the entry is encrypted. If the entry is encrypted, but no password is supplied, or the password is detectably incorrect, an error is signalled. The password may be a string or an octet-vector.

If an error is detected during decoding of the payload, an error is signalled.

If the zip file is split a condition of type ARCHIVE-FILE-REQUIRED may be signalled.

See ENTRY-TO-FILE
See ENTRY-TO-STREAM
See ENTRY-TO-VECTOR
See ARCHIVE-FILE-REQUIRED

Package

org.shirakumo.zippy.

Source

decode.lisp.

Function: decode-file (input) ¶

Decode the given IO into a ZIP-FILE.

If the zip file is split, will signal a condition of type ARCHIVE-FILE-REQUIRED for every disk that is required to read the central directory of the zip file.

May signal warnings if data mismatch or other correctable corruption is detected in the zip file.

May signal an error if an incorrectable corruption is detected in the zip file, or if the file is missing vital support structures that would make it a valid zip file.

See WITH-ZIP-FILE
See ARCHIVE-FILE-REQUIRED

Package

org.shirakumo.zippy.

Source

decode.lisp.

Function: decode-structure (vector index) ¶

Decodes a structure from the given vector at the given starting position.

A signature is expected at the input position. If no signature
is available, or if it is not recognised, an error is signalled.

Returns the structure instance and the ending index.

Package

org.shirakumo.zippy.

Source

parser.lisp.

Function: encode-file (zip-file output &key password version-made version-needed zip64) ¶

Encodes the given zip-file to the output IO.

This currently does not support split archive creation. All the entries will be written to the output.

This will cause the ZIP-ENTRIES in the ZIP-FILE to be modified.
In particular, SIZE, CRC-32, and UNCOMPRESSED-SIZE will be set, and LAST-MODIFIED, FILE-NAME, ATTRIBUTES, and COMPRESSION-METHOD may be set.

The created Zip file will include Zip64 metadata regardless of whether this is required, but it will only enforce Zip64 decoding if the number of entries, or the size of an entry exceeds the possible bounds of traditional 32-bit zip files.

If an encryption-method is specified for any entry, PASSWORD must be passed and will be used to encrypt the file.

See ZIP-FILE
See ZIP-ENTRY

Package

org.shirakumo.zippy.

Source

encode.lisp.

Function: encode-structure (structure vector index) ¶

Encodes the given structure to the vector at the given starting position.

This will encode it including its signature, if any.

Returns the ending index.

Package

org.shirakumo.zippy.

Source

parser.lisp.

Function: encryption-method-id (name) ¶

Returns the encryption method ID for the given name.

If The name is not known, an error is signalled.

Package

org.shirakumo.zippy.

Source

tables.lisp.

Function: encryption-method-name (id) ¶

Returns the encryption method name for the given ID.

The name should be one of
:des
:rc2
:3des-168
:3des-112
:aes-128
:aes-192
:aes-256
:rc2
:blowfish
:twofish
:rc4
:unknown

If the ID is not known, an error is signalled.

Package

org.shirakumo.zippy.

Source

tables.lisp.

Function: end (io) ¶

Returns the ending index of the IO.

See IO

Package

org.shirakumo.zippy.

Source

io.lisp.

Function: entry-to-file (path entry &key if-exists password restore-attributes) ¶

Decodes the contents of the entry to the given path.

This will attempt to restore the same file attributes as are contained in the entry’s metadata, unless :RESTORE-ATTRIBUTES NIL is passed.

See DECODE-ENTRY
See CL:OPEN
See ZIP-ENTRY

Package

org.shirakumo.zippy.

Source

zippy.lisp.

Function: entry-to-stream (stream entry &key password) ¶

Decodes the contents of the entry to the given octet output-stream.

See DECODE-ENTRY
See ZIP-ENTRY

Package

org.shirakumo.zippy.

Source

zippy.lisp.

Function: entry-to-vector (entry &key vector start password) ¶

Decodes the contents of the entry to an octet vector.

If an octet vector is passed explicitly through :VECTOR, the vector must be at least START+(UNCOMPRESSED-SIZE ENTRY) big.

See DECODE-ENTRY
See ZIP-ENTRY

Package

org.shirakumo.zippy.

Source

zippy.lisp.

Function: extract-zip (file path &key if-exists password) ¶

Extracts the contents of the zip file to the given directory.

FILE may either be a ZIP-FILE, or a suitable input for WITH-ZIP-FILE. PATH should be a directory pathname designator.

See ZIP-FILE
See ENTRY-TO-FILE
See WITH-ZIP-FILE

Package

org.shirakumo.zippy.

Source

zippy.lisp.

Function: file-attribute-id (name) ¶

Returns the file attribute ID for the given name.

If The name is not known, an error is signalled.

Package

org.shirakumo.zippy.

Source

tables.lisp.

Function: file-attribute-name (id) ¶

Returns the file attribute name for the given ID.

The name should be one of
:ms-dos
:amiga
:open-vms
:unix
:vm/cms
:atari-st
:os/2
:macintosh
:z-system
:cp/m
:ntfs
:mvs
:vse
:acorn-risc
:vfat
:alternate-mvs
:beos
:tandem
:os/400
:darwin

If the ID is not known, an error is signalled.

Package

org.shirakumo.zippy.

Source

tables.lisp.

Function: has-more (io) ¶

Returns whether the io has input left to read, or space left to write to.

See IO

Package

org.shirakumo.zippy.

Source

io.lisp.

Function: index (io) ¶

Returns the current index into the IO.

This should always be in the range of [START, END].

See IO

Package

org.shirakumo.zippy.

Source

io.lisp.

Function: move-in-memory (file) ¶

Moves the zip archive into memory. This will be far faster for repeat access and decompression.

Does nothing if the file is already in-memory.
Signals an error if any of the disks are closed streams.

See ZIP-FILE

Package

org.shirakumo.zippy.

Source

zippy.lisp.

Function: open-zip-file (input &key start end) ¶

Opens a zip file and parses its directory.

Returns two values if successful:
The new ZIP-FILE that was parsed
A list of streams that were opened

After closing the streams the ZIP-FILE contents cannot be extracted, so you must take care to close them at the opportune time yourself. For a lexical variant of this, see WITH-ZIP-FILE.

INPUT may be a pathname or string to designate a local file, a seekable stream to read from, or an octet-vector to decode.

If the zip file is split and the supplied INPUT is a pathname designator, other split disks will be determined automatically by using the same pathname, but substituting the pathname-type by the scheme z{DISK} . If INPUT is not a pathname designator, a condition of type ARCHIVE-FILE-REQUIRED is signalled for every split disk that is required, for which you should invoke the USE-VALUE restart with the newly opened stream.

See ZIP-FILE
See DECODE-FILE
See DECODE-ENTRY
See ARCHIVE-FILE-REQUIRED
See WITH-ZIP-FILE

Package

org.shirakumo.zippy.

Source

decode.lisp.

Function: output (io array start end) ¶

Writes the given array of octets to the IO.

If the IO does not have sufficient space available, an error is signalled.

See IO

Package

org.shirakumo.zippy.

Source

io.lisp.

Function: parse-structure* (io) ¶

Parses a structure from the IO assuming a leading 32 bit signature.

If no suitable structure can be found, an error is
signalled. Otherwise, the parsed structure instance is returned.

This advances the IO index.

See IO

Package

org.shirakumo.zippy.

Source

io.lisp.

Function: read-structure (stream) ¶

Decodes a structure from the given stream.

A signature is expected at the input position. If no signature is available, or if it is not recognised, an error is signalled. Returns the structure instance otherwise.

Package

org.shirakumo.zippy.

Source

parser.lisp.

Function: seek (io target) ¶

Seek the io to the requested index.

If the index is outside the allowed ranges, an error is signalled.

See IO

Package

org.shirakumo.zippy.

Source

io.lisp.

Function: start (io) ¶

Returns the starting index of the IO.

See IO

Package

org.shirakumo.zippy.

Source

io.lisp.

Function: ub32 (io) ¶

Reads a 32 bit unsigned integer from the IO and returns it.

This will advance the IO index.

See IO

Package

org.shirakumo.zippy.

Source

io.lisp.

Reader: vector-input-end (instance) ¶

Returns the ending index of the vector.

See VECTOR-INPUT

Package

org.shirakumo.zippy.

Source

io.lisp.

Target Slot

end.

Reader: vector-input-index (instance) ¶

Accesses the current index into the vector.

See VECTOR-INPUT

Package

org.shirakumo.zippy.

Source

io.lisp.

Target Slot

index.

Writer: (setf vector-input-index) (instance) ¶

Package

org.shirakumo.zippy.

Source

io.lisp.

Target Slot

index.

Reader: vector-input-start (instance) ¶

Returns the starting index of the vector.

See VECTOR-INPUT

Package

org.shirakumo.zippy.

Source

io.lisp.

Target Slot

start.

Reader: vector-input-vector (instance) ¶

Returns the vector the vector-input is backing.

See VECTOR-INPUT

Package

org.shirakumo.zippy.

Source

io.lisp.

Target Slot

vector.

Function: write-structure (structure stream) ¶

Encodes the given structure to the stream.

This will encode it including its signature, if any.

Package

org.shirakumo.zippy.

Source

parser.lisp.

Function: write-structure* (structure io) ¶

Writes the given structure to the IO.

This advances the IO index.

See IO

Package

org.shirakumo.zippy.

Source

io.lisp.

---

5.1.4 Generic functions

Generic Reader: attributes (object) ¶

Accesses the file attributes.

This should be a list of three entries, the MSDOS file attribute list, the compatibility identifier, and the system-specific attributes encoded as an integer.

For ZIP-ENTRIES that are backed by a file, this entry is computed automatically when the entry is encoded.

See FILE-ATTRIBUTE-NAME
See ZIP-ENTRY
See ORG.SHIRAKUMO.FILE-ATTRIBUTES:PERMISSIONS

Package

org.shirakumo.zippy.

Methods

Reader Method: attributes ((zip-entry zip-entry)) ¶

automatically generated reader method

Source

zippy.lisp.

Target Slot

attributes.

Generic Writer: (setf attributes) (object) ¶

Package

org.shirakumo.zippy.

Methods

Writer Method: (setf attributes) ((zip-entry zip-entry)) ¶

automatically generated writer method

Source

zippy.lisp.

Target Slot

attributes.

Generic Function: call-with-completed-compressed-buffer (function state) ¶

Finishes the compression and calls the function with tail data.

The function is called with three arguments:
An octet buffer with the compressed data
A start index to the beginning of valid data
An end index to the end of valid data

The supplied STATE must be a state obtained through MAKE-COMPRESSION-STATE. The VECTOR, START, and END supply the octets to compress.

You must call this function only once, after all data has been processed via CALL-WITH-COMPRESSED-BUFFER. Further calls to CALL-WITH-COMPRESSED-BUFFER after this function has been called are illegal.

See MAKE-COMPRESSION-STATE
See CALL-WITH-COMPRESSED-BUFFER

Package

org.shirakumo.zippy.

Source

compression.lisp.

Methods

Method: call-with-completed-compressed-buffer (function (state deflate-compressor)) ¶

Method: call-with-completed-compressed-buffer (function (state (eql nil))) ¶

Generic Function: call-with-completed-encrypted-buffer (function state) ¶

Finishes the encryption and calls the function with tail data.

The function is called with three arguments:
An octet buffer with the compressed data
A start index to the beginning of valid data
An end index to the end of valid data

The supplied STATE must be a state obtained through MAKE-ENCRYPTION-STATE. The VECTOR, START, and END supply the octets to compress.

You must call this function only once, after all data has been processed via CALL-WITH-ENCRYPTED-BUFFER. Further calls to CALL-WITH-ENCRYPTED-BUFFER after this function has been called are illegal.

See MAKE-ENCRYPTION-STATE
See CALL-WITH-ENCRYPTED-BUFFER

Package

org.shirakumo.zippy.

Source

encryption.lisp.

Methods

Method: call-with-completed-encrypted-buffer (function (state (eql nil))) ¶

Generic Function: call-with-compressed-buffer (function vector start end state) ¶

Call the supplied function with a compressed buffer.

The function is called with three arguments:
An octet buffer with the compressed data
A start index to the beginning of valid data
An end index to the end of valid data

The supplied STATE must be a state obtained through MAKE-COMPRESSION-STATE. The VECTOR, START, and END supply the octets to compress.

You may call this function repeatedly with new input to compress until the full region has been processed. The supplied function likewise may be called multiple times per compression run.

See MAKE-COMPRESSION-STATE
See CALL-WITH-COMPLETED-COMPRESSED-BUFFER

Package

org.shirakumo.zippy.

Source

compression.lisp.

Methods

Method: call-with-compressed-buffer (function vector start end (state deflate-compressor)) ¶

Method: call-with-compressed-buffer (function vector start end (state null)) ¶

Generic Function: call-with-decompressed-buffer (function vector start end state) ¶

Call the supplied function with a decompressed buffer.

The function is called with three arguments:
An octet buffer with the decompressed data
A start index to the beginning of valid data
An end index to the end of valid data
It must return an integer indicating the last index that was consumed in the octet buffer. If the index is the same as START, DECODE-ENTRY will return.

The supplied STATE must be a state obtained through MAKE-DECOMPRESSION-STATE. The VECTOR, START, and END supply the octets to decompress.

You may call this function repeatedly with new input to decompress until the full region has been processed. The supplied function likewise may be called multiple times per decompression run.

This function returns how much of the supplied buffer has been consumed. If the function return START, it should not be called again until external circumstances allow the inner function to continue.

See MAKE-DECOMPRESSION-STATE

Package

org.shirakumo.zippy.

Source

compression.lisp.

Methods

Method: call-with-decompressed-buffer (function input start end (state deflate-state)) ¶

Method: call-with-decompressed-buffer (function input start end (state (eql nil))) ¶

Generic Function: call-with-decrypted-buffer (function input length state) ¶

Call the supplied function with a decrypted buffer.

The function is called with three arguments:
An octet buffer with the decrypted data
A start index to the beginning of valid data
An end index to the end of valid data
It must return an integer indicating the last index that was consumed in the octet buffer. If the index is the same as START, DECODE-ENTRY will return.

The supplied STATE must be a state obtained through MAKE-DECRPTIION-STATE. The VECTOR, START, and END supply the octets to decrypt.

You may call this function repeatedly with new input to decrypt until the full region has been processed. The supplied function likewise may be called multiple times per decryption run.

This function returns how much of the supplied buffer has been consumed. If the function return START, it should not be called again until external circumstances allow the inner function to continue.

See MAKE-DECRYPTION-STATE

Package

org.shirakumo.zippy.

Source

encryption.lisp.

Methods

Method: call-with-decrypted-buffer (function (input vector-input) length (state pkware-decrypt-state)) ¶

Source

pkware-encryption.lisp.

Method: call-with-decrypted-buffer (function (input stream) length (state pkware-decrypt-state)) ¶

Source

pkware-encryption.lisp.

Method: call-with-decrypted-buffer (function (input vector-input) length state) ¶

Method: call-with-decrypted-buffer (function (input stream) length (state stream-decryption-state)) ¶

Generic Function: call-with-encrypted-buffer (function vector start end state) ¶

Call the supplied function with an encrypted buffer.

The function is called with three arguments:
An octet buffer with the encrypted data
A start index to the beginning of valid data
An end index to the end of valid data

The supplied STATE must be a state obtained through MAKE-ENCRYPTION-STATE. The VECTOR, START, and END supply the octets to encrypt.

You may call this function repeatedly with new input to encrypt until the full region has been processed. The supplied function likewise may be called multiple times per encryption run.

See MAKE-ENCRYPTION-STATE
See CALL-WITH-COMPLETED-ENCRYPTED-BUFFER

Package

org.shirakumo.zippy.

Source

encryption.lisp.

Methods

Method: call-with-encrypted-buffer (function vector start end (state (eql nil))) ¶

Generic Reader: comment (object) ¶

Accessor to the comment of the zip-file or entry.

See ZIP-FILE
See ZIP-ENTRY

Package

org.shirakumo.zippy.

Methods

Reader Method: comment ((zip-entry zip-entry)) ¶

automatically generated reader method

Source

zippy.lisp.

Target Slot

comment.

Reader Method: comment ((zip-file zip-file)) ¶

automatically generated reader method

Source

zippy.lisp.

Target Slot

comment.

Generic Writer: (setf comment) (object) ¶

Package

org.shirakumo.zippy.

Methods

Writer Method: (setf comment) ((zip-entry zip-entry)) ¶

automatically generated writer method

Source

zippy.lisp.

Target Slot

comment.

Writer Method: (setf comment) ((zip-file zip-file)) ¶

automatically generated writer method

Source

zippy.lisp.

Target Slot

comment.

Generic Reader: compression-method (condition) ¶

Accesses the compression method used to compress the file contents.

This should either be NIL or a keyword naming the compression method.

See COMPRESSION-METHOD-NAME
See ZIP-ENTRY

Package

org.shirakumo.zippy.

Methods

Reader Method: compression-method ((zip-entry zip-entry)) ¶

automatically generated reader method

Source

zippy.lisp.

Target Slot

compression-method.

Reader Method: compression-method ((condition unsupported-compression-method)) ¶

Source

conditions.lisp.

Target Slot

compression-method.

Generic Writer: (setf compression-method) (object) ¶

Package

org.shirakumo.zippy.

Methods

Writer Method: (setf compression-method) ((zip-entry zip-entry)) ¶

automatically generated writer method

Source

zippy.lisp.

Target Slot

compression-method.

Generic Reader: content (object) ¶

Accesses the backing content of the file.

This slot must be set by the user to a suitable source for the file’s contents. It may be either a string or pathname to designate a file from disk, an octet input-stream, an octet vector, or an IO instance.

See IO
See ZIP-ENTRY

Package

org.shirakumo.zippy.

Methods

Reader Method: content ((zip-entry zip-entry)) ¶

automatically generated reader method

Source

zippy.lisp.

Target Slot

content.

Generic Writer: (setf content) (object) ¶

Package

org.shirakumo.zippy.

Methods

Writer Method: (setf content) ((zip-entry zip-entry)) ¶

automatically generated writer method

Source

zippy.lisp.

Target Slot

content.

Generic Reader: crc-32 (object) ¶

Accesses the CRC-32 checksum of the file contents.

This is computed and set automatically when the entry is encoded.

See ZIP-ENTRY

Package

org.shirakumo.zippy.

Methods

Reader Method: crc-32 ((zip-entry zip-entry)) ¶

automatically generated reader method

Source

zippy.lisp.

Target Slot

crc-32.

Generic Writer: (setf crc-32) (object) ¶

Package

org.shirakumo.zippy.

Methods

Writer Method: (setf crc-32) ((zip-entry zip-entry)) ¶

automatically generated writer method

Source

zippy.lisp.

Target Slot

crc-32.

Generic Reader: disk (object) ¶

Accesses the disk ID on which the contents of this file start.

This slot should not be set by the user.

See OFFSET
See ZIP-ENTRY

Package

org.shirakumo.zippy.

Methods

Reader Method: disk ((condition archive-file-required)) ¶

Source

decode.lisp.

Target Slot

disk.

Reader Method: disk ((zip-entry zip-entry)) ¶

automatically generated reader method

Source

zippy.lisp.

Target Slot

disk.

Generic Writer: (setf disk) (object) ¶

Package

org.shirakumo.zippy.

Methods

Writer Method: (setf disk) ((zip-entry zip-entry)) ¶

automatically generated writer method

Source

zippy.lisp.

Target Slot

disk.

Generic Reader: disks (object) ¶

Accessor to the vector of IO instances representing the zip-file’s disks.

This vector is managed automatically.

See ZIP-FILE
See IO

Package

org.shirakumo.zippy.

Methods

Reader Method: disks ((zip-file zip-file)) ¶

automatically generated reader method

Source

zippy.lisp.

Target Slot

disks.

Generic Writer: (setf disks) (object) ¶

Package

org.shirakumo.zippy.

Methods

Writer Method: (setf disks) ((zip-file zip-file)) ¶

automatically generated writer method

Source

zippy.lisp.

Target Slot

disks.

Generic Reader: encryption-method (condition) ¶

Accesses the encryption method used to encrypt the file contents.

This should either be NIL, a keyword, or a list of a keyword and extra parameters. The keyword identifies the name of the encryption method. Additionally to the names listed in ENCRYPTION-METHOD-NAME, the names :AE-1 and :AE-2 are allowed.

See ENCRYPTION-METHOD-NAME
See ZIP-ENTRY

Package

org.shirakumo.zippy.

Methods

Reader Method: encryption-method ((zip-entry zip-entry)) ¶

automatically generated reader method

Source

zippy.lisp.

Target Slot

encryption-method.

Reader Method: encryption-method ((condition unsupported-encryption-method)) ¶

Source

conditions.lisp.

Target Slot

encryption-method.

Generic Writer: (setf encryption-method) (object) ¶

Package

org.shirakumo.zippy.

Methods

Writer Method: (setf encryption-method) ((zip-entry zip-entry)) ¶

automatically generated writer method

Source

zippy.lisp.

Target Slot

encryption-method.

Generic Reader: entries (object) ¶

Accessor to the vector of zip-entry instances for the zip-file.

See ZIP-FILE
See ZIP-ENTRY

Package

org.shirakumo.zippy.

Methods

Reader Method: entries ((zip-file zip-file)) ¶

automatically generated reader method

Source

zippy.lisp.

Target Slot

entries.

Generic Writer: (setf entries) (object) ¶

Package

org.shirakumo.zippy.

Methods

Writer Method: (setf entries) ((zip-file zip-file)) ¶

automatically generated writer method

Source

zippy.lisp.

Target Slot

entries.

Generic Reader: extra-fields (object) ¶

Accesses the list of extra data structures for the entry.

This slot should not be set by the user.

See ZIP-ENTRY

Package

org.shirakumo.zippy.

Methods

Reader Method: extra-fields ((zip-entry zip-entry)) ¶

automatically generated reader method

Source

zippy.lisp.

Target Slot

extra-fields.

Generic Writer: (setf extra-fields) (object) ¶

Package

org.shirakumo.zippy.

Methods

Writer Method: (setf extra-fields) ((zip-entry zip-entry)) ¶

automatically generated writer method

Source

zippy.lisp.

Target Slot

extra-fields.

Generic Reader: file-name (object) ¶

Accesses the relative path designating where the file belongs on a hirearchical file system.

When the entry is encoded and this slot is unset, it may be computed
automatically if the entry is backed by a file. Otherwise, an error is
signalled.

The path must be relative, and must use forward slashes as the
directory separator.

See ZIP-ENTRY

Package

org.shirakumo.zippy.

Methods

Reader Method: file-name ((zip-entry zip-entry)) ¶

automatically generated reader method

Source

zippy.lisp.

Target Slot

file-name.

Generic Writer: (setf file-name) (object) ¶

Package

org.shirakumo.zippy.

Methods

Writer Method: (setf file-name) ((zip-entry zip-entry)) ¶

automatically generated writer method

Source

zippy.lisp.

Target Slot

file-name.

Generic Reader: last-modified (object) ¶

Accesses the universal time designating the last time the entry’s contents were modified.

If unset, and the entry is backed by a file, this slot is
automatically computed when the entry is encoded.

See ZIP-ENTRY

Package

org.shirakumo.zippy.

Methods

Reader Method: last-modified ((zip-entry zip-entry)) ¶

automatically generated reader method

Source

zippy.lisp.

Target Slot

last-modified.

Generic Writer: (setf last-modified) (object) ¶

Package

org.shirakumo.zippy.

Methods

Writer Method: (setf last-modified) ((zip-entry zip-entry)) ¶

automatically generated writer method

Source

zippy.lisp.

Target Slot

last-modified.

Generic Function: make-compression-state (format &key buffer) ¶

Create the state necessary to compress given the requested compression format.

If required, the supplied buffer spec should be used to create the
output buffer for the compression. The buffer spec may be either NIL
for a default buffer, an octet vector, or an integer for an octet
vector of the given size.

See CALL-WITH-COMPRESSED-BUFFER
See CALL-WITH-COMPLETED-COMPRESSED-BUFFER

Package

org.shirakumo.zippy.

Source

compression.lisp.

Methods

Method: make-compression-state ((format (eql :deflate)) &key buffer) ¶

Method: make-compression-state ((format (eql :store)) &key buffer) ¶

Method: make-compression-state ((format (eql nil)) &key buffer) ¶

Generic Function: make-decompression-state (format &key buffer) ¶

Create the state necessary to decompress given the requested compression format.

If required, the supplied buffer spec should be used to create the
output buffer for the decompression. The buffer spec may be either NIL
for a default buffer, an octet vector, or an integer for an octet
vector of the given size.

See CALL-WITH-DECOMPRESSED-BUFFER

Package

org.shirakumo.zippy.

Source

compression.lisp.

Methods

Method: make-decompression-state ((format (eql :deflate)) &key buffer) ¶

Method: make-decompression-state ((format (eql :store)) &key buffer) ¶

Method: make-decompression-state ((format (eql nil)) &key buffer) ¶

Method: make-decompression-state (format &key buffer) ¶

Generic Function: make-decryption-state (format input password &key buffer &allow-other-keys) ¶

Create the state necessary to decrypt given the requested encryption format.

If required, the supplied buffer spec should be used to create the output buffer for the decryption. The buffer spec may be either NIL
for a default buffer, an octet vector, or an integer for an octet
vector of the given size.

The given password may be a string or octet vector supplying the password for decryption.

See CALL-WITH-DECRYPTED-BUFFER

Package

org.shirakumo.zippy.

Source

encryption.lisp.

Methods

Method: make-decryption-state ((format (eql :pkware)) (input vector-input) password &key buffer) ¶

Source

pkware-encryption.lisp.

Method: make-decryption-state ((format (eql :pkware)) (input stream) password &key buffer) ¶

Source

pkware-encryption.lisp.

Method: make-decryption-state ((format (eql nil)) (input stream) password &key buffer) ¶

Method: make-decryption-state ((format (eql nil)) (input vector-input) password &key buffer) ¶

Method: make-decryption-state (format input password &rest args) ¶

Generic Function: make-encryption-state (format password &key buffer) ¶

Create the state necessary to encrypt given the requested encryption format.

If required, the supplied buffer spec should be used to create the output buffer for the encryption. The buffer spec may be either NIL
for a default buffer, an octet vector, or an integer for an octet
vector of the given size.

See CALL-WITH-ENCRYPTED-BUFFER
See CALL-WITH-COMPLETED-ENCRYPTED-BUFFER

Package

org.shirakumo.zippy.

Source

encryption.lisp.

Methods

Method: make-encryption-state ((format (eql nil)) password &key buffer) ¶

Generic Reader: message (condition) ¶

Package

org.shirakumo.zippy.

Methods

Reader Method: message ((condition malformed-file)) ¶

Source

conditions.lisp.

Target Slot

message.

Generic Reader: object (condition) ¶

Package

org.shirakumo.zippy.

Methods

Reader Method: object ((condition integer-too-large)) ¶

Source

conditions.lisp.

Target Slot

object.

Reader Method: object ((condition unknown-structure-type)) ¶

Source

conditions.lisp.

Target Slot

object.

Generic Reader: offset (object) ¶

Accesses the octet index at which the contents of this file start on its disk.

This slot should not be set by the user.

See DISK
See ZIP-ENTRY

Package

org.shirakumo.zippy.

Methods

Reader Method: offset ((zip-entry zip-entry)) ¶

automatically generated reader method

Source

zippy.lisp.

Target Slot

offset.

Generic Writer: (setf offset) (object) ¶

Package

org.shirakumo.zippy.

Methods

Writer Method: (setf offset) ((zip-entry zip-entry)) ¶

automatically generated writer method

Source

zippy.lisp.

Target Slot

offset.

Generic Reader: parameter (condition) ¶

Package

org.shirakumo.zippy.

Methods

Reader Method: parameter ((condition zip64-required)) ¶

Source

conditions.lisp.

Target Slot

parameter.

Generic Reader: required-version (condition) ¶

Package

org.shirakumo.zippy.

Methods

Reader Method: required-version ((condition required-version-mismatched)) ¶

Source

conditions.lisp.

Target Slot

required-version.

Generic Reader: signature (condition) ¶

Package

org.shirakumo.zippy.

Methods

Reader Method: signature ((condition mismatched-type-signature)) ¶

Source

conditions.lisp.

Target Slot

signature.

Reader Method: signature ((condition unknown-block-signature)) ¶

Source

conditions.lisp.

Target Slot

signature.

Generic Function: size (io) ¶

Returns the size of the object in octets.

For zip-entries this is the number of octets in compressed format as they are in the archive.

See ZIP-ENTRY
See IO

Package

org.shirakumo.zippy.

Methods

Reader Method: size ((zip-entry zip-entry)) ¶

automatically generated reader method

Source

zippy.lisp.

Target Slot

size.

Method: size ((io stream)) ¶

Source

io.lisp.

Method: size ((io vector-input)) ¶

Source

io.lisp.

Generic Writer: (setf size) (object) ¶

Package

org.shirakumo.zippy.

Methods

Writer Method: (setf size) ((zip-entry zip-entry)) ¶

automatically generated writer method

Source

zippy.lisp.

Target Slot

size.

Generic Reader: specified-version (condition) ¶

Package

org.shirakumo.zippy.

Methods

Reader Method: specified-version ((condition required-version-mismatched)) ¶

Source

conditions.lisp.

Target Slot

specified-version.

Generic Reader: target (condition) ¶

Package

org.shirakumo.zippy.

Methods

Reader Method: target ((condition out-of-bounds-seek)) ¶

Source

conditions.lisp.

Target Slot

target.

Generic Reader: uncompressed-size (object) ¶

Accesses the octet size of the entry’s uncompressed data payload.

If unset, this slot is automatically computed when the entry is encoded.

See ZIP-ENTRY

Package

org.shirakumo.zippy.

Methods

Reader Method: uncompressed-size ((zip-entry zip-entry)) ¶

automatically generated reader method

Source

zippy.lisp.

Target Slot

uncompressed-size.

Generic Writer: (setf uncompressed-size) (object) ¶

Package

org.shirakumo.zippy.

Methods

Writer Method: (setf uncompressed-size) ((zip-entry zip-entry)) ¶

automatically generated writer method

Source

zippy.lisp.

Target Slot

uncompressed-size.

Generic Reader: value (condition) ¶

Package

org.shirakumo.zippy.

Methods

Reader Method: value ((condition unknown-enum-value)) ¶

Source

conditions.lisp.

Target Slot

value.

Generic Reader: version (object) ¶

Returns the Zip file version needed to extract this entry.

The version is a list of two integers.

This slot should not be set by the user.

See ZIP-ENTRY

Package

org.shirakumo.zippy.

Methods

Reader Method: version ((zip-entry zip-entry)) ¶

automatically generated reader method

Source

zippy.lisp.

Target Slot

version.

Generic Writer: (setf version) (object) ¶

Package

org.shirakumo.zippy.

Methods

Writer Method: (setf version) ((zip-entry zip-entry)) ¶

automatically generated writer method

Source

zippy.lisp.

Target Slot

version.

Generic Reader: zip-file (object) ¶

Returns the zip-file instance this entry is a part of.

See ZIP-ENTRY
See ZIP-FILE

Package

org.shirakumo.zippy.

Methods

Reader Method: zip-file ((zip-entry zip-entry)) ¶

automatically generated reader method

Source

zippy.lisp.

Target Slot

zip-file.

Generic Writer: (setf zip-file) (object) ¶

Package

org.shirakumo.zippy.

Methods

Writer Method: (setf zip-file) ((zip-entry zip-entry)) ¶

automatically generated writer method

Source

zippy.lisp.

Target Slot

zip-file.

---