The com.gigamonkeys.binary-data Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The com.gigamonkeys.binary-data Reference Manual

This is the com.gigamonkeys.binary-data Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 05:24:42 2022 GMT+0.

Table of Contents


1 Systems

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


Previous: , Up: Systems   [Contents][Index]

1.1 com.gigamonkeys.binary-data

Library for reading and writing binary data.

Author

Peter Seibel <peter@gigamonkeys.com>

Dependency

alexandria (system).

Source

com.gigamonkeys.binary-data.asd.

Child Components

2 Files

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


Previous: , Up: Files   [Contents][Index]

2.1 Lisp


2.1.1 com.gigamonkeys.binary-data/com.gigamonkeys.binary-data.asd

Source

com.gigamonkeys.binary-data.asd.

Parent Component

com.gigamonkeys.binary-data (system).

ASDF Systems

com.gigamonkeys.binary-data.


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

Dependency

packages.lisp (file).

Source

com.gigamonkeys.binary-data.asd.

Parent Component

com.gigamonkeys.binary-data (system).

Public Interface
Internals

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

Dependencies
Source

com.gigamonkeys.binary-data.asd.

Parent Component

com.gigamonkeys.binary-data (system).

Public Interface
Internals

swap-bytes (function).


3 Packages

Packages are listed by definition order.


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

Source

packages.lisp.

Use List
Public Interface

ucs-2-char-type (function).

Internals

swap-bytes (function).


3.2 com.gigamonkeys.binary-data

Source

packages.lisp.

Nickname

binary-data

Use List
  • alexandria.
  • common-lisp.
Used By List

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

Public Interface
Internals

4 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

4.1 Public Interface


4.1.1 Constants

Constant: +null+
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.


Next: , Previous: , Up: Public Interface   [Contents][Index]

4.1.2 Special variables

Special Variable: *in-progress-objects*
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.


4.1.3 Macros

Macro: define-binary-class (name (&rest superclasses) slots)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

Macro: define-binary-type (name (&rest args) &body spec)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

Macro: define-enumeration (name (type) &rest mapping)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

Macro: define-tagged-binary-class (name (&rest superclasses) slots &rest options)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.


4.1.4 Ordinary functions

Function: current-binary-object ()
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

Function: immediate-parent ()
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

Function: parent-of-type (type)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

Function: ucs-2-char-type (byte-order-mark)
Package

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

Source

common-datatypes.lisp.


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.

Methods
Method: read-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:ucs-2-terminated-string)) stream1 &key terminator)
Source

common-datatypes.lisp.

Method: read-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:ucs-2-string)) stream1 &key length)
Source

common-datatypes.lisp.

Method: read-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:ucs-2-char-little-endian)) stream1 &key)
Source

common-datatypes.lisp.

Method: read-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:ucs-2-char-big-endian)) stream1 &key)
Source

common-datatypes.lisp.

Method: read-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:ucs-2-char)) stream1 &key swap)
Source

common-datatypes.lisp.

Method: read-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:iso-8859-1-terminated-string)) stream1 &key terminator)
Source

common-datatypes.lisp.

Method: read-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:iso-8859-1-string)) stream1 &key length)
Source

common-datatypes.lisp.

Method: read-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:iso-8859-1-char)) stream1 &key)
Source

common-datatypes.lisp.

Method: read-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:generic-terminated-string)) stream1 &key terminator character-type)
Source

common-datatypes.lisp.

Method: read-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:generic-string)) stream1 &key length character-type)
Source

common-datatypes.lisp.

Method: read-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:u4)) stream1 &key)
Source

common-datatypes.lisp.

Method: read-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:u3)) stream1 &key)
Source

common-datatypes.lisp.

Method: read-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:u2)) stream1 &key)
Source

common-datatypes.lisp.

Method: read-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:u1)) stream1 &key)
Source

common-datatypes.lisp.

Method: read-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:unsigned-integer)) stream1 &key bytes bits-per-byte)
Source

common-datatypes.lisp.

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.

Methods
Method: write-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:ucs-2-terminated-string)) stream1 value2 &key terminator)
Source

