The com.gigamonkeys.binary-data Reference Manual

Table of Contents

The com.gigamonkeys.binary-data Reference Manual

This is the com.gigamonkeys.binary-data Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:17:53 2018 GMT+0.

1 Systems

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

1.1 com.gigamonkeys.binary-data

Author

Peter Seibel <peter@gigamonkeys.com>

Description

Library for reading and writing binary data.

Dependency

alexandria

Source

com.gigamonkeys.binary-data.asd (file)

Components

• packages.lisp (file)
• binary-data.lisp (file)
• common-datatypes.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 com.gigamonkeys.binary-data.asd

Location

com.gigamonkeys.binary-data.asd

Systems

com.gigamonkeys.binary-data (system)

2.1.2 com.gigamonkeys.binary-data/packages.lisp

Parent

com.gigamonkeys.binary-data (system)

Location

packages.lisp

Packages

• com.gigamonkeys.binary-data.common-datatypes
• com.gigamonkeys.binary-data

2.1.3 com.gigamonkeys.binary-data/binary-data.lisp

Dependency

packages.lisp (file)

Parent

com.gigamonkeys.binary-data (system)

Location

binary-data.lisp

Exported Definitions

• *in-progress-objects* (special variable)
• +null+ (constant)
• current-binary-object (function)
• define-binary-class (macro)
• define-binary-type (macro)
• define-enumeration (macro)
• define-tagged-binary-class (macro)
• immediate-parent (function)
• parent-of-type (function)
• read-value (generic function)
• read-value (method)
• write-value (generic function)
• write-value (method)

Internal Definitions

• all-slots (function)
• as-keyword (function)
• define-generic-binary-class (macro)
• direct-slots (function)
• inherited-slots (function)
• mklist (function)
• new-class-all-slots (function)
• normalize-mapping (function)
• normalize-slot-spec (function)
• read-object (generic function)
• read-object (method)
• slot->binding (function)
• slot->defclass-slot (function)
• slot->keyword-arg (function)
• slot->read-value (function)
• slot->write-value (function)
• type-reader-body (function)
• type-writer-body (function)
• write-object (generic function)
• write-object (method)

2.1.4 com.gigamonkeys.binary-data/common-datatypes.lisp

Dependencies

• packages.lisp (file)
• binary-data.lisp (file)

Parent

com.gigamonkeys.binary-data (system)

Location

common-datatypes.lisp

Exported Definitions

• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• ucs-2-char-type (function)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)

Internal Definitions

swap-bytes (function)

3 Packages

Packages are listed by definition order.

3.1 com.gigamonkeys.binary-data.common-datatypes

Source

packages.lisp (file)

Use List

• com.gigamonkeys.binary-data
• common-lisp

Exported Definitions

ucs-2-char-type (function)

Internal Definitions

swap-bytes (function)

3.2 com.gigamonkeys.binary-data

Source

packages.lisp (file)

Nickname

binary-data

Use List

• alexandria.0.dev
• common-lisp

Used By List

com.gigamonkeys.binary-data.common-datatypes

Exported Definitions

• *in-progress-objects* (special variable)
• +null+ (constant)
• current-binary-object (function)
• define-binary-class (macro)
• define-binary-type (macro)
• define-enumeration (macro)
• define-tagged-binary-class (macro)
• immediate-parent (function)
• parent-of-type (function)
• read-value (generic function)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• read-value (method)
• write-value (generic function)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)
• write-value (method)

Internal Definitions

• all-slots (function)
• as-keyword (function)
• define-generic-binary-class (macro)
• direct-slots (function)
• inherited-slots (function)
• mklist (function)
• new-class-all-slots (function)
• normalize-mapping (function)
• normalize-slot-spec (function)
• read-object (generic function)
• read-object (method)
• slot->binding (function)
• slot->defclass-slot (function)
• slot->keyword-arg (function)
• slot->read-value (function)
• slot->write-value (function)
• type-reader-body (function)
• type-writer-body (function)
• write-object (generic function)
• write-object (method)

4 Definitions

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

4.1 Exported definitions

4.1.1 Constants

Constant: +null+

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

4.1.2 Special variables

Special Variable: *in-progress-objects*

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

4.1.3 Macros

Macro: define-binary-class NAME (&rest SUPERCLASSES) SLOTS

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Macro: define-binary-type NAME (&rest ARGS) &body SPEC

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Macro: define-enumeration NAME (TYPE) &rest MAPPING

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Macro: define-tagged-binary-class NAME (&rest SUPERCLASSES) SLOTS &rest OPTIONS

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

4.1.4 Functions

Function: current-binary-object ()

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Function: immediate-parent ()

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Function: parent-of-type TYPE

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Function: ucs-2-char-type BYTE-ORDER-MARK

Package

com.gigamonkeys.binary-data.common-datatypes

Source

common-datatypes.lisp (file)

4.1.5 Generic functions

Generic Function: read-value TYPE STREAM &key TERMINATOR LENGTH SWAP CHARACTER-TYPE BYTES BITS-PER-BYTE

Read a value of the given type from the stream.

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Methods

Method: read-value (TYPE0 (eql ucs-2-terminated-string)) STREAM1 &key TERMINATOR

Source

common-datatypes.lisp (file)

Method: read-value (TYPE0 (eql ucs-2-string)) STREAM1 &key LENGTH

Source

common-datatypes.lisp (file)

Method: read-value (TYPE0 (eql ucs-2-char-little-endian)) STREAM1 &key

Source

common-datatypes.lisp (file)

Method: read-value (TYPE0 (eql ucs-2-char-big-endian)) STREAM1 &key

Source

common-datatypes.lisp (file)

