The pack Reference Manual

Table of Contents

The pack Reference Manual

This is the pack Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 17:17:52 2021 GMT+0.

1 Introduction

Python struct hack in Common Lisp written by Death (see https://gist.github.com/266945)

Modified to use ieee-floats instead of sb-kernel to increase compatibility.
Tested on SBCL linux, windows and CLISP windows.


pack spec &rest args => array

Packs arguments according to spec as an octet buffer (simple array
with 8-bit unsigned bytes).

The spec string should be formatted as given in
http://docs.python.org/library/struct.html#byte-order-size-and-alignment


pack-into spec stream &rest args => stream

Packs arguments according to spec into stream, which should obey the
stream struct protocol, i.e. a specialized method
struct-stream-protocol should exist for the stream. See below.


unpack spec stream => list

Unpacks bytes from stream according to spec and returns them in a list.


calc-size spec => size

Calculates and returns the size (in octets) that the spec specifies.


struct-stream-protocol stream => reader writer

A method for the stream object returning reader and writer
functions. For an arbitrary object, these should be closures over that
object. The reader function should return the current octet in the
object and increment its position by one. It takes no arguments. The
writer function should write the given octet to the object and
increment its position by one.

See this example from the pack.lisp source, which ensures vectors can
be used as streams for the pack-into and unpack functions:

(defmethod struct-stream-protocol ((vector vector))
  (values
   (let ((i 0))
     (lambda ()
       (prog1 (aref vector i)
         (incf i))))
   (let ((i 0))
     (lambda (octet)
       (setf (aref vector i) octet)
       (incf i)))))

2 Systems

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

2.1 pack

Author

Death

License

Public Domain

Description

Pack and unpack binary data via Python-like struct strings.

Dependencies

• alexandria
• ieee-floats

Source

pack.asd (file)

Components

• package.lisp (file)
• pack.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 pack.asd

Location

pack.asd

Systems

pack (system)

3.1.2 pack/package.lisp

Parent

pack (system)

Location

package.lisp

Packages

pack

3.1.3 pack/pack.lisp

Dependency

package.lisp (file)

Parent

pack (system)

Location

pack.lisp

Exported Definitions

• calc-size (compiler macro)
• calc-size (function)
• compile-struct-string (function)
• pack (compiler macro)
• pack (function)
• pack* (function)
• pack-into (compiler macro)
• pack-into (function)
• struct-stream-protocol (generic function)
• struct-stream-protocol (method)
• struct-stream-protocol (method)
• unpack (compiler macro)
• unpack (function)
• unpack* (function)

Internal Definitions

• *offset* (special variable)
• *pack-args* (special variable)
• *reader* (special variable)
• *writer* (special variable)
• bool-to-byte (function)
• byte-to-bool (function)
• byte-to-char (function)
• char-to-byte (function)
• divisible-by-p (function)
• offset (function)
• (setf offset) (function)
• pack-arg (function)
• read-double-be (function)
• read-double-le (function)
• read-fixlen-string (function)
• read-float-be (function)
• read-float-le (function)
• read-octet (function)
• read-pad (function)
• read-pascal-string (function)
• read-signed-be (macro)
• read-signed-le (macro)
• read-unsigned-be (macro)
• read-unsigned-le (macro)
• signed-to-unsigned (function)
• unsigned-to-signed (function)
• write-double-be (function)
• write-double-le (function)
• write-fixlen-string (function)
• write-float-be (function)
• write-float-le (function)
• write-octet (function)
• write-pad (function)
• write-pascal-string (function)
• write-signed-be (macro)
• write-signed-le (macro)
• write-unsigned-be (macro)
• write-unsigned-le (macro)

4 Packages

Packages are listed by definition order.

4.1 pack

Source

package.lisp (file)

Use List

• ieee-floats
• alexandria
• common-lisp

Exported Definitions

• calc-size (compiler macro)
• calc-size (function)
• compile-struct-string (function)
• pack (compiler macro)
• pack (function)
• pack* (function)
• pack-into (compiler macro)
• pack-into (function)
• struct-stream-protocol (generic function)
• struct-stream-protocol (method)
• struct-stream-protocol (method)
• unpack (compiler macro)
• unpack (function)
• unpack* (function)

Internal Definitions

• *offset* (special variable)
• *pack-args* (special variable)
• *reader* (special variable)
• *writer* (special variable)
• bool-to-byte (function)
• byte-to-bool (function)
• byte-to-char (function)
• char-to-byte (function)
• divisible-by-p (function)
• offset (function)
• (setf offset) (function)
• pack-arg (function)
• read-double-be (function)
• read-double-le (function)
• read-fixlen-string (function)
• read-float-be (function)
• read-float-le (function)
• read-octet (function)
• read-pad (function)
• read-pascal-string (function)
• read-signed-be (macro)
• read-signed-le (macro)
• read-unsigned-be (macro)
• read-unsigned-le (macro)
• signed-to-unsigned (function)
• unsigned-to-signed (function)
• write-double-be (function)
• write-double-le (function)
• write-fixlen-string (function)
• write-float-be (function)
• write-float-le (function)
• write-octet (function)
• write-pad (function)
• write-pascal-string (function)
• write-signed-be (macro)
• write-signed-le (macro)
• write-unsigned-be (macro)
• write-unsigned-le (macro)

5 Definitions

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

5.1 Exported definitions

5.1.1 Compiler macros

Compiler Macro: calc-size STRING

Package

pack

Source

pack.lisp (file)

Compiler Macro: pack STRING &rest ARGS

Package

pack

Source

pack.lisp (file)

Compiler Macro: pack-into STRING STREAM &rest ARGS

Package

pack

Source

pack.lisp (file)

Compiler Macro: unpack STRING STREAM

Package

pack

Source

pack.lisp (file)

5.1.2 Functions

Function: calc-size STRING

Package

pack

Source

pack.lisp (file)

Function: compile-struct-string STRING

Package

pack

Source

pack.lisp (file)

Function: pack STRING &rest ARGS

Package

pack

Source

pack.lisp (file)

Function: pack* COMPILED STREAM &rest ARGS

Package

pack

Source

pack.lisp (file)

Function: pack-into STRING STREAM &rest ARGS

Package

pack

Source

pack.lisp (file)

Function: unpack STRING STREAM

Package

pack

Source

pack.lisp (file)

Function: unpack* COMPILED STREAM

Package

pack

Source

pack.lisp (file)

5.1.3 Generic functions

Generic Function: struct-stream-protocol STREAM

Package

pack

Source

pack.lisp (file)

Methods

Method: struct-stream-protocol (VECTOR vector)

Method: struct-stream-protocol (STREAM stream)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *offset*

Package

pack

Source

pack.lisp (file)

Special Variable: *pack-args*

Package

pack

Source

pack.lisp (file)

Special Variable: *reader*

Package

pack

Source

pack.lisp (file)

Special Variable: *writer*

Package

pack

Source

pack.lisp (file)

5.2.2 Macros

Macro: read-signed-be SIZE

Package

pack

Source

pack.lisp (file)

Macro: read-signed-le SIZE

Package

pack

Source

pack.lisp (file)

Macro: read-unsigned-be SIZE

Package

pack

Source

pack.lisp (file)

Macro: read-unsigned-le SIZE

Package

pack

Source

pack.lisp (file)

Macro: write-signed-be VALUE SIZE

Package

pack

Source

pack.lisp (file)

Macro: write-signed-le VALUE SIZE

Package

pack

Source

pack.lisp (file)

Macro: write-unsigned-be VALUE SIZE

Package

pack

Source

pack.lisp (file)

Macro: write-unsigned-le VALUE SIZE

Package

pack

Source

pack.lisp (file)

5.2.3 Functions

Function: bool-to-byte BOOL

Package

pack

Source

pack.lisp (file)

Function: byte-to-bool BYTE

Package

pack

Source

pack.lisp (file)

Function: byte-to-char CHAR-OR-BYTE

Package

pack

Source

pack.lisp (file)

Function: char-to-byte CHAR-OR-BYTE

Package

pack

Source

pack.lisp (file)

Function: divisible-by-p N D

Package

pack

Source

pack.lisp (file)

Function: offset ()

Function: (setf offset) NEW-VALUE

Package

pack

Source

pack.lisp (file)

Function: pack-arg ()

Package

pack

Source

pack.lisp (file)

Function: read-double-be ()

Package

pack

Source

pack.lisp (file)

Function: read-double-le ()

Package

pack

Source

pack.lisp (file)

Function: read-fixlen-string SIZE

Package

pack

Source

pack.lisp (file)

Function: read-float-be ()

Package

pack

Source

pack.lisp (file)

Function: read-float-le ()

Package

pack

Source

pack.lisp (file)

Function: read-octet ()

Package

pack

Source

pack.lisp (file)

Function: read-pad SIZE

Package

pack

Source

pack.lisp (file)

Function: read-pascal-string SIZE

Package

pack

Source

pack.lisp (file)

Function: signed-to-unsigned VALUE SIZE

Package

pack

Source

pack.lisp (file)

Function: unsigned-to-signed VALUE SIZE

Package

pack

Source

pack.lisp (file)

Function: write-double-be VALUE

Package

pack

Source

pack.lisp (file)

Function: write-double-le VALUE

Package

pack

Source

pack.lisp (file)

Function: write-fixlen-string VALUE SIZE

Package

pack

Source

pack.lisp (file)

Function: write-float-be VALUE

Package

pack

Source

pack.lisp (file)

Function: write-float-le VALUE

Package

pack

Source

pack.lisp (file)

Function: write-octet OCTET

Package

pack

Source

pack.lisp (file)

Function: write-pad SIZE

Package

pack

Source

pack.lisp (file)

Function: write-pascal-string VALUE SIZE

Package

pack

Source

pack.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types