common-datatypes.lisp.

Method: write-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:ucs-2-string)) stream1 value2 &key length)
Source

common-datatypes.lisp.

Method: write-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:ucs-2-char-little-endian)) stream1 value2 &key)
Source

common-datatypes.lisp.

Method: write-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:ucs-2-char-big-endian)) stream1 value2 &key)
Source

common-datatypes.lisp.

Method: write-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:ucs-2-char)) stream1 value2 &key swap)
Source

common-datatypes.lisp.

Method: write-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:iso-8859-1-terminated-string)) stream1 value2 &key terminator)
Source

common-datatypes.lisp.

Method: write-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:iso-8859-1-string)) stream1 value2 &key length)
Source

common-datatypes.lisp.

Method: write-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:iso-8859-1-char)) stream1 value2 &key)
Source

common-datatypes.lisp.

Method: write-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:generic-terminated-string)) stream1 value2 &key terminator character-type)
Source

common-datatypes.lisp.

Method: write-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:generic-string)) stream1 value2 &key length character-type)
Source

common-datatypes.lisp.

Method: write-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:u4)) stream1 value2 &key)
Source

common-datatypes.lisp.

Method: write-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:u3)) stream1 value2 &key)
Source

common-datatypes.lisp.

Method: write-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:u2)) stream1 value2 &key)
Source

common-datatypes.lisp.

Method: write-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:u1)) stream1 value2 &key)
Source

common-datatypes.lisp.

Method: write-value ((type0 (eql com.gigamonkeys.binary-data.common-datatypes:unsigned-integer)) stream1 value2 &key bytes bits-per-byte)
Source

common-datatypes.lisp.

Method: write-value ((type symbol) stream value &key)

4.2 Internals


Next: , Previous: , Up: Internals   [Contents][Index]

4.2.1 Macros

Macro: define-generic-binary-class (name (&rest superclasses) slots read-method)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.


Next: , Previous: , Up: Internals   [Contents][Index]

4.2.2 Ordinary functions

Function: all-slots (name)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

Function: as-keyword (sym)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

Function: direct-slots (name)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

Function: inherited-slots (name)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

Function: mklist (x)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

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.

Function: normalize-mapping (mapping)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

Function: normalize-slot-spec (spec)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

Function: slot->binding (spec stream)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

Function: slot->defclass-slot (spec)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

Function: slot->keyword-arg (spec)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

Function: slot->read-value (spec stream)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

Function: slot->write-value (spec stream)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

Function: swap-bytes (code)
Package

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

Source

common-datatypes.lisp.

Function: type-reader-body (spec stream)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

Function: type-writer-body (spec stream value)
Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.


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.

Method Combination

progn.

Options

:most-specific-last

Methods
Method: read-object :around (object stream)
Generic Function: write-object (object stream)

Write out the slots of object to the stream.

Package

com.gigamonkeys.binary-data.

Source

binary-data.lisp.

Method Combination

progn.

Options

:most-specific-last

Methods
Method: write-object :around (object stream)

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   C   D   F   G   I   M   N   P   R   S   T   U   W  
Index Entry  Section

A
all-slots: Private ordinary functions
as-keyword: Private ordinary functions

C
current-binary-object: Public ordinary functions

D
define-binary-class: Public macros
define-binary-type: Public macros
define-enumeration: Public macros
define-generic-binary-class: Private macros
define-tagged-binary-class: Public macros
direct-slots: Private ordinary functions

F
Function, all-slots: Private ordinary functions
Function, as-keyword: Private ordinary functions
Function, current-binary-object: Public ordinary functions
Function, direct-slots: Private ordinary functions
Function, immediate-parent: Public ordinary functions
Function, inherited-slots: Private ordinary functions
Function, mklist: Private ordinary functions
Function, new-class-all-slots: Private ordinary functions
Function, normalize-mapping: Private ordinary functions
Function, normalize-slot-spec: Private ordinary functions
Function, parent-of-type: Public ordinary functions
Function, slot->binding: Private ordinary functions
Function, slot->defclass-slot: Private ordinary functions
Function, slot->keyword-arg: Private ordinary functions
Function, slot->read-value: Private ordinary functions
Function, slot->write-value: Private ordinary functions
Function, swap-bytes: Private ordinary functions
Function, type-reader-body: Private ordinary functions
Function, type-writer-body: Private ordinary functions
Function, ucs-2-char-type: Public ordinary functions

