The monkeylib-binary-data Reference Manual

Table of Contents

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

The monkeylib-binary-data Reference Manual

This is the monkeylib-binary-data Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:19:53 2018 GMT+0.


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

1 Systems

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


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

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

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

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


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.1 com.gigamonkeys.binary-data.asd

Location

com.gigamonkeys.binary-data.asd

Systems

com.gigamonkeys.binary-data (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Parent

com.gigamonkeys.binary-data (system)

Location

packages.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

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
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

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

Dependencies
Parent

com.gigamonkeys.binary-data (system)

Location

common-datatypes.lisp

Exported Definitions
Internal Definitions

swap-bytes (function)


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

3 Packages

Packages are listed by definition order.


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

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

Source

packages.lisp (file)

Use List
Exported Definitions

ucs-2-char-type (function)

Internal Definitions

swap-bytes (function)


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

3.2 com.gigamonkeys.binary-data

Source

packages.lisp (file)

Nickname

binary-data

Use List
Used By List

com.gigamonkeys.binary-data.common-datatypes

Exported Definitions
Internal Definitions

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

4 Definitions

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


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

4.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.1 Constants

Constant: +null+
Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.2 Special variables

Special Variable: *in-progress-objects*
Package

com.gigamonkeys.binary-data

Source

binary-data.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Exported definitions   [Contents][Index]

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

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

4.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [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 (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Internal definitions   [Contents][Index]

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

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
com.gigamonkeys.binary-data.asd: The com<dot>gigamonkeys<dot>binary-data<dot>asd file
com.gigamonkeys.binary-data/binary-data.lisp: The com<dot>gigamonkeys<dot>binary-data/binary-data<dot>lisp file
com.gigamonkeys.binary-data/common-datatypes.lisp: The com<dot>gigamonkeys<dot>binary-data/common-datatypes<dot>lisp file
com.gigamonkeys.binary-data/packages.lisp: The com<dot>gigamonkeys<dot>binary-data/packages<dot>lisp file

F
File, Lisp, com.gigamonkeys.binary-data.asd: The com<dot>gigamonkeys<dot>binary-data<dot>asd file
File, Lisp, com.gigamonkeys.binary-data/binary-data.lisp: The com<dot>gigamonkeys<dot>binary-data/binary-data<dot>lisp file
File, Lisp, com.gigamonkeys.binary-data/common-datatypes.lisp: The com<dot>gigamonkeys<dot>binary-data/common-datatypes<dot>lisp file
File, Lisp, com.gigamonkeys.binary-data/packages.lisp: The com<dot>gigamonkeys<dot>binary-data/packages<dot>lisp file

L
Lisp File, com.gigamonkeys.binary-data.asd: The com<dot>gigamonkeys<dot>binary-data<dot>asd file
Lisp File, com.gigamonkeys.binary-data/binary-data.lisp: The com<dot>gigamonkeys<dot>binary-data/binary-data<dot>lisp file
Lisp File, com.gigamonkeys.binary-data/common-datatypes.lisp: The com<dot>gigamonkeys<dot>binary-data/common-datatypes<dot>lisp file
Lisp File, com.gigamonkeys.binary-data/packages.lisp: The com<dot>gigamonkeys<dot>binary-data/packages<dot>lisp file

Jump to:   C   F   L  

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: Internal functions
as-keyword: Internal functions

C
current-binary-object: Exported functions

D
define-binary-class: Exported macros
define-binary-type: Exported macros
define-enumeration: Exported macros
define-generic-binary-class: Internal macros
define-tagged-binary-class: Exported macros
direct-slots: Internal functions

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

G
Generic Function, read-object: Internal generic functions
Generic Function, read-value: Exported generic functions
Generic Function, write-object: Internal generic functions
Generic Function, write-value: Exported generic functions

I
immediate-parent: Exported functions
inherited-slots: Internal functions

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

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

P
parent-of-type: Exported functions

R
read-object: Internal generic functions
read-object: Internal generic functions
read-value: Exported generic functions
read-value: Exported generic functions
read-value: Exported generic functions
read-value: Exported generic functions
read-value: Exported generic functions
read-value: Exported generic functions
read-value: Exported generic functions
read-value: Exported generic functions
read-value: Exported generic functions
read-value: Exported generic functions
read-value: Exported generic functions
read-value: Exported generic functions
read-value: Exported generic functions
read-value: Exported generic functions
read-value: Exported generic functions
read-value: Exported generic functions
read-value: Exported generic functions

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

T
type-reader-body: Internal functions
type-writer-body: Internal functions

U
ucs-2-char-type: Exported functions

W
write-object: Internal generic functions
write-object: Internal generic functions
write-value: Exported generic functions
write-value: Exported generic functions
write-value: Exported generic functions
write-value: Exported generic functions
write-value: Exported generic functions
write-value: Exported generic functions
write-value: Exported generic functions
write-value: Exported generic functions
write-value: Exported generic functions
write-value: Exported generic functions
write-value: Exported generic functions
write-value: Exported generic functions
write-value: Exported generic functions
write-value: Exported generic functions
write-value: Exported generic functions
write-value: Exported generic functions
write-value: Exported 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*: Exported special variables

+
+null+: Exported constants

C
Constant, +null+: Exported constants

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

Jump to:   *   +  
C   S  

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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
com.gigamonkeys.binary-data: The com<dot>gigamonkeys<dot>binary-data system
com.gigamonkeys.binary-data: The com<dot>gigamonkeys<dot>binary-data package
com.gigamonkeys.binary-data.common-datatypes: The com<dot>gigamonkeys<dot>binary-data<dot>common-datatypes package

P
Package, com.gigamonkeys.binary-data: The com<dot>gigamonkeys<dot>binary-data package
Package, com.gigamonkeys.binary-data.common-datatypes: The com<dot>gigamonkeys<dot>binary-data<dot>common-datatypes package

S
System, com.gigamonkeys.binary-data: The com<dot>gigamonkeys<dot>binary-data system

Jump to:   C   P   S