Method: read-value (TYPE0 (eql ucs-2-char)) STREAM1 &key SWAP

Source

common-datatypes.lisp (file)

Method: read-value (TYPE0 (eql iso-8859-1-terminated-string)) STREAM1 &key TERMINATOR

Source

common-datatypes.lisp (file)

Method: read-value (TYPE0 (eql iso-8859-1-string)) STREAM1 &key LENGTH

Source

common-datatypes.lisp (file)

Method: read-value (TYPE0 (eql iso-8859-1-char)) STREAM1 &key

Source

common-datatypes.lisp (file)

Method: read-value (TYPE0 (eql generic-terminated-string)) STREAM1 &key TERMINATOR CHARACTER-TYPE

Source

common-datatypes.lisp (file)

Method: read-value (TYPE0 (eql generic-string)) STREAM1 &key LENGTH CHARACTER-TYPE

Source

common-datatypes.lisp (file)

Method: read-value (TYPE0 (eql u4)) STREAM1 &key

Source

common-datatypes.lisp (file)

Method: read-value (TYPE0 (eql u3)) STREAM1 &key

Source

common-datatypes.lisp (file)

Method: read-value (TYPE0 (eql u2)) STREAM1 &key

Source

common-datatypes.lisp (file)

Method: read-value (TYPE0 (eql u1)) STREAM1 &key

Source

common-datatypes.lisp (file)

Method: read-value (TYPE0 (eql unsigned-integer)) STREAM1 &key BYTES BITS-PER-BYTE

Source

common-datatypes.lisp (file)

Method: read-value (TYPE symbol) STREAM &key

Generic Function: write-value TYPE STREAM VALUE &key TERMINATOR LENGTH SWAP CHARACTER-TYPE BYTES BITS-PER-BYTE

Write a value as the given type to the stream.

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Methods

Method: write-value (TYPE0 (eql ucs-2-terminated-string)) STREAM1 VALUE2 &key TERMINATOR

Source

common-datatypes.lisp (file)

Method: write-value (TYPE0 (eql ucs-2-string)) STREAM1 VALUE2 &key LENGTH

Source

common-datatypes.lisp (file)

Method: write-value (TYPE0 (eql ucs-2-char-little-endian)) STREAM1 VALUE2 &key

Source

common-datatypes.lisp (file)

Method: write-value (TYPE0 (eql ucs-2-char-big-endian)) STREAM1 VALUE2 &key

Source

common-datatypes.lisp (file)

Method: write-value (TYPE0 (eql ucs-2-char)) STREAM1 VALUE2 &key SWAP

Source

common-datatypes.lisp (file)

Method: write-value (TYPE0 (eql iso-8859-1-terminated-string)) STREAM1 VALUE2 &key TERMINATOR

Source

common-datatypes.lisp (file)

Method: write-value (TYPE0 (eql iso-8859-1-string)) STREAM1 VALUE2 &key LENGTH

Source

common-datatypes.lisp (file)

Method: write-value (TYPE0 (eql iso-8859-1-char)) STREAM1 VALUE2 &key

Source

common-datatypes.lisp (file)

Method: write-value (TYPE0 (eql generic-terminated-string)) STREAM1 VALUE2 &key TERMINATOR CHARACTER-TYPE

Source

common-datatypes.lisp (file)

Method: write-value (TYPE0 (eql generic-string)) STREAM1 VALUE2 &key LENGTH CHARACTER-TYPE

Source

common-datatypes.lisp (file)

Method: write-value (TYPE0 (eql u4)) STREAM1 VALUE2 &key

Source

common-datatypes.lisp (file)

Method: write-value (TYPE0 (eql u3)) STREAM1 VALUE2 &key

Source

common-datatypes.lisp (file)

Method: write-value (TYPE0 (eql u2)) STREAM1 VALUE2 &key

Source

common-datatypes.lisp (file)

Method: write-value (TYPE0 (eql u1)) STREAM1 VALUE2 &key

Source

common-datatypes.lisp (file)

Method: write-value (TYPE0 (eql unsigned-integer)) STREAM1 VALUE2 &key BYTES BITS-PER-BYTE

Source

common-datatypes.lisp (file)

Method: write-value (TYPE symbol) STREAM VALUE &key

4.2 Internal definitions

4.2.1 Macros

Macro: define-generic-binary-class NAME (&rest SUPERCLASSES) SLOTS READ-METHOD

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

4.2.2 Functions

Function: all-slots NAME

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Function: as-keyword SYM

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Function: direct-slots NAME

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Function: inherited-slots NAME

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Function: mklist X

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Function: new-class-all-slots SLOTS SUPERCLASSES

Like all slots but works while compiling a new class before slots and superclasses have been saved.

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Function: normalize-mapping MAPPING

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Function: normalize-slot-spec SPEC

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Function: slot->binding SPEC STREAM

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Function: slot->defclass-slot SPEC

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Function: slot->keyword-arg SPEC

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Function: slot->read-value SPEC STREAM

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Function: slot->write-value SPEC STREAM

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Function: swap-bytes CODE

Package

com.gigamonkeys.binary-data.common-datatypes

Source

common-datatypes.lisp (file)

Function: type-reader-body SPEC STREAM

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Function: type-writer-body SPEC STREAM VALUE

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

4.2.3 Generic functions

Generic Function: read-object OBJECT STREAM

Fill in the slots of object from stream.

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Method Combination

progn (short method combination)

Options: :most-specific-last

Methods

Method: read-object OBJECT STREAM around

Generic Function: write-object OBJECT STREAM

Write out the slots of object to the stream.

Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)

Method Combination

progn (short method combination)

Options: :most-specific-last

Methods

Method: write-object OBJECT STREAM around

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types