G
Generic Function, read-object: Private generic functions
Generic Function, read-value: Public generic functions
Generic Function, write-object: Private generic functions
Generic Function, write-value: Public generic functions

I
immediate-parent: Public ordinary functions
inherited-slots: Private ordinary functions

M
Macro, define-binary-class: Public macros
Macro, define-binary-type: Public macros
Macro, define-enumeration: Public macros
Macro, define-generic-binary-class: Private macros
Macro, define-tagged-binary-class: Public macros
Method, read-object: Private generic functions
Method, read-value: Public generic functions
Method, read-value: Public generic functions
Method, read-value: Public generic functions
Method, read-value: Public generic functions
Method, read-value: Public generic functions
Method, read-value: Public generic functions
Method, read-value: Public generic functions
Method, read-value: Public generic functions
Method, read-value: Public generic functions
Method, read-value: Public generic functions
Method, read-value: Public generic functions
Method, read-value: Public generic functions
Method, read-value: Public generic functions
Method, read-value: Public generic functions
Method, read-value: Public generic functions
Method, read-value: Public generic functions
Method, write-object: Private generic functions
Method, write-value: Public generic functions
Method, write-value: Public generic functions
Method, write-value: Public generic functions
Method, write-value: Public generic functions
Method, write-value: Public generic functions
Method, write-value: Public generic functions
Method, write-value: Public generic functions
Method, write-value: Public generic functions
Method, write-value: Public generic functions
Method, write-value: Public generic functions
Method, write-value: Public generic functions
Method, write-value: Public generic functions
Method, write-value: Public generic functions
Method, write-value: Public generic functions
Method, write-value: Public generic functions
Method, write-value: Public generic functions
mklist: Private ordinary functions

N
new-class-all-slots: Private ordinary functions
normalize-mapping: Private ordinary functions
normalize-slot-spec: Private ordinary functions

P
parent-of-type: Public ordinary functions

R
read-object: Private generic functions
read-object: Private generic functions
read-value: Public generic functions
read-value: Public generic functions
read-value: Public generic functions
read-value: Public generic functions
read-value: Public generic functions
read-value: Public generic functions
read-value: Public generic functions
read-value: Public generic functions
read-value: Public generic functions
read-value: Public generic functions
read-value: Public generic functions
read-value: Public generic functions
read-value: Public generic functions
read-value: Public generic functions
read-value: Public generic functions
read-value: Public generic functions
read-value: Public generic functions

S
slot->binding: Private ordinary functions
slot->defclass-slot: Private ordinary functions
slot->keyword-arg: Private ordinary functions
slot->read-value: Private ordinary functions
slot->write-value: Private ordinary functions
swap-bytes: Private ordinary functions

T
type-reader-body: Private ordinary functions
type-writer-body: Private ordinary functions

U
ucs-2-char-type: Public ordinary functions

W
write-object: Private generic functions
write-object: Private generic functions
write-value: Public generic functions
write-value: Public generic functions
write-value: Public generic functions
write-value: Public generic functions
write-value: Public generic functions
write-value: Public generic functions
write-value: Public generic functions
write-value: Public generic functions
write-value: Public generic functions
write-value: Public generic functions
write-value: Public generic functions
write-value: Public generic functions
write-value: Public generic functions
write-value: Public generic functions
write-value: Public generic functions
write-value: Public generic functions
write-value: Public generic functions

Jump to:   A   C   D   F   G   I   M   N   P   R   S   T   U   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +  
C   S  
Index Entry  Section

*
*in-progress-objects*: Public special variables

+
+null+: Public constants

C
Constant, +null+: Public constants

S
Special Variable, *in-progress-objects*: Public special variables

Jump to:   *   +  
C   S