Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the zip Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 15:33:11 2020 GMT+0.
• Introduction | What zip is all about | |
• Systems | The systems documentation | |
• Files | The files documentation | |
• Packages | The packages documentation | |
• Definitions | The symbols documentation | |
• Indexes | Concepts, functions, variables and data types |
Common Lisp ZIP library A library for .zip-file reading and writing, written in Common Lisp. Credits: David Lichteblau, Tomas Hlavaty. Thanks to everyone who has contributed patches. Send bug reports to [1]([2]list information). Thanks to [3]common-lisp.net for web site and mailing list hosting. Please note the repository on [4]github. Uses [5]salza2 for compression, [6]flexi-streams for external format support, [7]trivial-gray-streams for gray streams portability, and includes [8]inflate.cl for decompression. Recent changes 2015: Move to github, and backport of changes from downstream fork (Thanks to Tomas Hlavaty.) 2006 -- 2011: During this time a fork occurred. The common-lisp.net version of the library received little attention, except that it was ported to ASDF2. (Thanks to Faré Rideau.) 2006: Fixed the gray stream port, including a data corruption bug that was in CVS for some time. (Thanks to Kevin Reid and others.) Switched to flexi-stream external-format functions for portability. Uses trivial-gray-streams now. Allegro 8.0 fix (thanks to Edi Weitz). Comment support (thanks to Surendra Singhi). Incompatible change: Don't bind *locale* on Allegro anymore. 2005-04-05: ACL fixes (thank to Edi Weitz). Lispworks port (thanks to Sean Ross). Store file-write-date (also fixes FilZip compatibility). Download * Using Quicklisp (if in doubt, this is a good way to get started): (ql:quickload :zip) * From github: git clone https://github.com/bluelisp/zip * Using clbuild2 from github: clbuild install-from-upstream zip -- For the one or two clbuild users out there * Using clbuild2 via QuickLisp: clbuild quickload zip -- Ditto * Tarball releases -- Unfortunately we are not currently offering a release tarball for download. Portability Needs gray streams. The original version had separate support out-of-the-box on SBCL, Lispworks, and ACL. The fork briefly introduced some features specific to simple-stream / ACL. We believe the library to currently be portable to most popular Common Lisp implementations, but patches are welcome. ZIP-file reading Zip archives are represented as opaque handles. Entries of the zip-file are named by strings and represented as objects, too. Function OPEN-ZIPFILE (pathname) => zipfile Open .zip-file pathname for reading and return a handle for it. Function CLOSE-ZIPFILE (zipfile) Close the file handle. Macro WITH-ZIPFILE ((var pathname) &body body) => result of body Bind var to the result of open-zipfile, evaluate body as an implicit progn and call close-zipfile before exiting. Function GET-ZIPFILE-ENTRY (name zipfile) => zipfile-entry Return an entry handle for the file called name. Function ZIPFILE-ENTRIES (zipfile) => hash-table Return a hash-table mapping filenames to entry handles for all files contained in the zip archive. Macro DO-ZIPFILE-ENTRIES ((name-var entry-var zipfile) &body body) => nil Map over all entries in zipfile binding name-var and entry-var to each file name and entry handle in turn. Establish implicit block named nil around the loop. Function ZIPFILE-ENTRY-NAME (zipfile-entry) => string Return an entry's file name as a string. Function ZIPFILE-ENTRY-CONTENTS (entry &optional stream) => see below If stream is given, extract entry to the (unsigned-byte 8) stream given as the argument. Otherwise, return the entry contents as an (unsigned-byte 8) vector. Function UNZIP (pathname target-directory &key if-exists verbose) => nil Extract all entries from the zip archive at pathname into target-directory. if-exists as for [9]cl:open. ZIP-file writing zipwriters are handles used to create zip archives. They are distinct from the zip handles used for reading. Macro WITH-OUTPUT-TO-ZIPFILE ((var pathname &key if-exists) &body body) Function WRITE-ZIPENTRY (zipwriter name data &key file-write-date) Append a new entry called name to zipwriter. Read data from (unsigned-byte 8) stream data until EOF and compress it into "deflate"-format. Use file-write-date as the entry's date and time. Default to (file-write-date data), use 1980-01-01T00:00 if nil. Function ZIP (pathname source-directory &key if-exists) Compress all files in source-directory recursively into a new zip archive at pathname. Note that entry file names will not contain the name source-directory. Bookmark [10]spec References 1. mailto:zip-devel@common-lisp.net 2. http://common-lisp.net/cgi-bin/mailman/listinfo/zip-devel 3. http://common-lisp.net/ 4. https://github.com/bluelisp/zip 5. http://www.xach.com/lisp/salza2/ 6. http://www.weitz.de/flexi-streams/ 7. http://common-lisp.net/project/cl-plus-ssl/#trivial-gray-streams 8. http://opensource.franz.com/deflate/ 9. http://www.xach.com/clhs.php?open 10. http://www.pkware.com/company/standards/appnote/appnote.txt
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
• The zip system |
David Lichteblau and contributors <zip-devel@common-lisp.net>
Lisp-LGPL (and some parts BSD-style, see LICENSE for details)
Library for ZIP archive file reading and writing
zip.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
• Lisp files |
• The zip.asd file | ||
• The zip/package.lisp file | ||
• The zip/gray.lisp file | ||
• The zip/ifstar.lisp file | ||
• The zip/inflate.lisp file | ||
• The zip/zip.lisp file |
Next: The zip/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
zip.asd
zip (system)
silent-source-file (class)
Next: The zip/gray․lisp file, Previous: The zip․asd file, Up: Lisp files [Contents][Index]
Next: The zip/ifstar․lisp file, Previous: The zip/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
zip (system)
gray.lisp
Next: The zip/inflate․lisp file, Previous: The zip/gray․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
zip (system)
ifstar.lisp
Next: The zip/zip․lisp file, Previous: The zip/ifstar․lisp file, Up: Lisp files [Contents][Index]
zip (system)
inflate.lisp
Previous: The zip/inflate․lisp file, Up: Lisp files [Contents][Index]
zip (system)
zip.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
• The zip-system package | ||
• The zip package |
Next: The zip package, Previous: Packages, Up: Packages [Contents][Index]
zip.asd
silent-source-file (class)
Previous: The zip-system package, Up: Packages [Contents][Index]
package.lisp (file)
Definitions are sorted by export status, category, package, and then by lexicographic order.
• Exported definitions | ||
• Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
• Exported macros | ||
• Exported functions | ||
• Exported generic functions | ||
• Exported structures |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Next: Exported generic functions, Previous: Exported macros, Up: Exported definitions [Contents][Index]
inflate.lisp (file)
inflate.lisp (file)
Copy uncompressed bytes from IN to OUT and return values like COMPRESS.
Next: Exported structures, Previous: Exported functions, Up: Exported definitions [Contents][Index]
Previous: Exported generic functions, Up: Exported definitions [Contents][Index]
zip.lisp (file)
structure-object (structure)
zipfile-stream (function)
(setf zipfile-stream) (function)
zipfile-entries (function)
(setf zipfile-entries) (function)
Previous: Exported definitions, Up: Definitions [Contents][Index]
• Internal constants | ||
• Internal special variables | ||
• Internal macros | ||
• Internal functions | ||
• Internal generic functions | ||
• Internal structures | ||
• Internal classes |
Next: Internal special variables, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
Next: Internal macros, Previous: Internal constants, Up: Internal definitions [Contents][Index]
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
ifstar.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
ifstar.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
SYS:SRC;CODE;SEQ.LISP (not found)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
inflate.lisp (file)
Next: Internal structures, Previous: Internal functions, Up: Internal definitions [Contents][Index]
automatically generated reader method
gray.lisp (file)
automatically generated writer method
gray.lisp (file)
automatically generated reader method
gray.lisp (file)
automatically generated writer method
gray.lisp (file)
Next: Internal classes, Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
inflate.lisp (file)
structure-object (structure)
bit-reader-stream (function)
(setf bit-reader-stream) (function)
bit-reader-last-byte (function)
(setf bit-reader-last-byte) (function)
bit-reader-bits (function)
(setf bit-reader-bits) (function)
zip.lisp (file)
structure-object (structure)
zipfile-entry-name (function)
(setf zipfile-entry-name) (function)
zipfile-entry-stream (function)
(setf zipfile-entry-stream) (function)
zipfile-entry-offset (function)
(setf zipfile-entry-offset) (function)
zipfile-entry-size (function)
(setf zipfile-entry-size) (function)
zipfile-entry-compressed-size (function)
(setf zipfile-entry-compressed-size) (function)
zipfile-entry-comment (function)
(setf zipfile-entry-comment) (function)
zipfile-entry-date (function)
(setf zipfile-entry-date) (function)
zipfile-entry-mode (function)
(setf zipfile-entry-mode) (function)
zip.lisp (file)
structure-object (structure)
zipwriter-stream (function)
(setf zipwriter-stream) (function)
zipwriter-compressor (function)
(setf zipwriter-compressor) (function)
zipwriter-head (function)
(setf zipwriter-head) (function)
zipwriter-tail (function)
(setf zipwriter-tail) (function)
zip.lisp (file)
structure-object (structure)
zipwriter-entry-file-mode (function)
(setf zipwriter-entry-file-mode) (function)
zipwriter-entry-name (function)
(setf zipwriter-entry-name) (function)
zipwriter-entry-position (function)
(setf zipwriter-entry-position) (function)
zipwriter-entry-header (function)
(setf zipwriter-entry-header) (function)
Previous: Internal structures, Up: Internal definitions [Contents][Index]
gray.lisp (file)
:buf
buf (generic function)
(setf buf) (generic function)
0
pos (generic function)
(setf pos) (generic function)
zip.asd
cl-source-file (class)
perform (method)
gray.lisp (file)
:input-handle
input-handle (generic function)
(setf input-handle) (generic function)
:size
size (generic function)
(setf size) (generic function)
0
pos (generic function)
(setf pos) (generic function)
Previous: Definitions, Up: Top [Contents][Index]
• Concept index | ||
• Function index | ||
• Variable index | ||
• Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
Jump to: | F L Z |
---|
Jump to: | F L Z |
---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
Jump to: | %
(
B C D E F G I M N O P R S U W Z |
---|
Jump to: | %
(
B C D E F G I M N O P R S U W Z |
---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Jump to: | *
+
B C D E F G H I L M N O P S T Z |
---|
Jump to: | *
+
B C D E F G H I L M N O P S T Z |
---|
Previous: Variable index, Up: Indexes [Contents][Index]
Jump to: | B C P S T Z |
---|
Jump to: | B C P S T Z |
---|