This is the binary-structures Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 04:24:14 2024 GMT+0.
binary-structures/binary-structures.asdbinary-structures/package.lispbinary-structures/toolkit.lispbinary-structures/protocol.lispbinary-structures/standard-types.lispbinary-structures/stream.lispbinary-structures/octet-vector.lispbinary-structures/foreign-pointer.lispbinary-structures/documentation.lispThe main system appears first, followed by any subsystem dependency.
binary-structuresA library for reading, writing, and representing structures from binary representations
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/shinmera/binary-structures.git)
zlib
1.0.0
cffi (system)., for feature (:not :mezzano)
babel (system).
nibbles (system).
form-fiddle (system).
trivial-extensible-sequences (system).
documentation-utils (system).
package.lisp (file).
toolkit.lisp (file).
protocol.lisp (file).
standard-types.lisp (file).
stream.lisp (file).
octet-vector.lisp (file).
foreign-pointer.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
binary-structures/binary-structures.asdbinary-structures/package.lispbinary-structures/toolkit.lispbinary-structures/protocol.lispbinary-structures/standard-types.lispbinary-structures/stream.lispbinary-structures/octet-vector.lispbinary-structures/foreign-pointer.lispbinary-structures/documentation.lispbinary-structures/binary-structures.asdbinary-structures (system).
binary-structures/toolkit.lisppackage.lisp (file).
binary-structures (system).
index (type).
unspecific-p (function).
define-print-object-method (macro).
define-typed-function (macro).
find-symbol* (function).
intern* (function).
reexport (function).
string-length (function).
truncate-text (function).
binary-structures/protocol.lisptoolkit.lisp (file).
binary-structures (system).
accepted (reader method).
binary-structures-condition (condition).
bounds-checked-io-backend (class).
call-read-form (generic function).
call-write-form (generic function).
cases (reader method).
cases (reader method).
(setf cases) (writer method).
(setf cases) (writer method).
constructor (reader method).
(setf constructor) (writer method).
default-value (generic function).
(setf default-value) (writer method).
(setf default-value) (method).
define-io-alias (macro).
define-io-backend (macro).
define-io-backend-function (macro).
define-io-dispatch (macro).
define-io-dispatch-function (macro).
define-io-functions (macro).
define-io-structure (macro).
define-io-type (macro).
define-io-type-parser (macro).
describe-object (method).
designator (reader method).
element-count (reader method).
element-count (reader method).
(setf element-count) (writer method).
(setf element-count) (writer method).
element-offset (reader method).
(setf element-offset) (writer method).
element-type (reader method).
(setf element-type) (writer method).
encoding (reader method).
(setf encoding) (writer method).
end (reader method).
end-of-storage (condition).
form (reader method).
(setf form) (writer method).
index (reader method).
index-form (generic function).
initargs (generic function).
io-backend (class).
io-case (class).
io-float (class).
io-integer (class).
io-string (class).
io-structure (class).
io-structure-magic (class).
io-structure-slot (class).
io-type (function).
(setf io-type) (function).
io-type (class).
io-typecase (class).
io-value (class).
io-vector (class).
lisp-type (generic function).
list-io-backends (function).
list-io-types (function).
name (reader method).
name (reader method).
name (reader method).
(setf name) (writer method).
(setf name) (writer method).
no-such-io-type (condition).
no-such-slot (condition).
null-terminated-p (reader method).
(setf null-terminated-p) (writer method).
numeric-type (class).
octet-size (generic function).
(setf octet-size) (writer method).
(setf octet-size) (writer method).
offset (reader method).
offset (reader method).
(setf offset) (writer method).
(setf offset) (writer method).
order (reader method).
(setf order) (writer method).
parse-io-type (generic function).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
read-defun (generic function).
read-form (generic function).
remove-io-dispatch (function).
seek-form (generic function).
shared-initialize (method).
signed-p (reader method).
(setf signed-p) (writer method).
slots (reader method).
(setf slots) (writer method).
stride (reader method).
(setf stride) (writer method).
struct (reader method).
top-type (class).
unknown-value (condition).
value (reader method).
value-type (reader method).
value-type (reader method).
value-type (reader method).
(setf value-type) (writer method).
(setf value-type) (writer method).
(setf value-type) (writer method).
write-defun (generic function).
write-form (generic function).
%slot-macrolet (function).
*io-backends* (special variable).
*io-dispatchers* (special variable).
*io-structure-inline* (special variable).
*io-types* (special variable).
copy-io-structure-object (function).
find-slot (method).
find-slot (method).
io-structure-object (structure).
io-structure-object-p (function).
make-io-structure-object (function).
octet-size-form (generic function).
parse-io-structure-slots (function).
size-form (reader method).
(setf size-form) (writer method).
binary-structures/standard-types.lispprotocol.lisp (file).
binary-structures (system).
define-io-types (macro).
binary-structures/stream.lispstandard-types.lisp (file).
binary-structures (system).
call-read-form (method).
call-write-form (method).
index-form (method).
io-stream (class).
read-defun (method).
read-form (method).
read-form (method).
read-form (method).
seek-form (method).
write-defun (method).
write-form (method).
write-form (method).
write-form (method).
binary-structures/octet-vector.lispstream.lisp (file).
binary-structures (system).
call-read-form (method).
call-write-form (method).
index-form (method).
io-octet-vector (class).
read-defun (method).
read-form (method).
read-form (method).
read-form (method).
seek-form (method).
write-defun (method).
write-form (method).
write-form (method).
write-form (method).
binary-structures/foreign-pointer.lisp:cffi
octet-vector.lisp (file).
binary-structures (system).
call-read-form (method).
call-write-form (method).
index-form (method).
io-foreign-pointer (class).
read-defun (method).
read-form (method).
read-form (method).
seek-form (method).
write-defun (method).
write-form (method).
write-form (method).
binary-structures/documentation.lispforeign-pointer.lisp (file).
octet-vector.lisp (file).
binary-structures (system).
Packages are listed by definition order.
org.shirakumo.binary-structurescommon-lisp.
accepted (generic reader).
binary-structures-condition (condition).
bounds-checked-io-backend (class).
call-read-form (generic function).
call-write-form (generic function).
cases (generic reader).
(setf cases) (generic writer).
constructor (generic reader).
(setf constructor) (generic writer).
default-value (generic function).
(setf default-value) (generic function).
define-io-alias (macro).
define-io-backend (macro).
define-io-backend-function (macro).
define-io-dispatch (macro).
define-io-dispatch-function (macro).
define-io-functions (macro).
define-io-structure (macro).
define-io-type (macro).
define-io-type-parser (macro).
define-io-types (macro).
designator (generic reader).
element-count (generic reader).
(setf element-count) (generic writer).
element-offset (generic reader).
(setf element-offset) (generic writer).
element-type (generic reader).
(setf element-type) (generic writer).
encoding (generic reader).
(setf encoding) (generic writer).
end (generic reader).
end-of-storage (condition).
form (generic reader).
(setf form) (generic writer).
index (generic reader).
index (type).
index-form (generic function).
initargs (generic function).
io-backend (class).
io-case (class).
io-float (class).
io-foreign-pointer (class).
io-integer (class).
io-octet-vector (class).
io-stream (class).
io-string (class).
io-structure (class).
io-structure-magic (class).
io-structure-slot (class).
io-type (function).
(setf io-type) (function).
io-type (class).
io-typecase (class).
io-value (class).
io-vector (class).
lisp-type (generic function).
list-io-backends (function).
list-io-types (function).
name (generic reader).
(setf name) (generic writer).
no-such-io-type (condition).
no-such-slot (condition).
null-terminated-p (generic reader).
(setf null-terminated-p) (generic writer).
numeric-type (class).
octet-size (generic function).
(setf octet-size) (generic writer).
offset (generic reader).
(setf offset) (generic writer).
order (generic reader).
(setf order) (generic writer).
parse-io-type (generic function).
read-defun (generic function).
read-form (generic function).
remove-io-dispatch (function).
seek-form (generic function).
signed-p (generic reader).
(setf signed-p) (generic writer).
slots (generic reader).
(setf slots) (generic writer).
stride (generic reader).
(setf stride) (generic writer).
struct (generic reader).
top-type (class).
unknown-value (condition).
unspecific-p (function).
value (generic reader).
value-type (generic reader).
(setf value-type) (generic writer).
write-defun (generic function).
write-form (generic function).
%slot-macrolet (function).
*io-backends* (special variable).
*io-dispatchers* (special variable).
*io-structure-inline* (special variable).
*io-types* (special variable).
copy-io-structure-object (function).
define-print-object-method (macro).
define-typed-function (macro).
find-slot (generic function).
find-symbol* (function).
intern* (function).
io-structure-object (structure).
io-structure-object-p (function).
make-io-structure-object (function).
octet-size-form (generic function).
parse-io-structure-slots (function).
read-mem (macro).
reexport (function).
size-form (generic reader).
(setf size-form) (generic writer).
string-length (function).
truncate-text (function).
write-mem (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Defines a type designator alias.
This is equivalent to
(define-io-parser name () (parse-io-type expansion))
See DEFINE-IO-PARSER
Defines a new IO-BACKEND class and registers it.
See IO-BACKEND (type)
See LIST-IO-BACKENDS
Generate a function that parses the given IO-TYPE under the given IO-BACKEND.
TYPE may be either :READ or :WRITE according to which the
corresponding function is generated.
See READ-DEFUN
See WRITE-DEFUN
See DEFINE-IO-FUNCTIONS
Generate a dispatch function that parses the given IO-TYPE.
TYPE may be either :READ or :WRITE according to which the
corresponding function is generated.
See DEFINE-IO-DISPATCH
See DEFINE-IO-FUNCTIONS
Generate all possible parsing functions for the given IO-TYPE.
See DEFINE-IO-BACKEND-FUNCTION
See DEFINE-IO-DISPATCH-FUNCTION
Define an IO-STRUCTURE type instance.
NAME may either be a symbol naming the structure and type, or a list
of that name and defstruct options for the resulting structure
definition.
BODY may be a number of slot definitions preceded by additional
keyword arguments to the resulting structure type definition.
This will do the following:
1. Define a structure via DEFSTRUCT corresponding to the specified
name and slots.
2. Define an IO-TYPE corresponding to the specified name and slots.
3. Define all associated functions via DEFINE-IO-FUNCTIONS.
Each slot in the body may be one of the following:
- An :INCLUDE expression, which causes the specified structure’s
slots to be spliced in. If the :INCLUDE expression occurs first,
the generated STRUCTURE-CLASS will be a subtype of the specified
structure.
- A slot expression, which is structured like:
(NAME IO-TYPE-DESIGNATOR &key OFFSET SIZE ALIGN PAD)
IO-TYPE-DESIGNATOR must be a designator for a type as parsed by
PARSE-IO-TYPE. OFFSET is computed automatically based on the size
of preceding slots. You may add padding with PAD, or ensure the
slot offset is rounded up to a given alignment using ALIGN. You
can also manually force a slot to take up more space via SIZE.
- A symbol designating the name of an io-type which will be used to
pad the structure out with the size of the type.
Note that IO-VALUEs (forms that aren’t designating IO-TYPEs and are
instead used for their runtime value) are evaluated in a lexical
environment with a SLOT macro bound. This macro either takes the name
of a slot of the structure to read out, or some other value form and
the names of the slots to resolve within. For example:
(SLOT FOO) ==> (SLOT-VALUE %current-structure ’FOO)
(SLOT (FOO) BAR) ==> (SLOT-VALUE (FOO) ’BAR)
Referring to prior slots allows you to dynamically size later slots or
dispatch based on the type of an earlier slot’s value.
See IO-STRUCTURE (type)
See IO-STRUCTURE-SLOT (type)
See IO-STRUCTURE-MAGIC (type)
See DEFINE-IO-TYPE
See DEFINE-IO-FUNCTIONS
Define a new IO-TYPE instance under the given name.
The io type will be available at compile-time as well as run-time.
See IO-TYPE (type)
See IO-TYPE
Defines an IO type designator parsing function for the given type name.
This will cause both DESIGNATOR and (DESIGNATOR ...) to match as type
designators and invoke your function to parse it to an IO-TYPE
instance.
See PARSE-IO-TYPE
Shorthand macro to define different permutations of IO types.
See DEFINE-IO-TYPE
Access the IO-TYPE instance associated with the given name.
When reading:
If there is no type of the given name and ERRORP is non-NIL, a
condition of type NO-SUCH-IO-TYPE is signalled. The CONTINUE restart
will cause a TOP-TYPE to be returned. The USE-VALUE restart may be
used to supply an alternate type instance. If ERRORP is NIL, NIL is
returned instead.
When setting:
If the value is NIL, the name is removed from the IO-TYPE directory.
See IO-TYPE (type)
See DEFINE-IO-TYPE
Returns a list of names of all known IO-BACKEND types.
See IO-BACKEND (type)
See DEFINE-IO-BACKEND
Returns a list of names of all known IO-TYPE instances.
See DEFINE-IO-TYPE
See IO-TYPE
See IO-TYPE (type)
Used to determine whether a value designates a static quantity.
If any of the THINGS is NIL, returns *
If any of the THINGS is not a number, returns the thing
Generally, * is used to designate an unknown quantity. Values that aren’t a number are runtime expressions that are unknown quantities at compile-time, to be resolved later.
Returns the set of values that would be acceptable.
See UNKNOWN-VALUE (type)
unknown-value)) ¶Generate a form to call the reader function associated with the given IO-TYPE under the IO-BACKEND.
The form may only be valid within the context established by
READ-DEFUN of the same IO-BACKEND and may thus make use of local
variables and functions.
See READ-DEFUN
See IO-BACKEND
See IO-TYPE
io-foreign-pointer) (type io-type)) ¶io-octet-vector) (type io-type)) ¶Generate a form to call the writer function associated with the given IO-TYPE under the IO-BACKEND for the VALUE-VARIABLE.
The form may only be valid within the context established by
WRITE-DEFUN of the same IO-BACKEND and may thus make use of local
variables and functions.
See WRITE-DEFUN
See IO-BACKEND
See IO-TYPE
io-foreign-pointer) (type io-type) value-variable) ¶io-octet-vector) (type io-type) value-variable) ¶Accesses the list of case forms.
Each entry in the list must be composed of a MATCH and a FORM.
See IO-CASE (type)
See IO-TYPECASE (type)
io-typecase)) ¶automatically generated reader method
io-typecase)) ¶automatically generated writer method
Accesses the name of the lisp structure constructor function.
See IO-STRUCTURE (type)
io-structure)) ¶automatically generated reader method
io-structure)) ¶automatically generated writer method
Returns a suitable lisp default value form for the given io-type.
See IO-TYPE (type)
io-structure-magic)) ¶automatically generated reader method
io-structure-slot)) ¶io-structure)) ¶io-integer)) ¶io-structure-magic)) ¶io-structure-magic)) ¶automatically generated writer method
Returns the designator of the io type.
See NO-SUCH-IO-TYPE
no-such-io-type)) ¶Accesses the length of the IO-VECTOR.
This is a quantity (see SPECIFIC-P) and may thus be statically known,
or be a form to determine the length of the vector at runtime.
If the form is the name of another IO-TYPE, the IO-TYPE is
read/written to obtain the actual count.
Special attention must be given if the ELEMENT-COUNT of an IO-VECTOR
is set to *, in which case the vector is said to consume all remaining
available space in the storage. For IO-STRINGS, the * designates that
the string should be null-terminated.
See IO-VECTOR (type)
See IO-STRING (type)
Accesses the offset of each element in the IO-VECTOR.
This may be a form that, when evaluated under a lexical
environment with I bound to the current index, yields an index at
which the element starts. STRIDE may be an expression that yields the
number of octets between any two elements in the sequence.
See IO-VECTOR (type)
Accesses the type of each element in an IO-VECTOR.
The type should be some IO-TYPE designator and must be constant for
every element.
See IO-VECTOR (type)
Accesses the encoding of the string.
The encoding also defines the byte order. Please see BABEL for the
available encoding schemes.
See IO-STRING (type)
Returns the maximum index of the storage backend.
This may be NIL if the index is not known.
See END-OF-STORAGE (type)
end-of-storage)) ¶end.
Accesses the form of the IO-VALUE.
See IO-VALUE (type)
Returns the index at which the storage condition occurred.
This may be NIL if the index is not known.
See END-OF-STORAGE (type)
end-of-storage)) ¶Generate a form that returns the current index.
The form may only be valid within the context established by
READ-DEFUN or WRITE-DEFUN of the same IO-BACKEND and may thus make use
of local variables and functions.
See READ-DEFUN
See WRITE-DEFUN
See IO-BACKEND
io-foreign-pointer)) ¶io-octet-vector)) ¶io-backend)) ¶Returns a list of initargs to reconstruct this type class instance.
See IO-TYPE (type)
append.
:most-specific-first
io-structure)) ¶io-integer)) ¶numeric-type)) ¶Returns a suitable lisp type expression for the given io-type.
See IO-TYPE (type)
io-structure-slot)) ¶io-structure)) ¶io-integer)) ¶Returns the name associated with the object.
See NO-SUCH-SLOT (type)
See IO-STRUCTURE (type)
See IO-STRUCTURE-SLOT (type)
io-structure-slot)) ¶automatically generated reader method
name.
io-structure)) ¶automatically generated reader method
name.
no-such-slot)) ¶name.
io-structure-slot)) ¶automatically generated writer method
name.
io-structure)) ¶automatically generated writer method
name.
Accesses whether the string is terminated by nulls or not.
This will truncate such strings even when they have a specific length
that goes beyond the first null byte.
See IO-STRING (type)
Returns an octet-size estimate for the given io-type.
Note that this may return an unspecific size.
See UNSPECIFIC-P
See IO-TYPE (type)
io-structure-slot)) ¶automatically generated reader method
io-structure)) ¶io-typecase)) ¶numeric-type)) ¶automatically generated reader method
io-structure-slot)) ¶automatically generated writer method
numeric-type)) ¶automatically generated writer method
Accesses the octet index at which the object resides.
See IO-BACKEND
See IO-STRUCTURE-SLOT
io-structure-slot)) ¶automatically generated reader method
io-backend)) ¶automatically generated reader method
io-structure-slot)) ¶automatically generated writer method
io-backend)) ¶automatically generated writer method
Accesses the byte order of the type.
May be either :LITTLE-ENDIAN or :BIG-ENDIAN.
See NUMERIC-TYPE (type)
numeric-type)) ¶automatically generated reader method
numeric-type)) ¶automatically generated writer method
Parse the given type designator with the arguments to an IO-TYPE instance.
See IO-TYPE (type)
(eql typecase)) &rest args0) ¶cons) &rest args) ¶(eql case)) &rest args0) ¶(eql string)) &rest args0) ¶(eql vector)) &rest args0) ¶(eql float)) &rest args0) ¶(eql integer)) &rest args0) ¶symbol) &rest args) ¶Generate a reader function definition form for the given IO-TYPE under the IO-BACKEND.
This does not necessarily have to be a direct DEFUN form, but must
when evaluated have the effect of defining such a function.
Within the function definition, a call to READ-FORM of the given
IO-TYPE and IO-BACKEND must occur to provide the function’s
logic.
See READ-FORM
See IO-TYPE
See IO-BACKEND
io-foreign-pointer) (type io-type)) ¶io-octet-vector) (type io-type)) ¶io-backend) io-type) ¶symbol) io-type) ¶Generate a form suitable for reading the given IO-TYPE under the IO-BACKEND.
The form may only be valid within the context established by
READ-DEFUN of the same IO-BACKEND and may thus make use of local
variables and functions.
It is expected that backends add methods to this function for all
primitive types, and methods for compound types that may be more
efficient than the generic variants provided by the default IO-BACKEND
method.
See READ-DEFUN
See IO-BACKEND
See IO-TYPE
io-foreign-pointer) (type io-float)) ¶io-foreign-pointer) (type io-integer)) ¶io-octet-vector) (type io-vector)) ¶io-octet-vector) (type io-float)) ¶io-octet-vector) (type io-integer)) ¶io-stream) (type io-integer)) ¶bounds-checked-io-backend) (type io-vector)) ¶bounds-checked-io-backend) (type io-structure)) ¶io-backend) (type io-structure-magic)) ¶io-backend) (type io-structure-slot)) ¶io-backend) (type io-structure)) ¶io-backend) (type io-structure)) ¶io-backend) (type io-typecase)) ¶io-backend) (type io-value)) ¶io-backend) (type io-case)) ¶io-backend) (type io-string)) ¶io-backend) (type io-vector)) ¶io-backend) (type io-vector)) ¶io-backend) (type numeric-type)) ¶symbol) io-type) ¶Generate a form that seeks to the requested offset.
OFFSET may be a number or a form. If the backend determines that
seeking at this point in the generation to the requested offset is
unnecessary, such as when OFFSET is a number and the current static
offset as determined by the backend is the same, NIL may also be
returned.
The form may only be valid within the context established by
READ-DEFUN or WRITE-DEFUN of the same IO-BACKEND and may thus make use
of local variables and functions.
See READ-DEFUN
See WRITE-DEFUN
See IO-BACKEND
io-foreign-pointer) offset) ¶io-octet-vector) offset) ¶io-backend) offset) ¶Accesses whether the integer type is signed or not.
See IO-INTEGER (type)
io-integer)) ¶automatically generated reader method
io-integer)) ¶automatically generated writer method
Accesses the list of IO-STRUCTURE-SLOTs that define the structure’s members.
See IO-STRUCTURE (type)
See IO-STRUCTURE-SLOT (type)
io-structure)) ¶automatically generated reader method
io-structure)) ¶automatically generated writer method
Accesses the stride between two elements in the IO-VECTOR.
This may be a form that, when evaluated, yields an integer
representing the number of octets between the start of any two values
in the sequence.
See IO-VECTOR (type)
Returns the structure that the slot was searched in.
See NO-SUCH-SLOT (type)
no-such-slot)) ¶Returns the value that failed the encoding/decoding.
See UNKNOWN-VALUE (type)
unknown-value)) ¶Accesses the IO-TYPE this type encapsulates.
See IO-CASE (type)
See IO-STRUCTURE (type)
See IO-STRUCTURE-SLOT (type)
io-structure-slot)) ¶automatically generated reader method
io-structure)) ¶automatically generated reader method
io-structure-slot)) ¶automatically generated writer method
io-structure)) ¶automatically generated writer method
Generate a writer function definition form for the given IO-TYPE under the IO-BACKEND.
This does not necessarily have to be a direct DEFUN form, but must
when evaluated have the effect of defining such a function.
Within the function definition, a call to WRITE-FORM of the given
IO-TYPE and IO-BACKEND must occur to provide the function’s
logic.
See WRITE-FORM
See IO-TYPE
See IO-BACKEND
io-foreign-pointer) (type io-type)) ¶io-octet-vector) (type io-type)) ¶io-backend) io-type) ¶symbol) io-type) ¶Generate a form suitable for writing the value contained in VALUE-VARIABLE as the given IO-TYPE under the IO-BACKEND.
The form may only be valid within the context established by
WRITE-DEFUN of the same IO-BACKEND and may thus make use of local
variables and functions.
It is expected that backends add methods to this function for all
primitive types, and methods for compound types that may be more
efficient than the generic variants provided by the default IO-BACKEND
method.
See WRITE-DEFUN
See IO-BACKEND
See IO-TYPE
io-foreign-pointer) (type io-float) value-variable) ¶io-foreign-pointer) (type io-integer) value-variable) ¶io-octet-vector) (type io-vector) value-variable) ¶io-octet-vector) (type io-float) value-variable) ¶io-octet-vector) (type io-integer) value-variable) ¶io-stream) (type io-integer) value-variable) ¶bounds-checked-io-backend) (type io-vector) value-variable) ¶bounds-checked-io-backend) (type io-structure) value-variable) ¶io-backend) (type io-structure-magic) value-variable) ¶io-backend) (type io-structure-slot) value-variable) ¶io-backend) (type io-structure) value-variable) ¶io-backend) (type io-structure) value-variable) ¶io-backend) (type io-typecase) value) ¶io-backend) (type io-value) value) ¶io-backend) (type io-case) value) ¶io-backend) (type io-string) value-variable) ¶io-backend) (type io-vector) value-variable) ¶io-backend) (type io-vector) value-variable) ¶io-backend) (type numeric-type) value-variable) ¶symbol) io-type value-variable) ¶io-structure) stream) ¶io-structure-magic) stream) ¶io-structure-slot) stream) ¶io-structure) stream) ¶io-integer) stream) ¶Supertype for all conditions signalled by this library.
See NO-SUCH-IO-TYPE
See END-OF-STORAGE
See UNKNOWN-VALUE
See NO-SUCH-SLOT
condition.
Error signalled when the backend is not large enough to contain the requested type.
See INDEX
See END
See BINARY-STRUCTURES-CONDITION (type)
binary-structures-condition.
error.
Error signalled when an undefined IO type is referenced.
See DESIGNATOR
See IO-TYPE (type)
See IO-TYPE
See BINARY-STRUCTURES-CONDITION (type)
binary-structures-condition.
error.
:designator
This slot is read-only.
binary-structures-condition.
error.
Error signalled when a value is encoded or decoded that was not declared in the type.
See VALUE
See ACCEPTED
See BINARY-STRUCTURES-CONDITION (type)
binary-structures-condition.
error.
Class for IO-BACKENDs that require manual bounds checks.
A subclass of this must provide a CHECK-AVAILABLE-SPACE function of
one argument (octets to be consumed) in the lexical environment of the
functions defined via READ-DEFUN and WRITE-DEFUN.
See READ-DEFUN
See WRITE-DEFUN
See IO-BACKEND (type)
Superclass for all storage backends supported by this library.
A backend must implement methods for the functions READ-DEFUN,
WRITE-DEFUN, CALL-READ-FORM, CALL-WRITE-FORM, READ-FORM, WRITE-FORM,
INDEX-FORM, and SEEK-FORM to emit the correct forms to decode or
encode io types as appropriate for the backend.
The OFFSET slot is used to keep track of the current statically accumulated octet index as generated by emitted forms. This static slot offset is used to eliminate the spurious seeking operations.
See UNSPECIFIC-P
See OFFSET
See READ-DEFUN
See WRITE-DEFUN
See CALL-READ-FORM
See CALL-WRITE-FORM
See READ-FORM
See WRITE-FORM
See INDEX-FORM
See SEEK-FORM
See DEFINE-IO-BACKEND
See LIST-IO-BACKENDS
See DEFINE-IO-DISPATCH
See DEFINE-IO-BACKEND-FUNCTION
See DEFINE-IO-FUNCTIONS
index-form.
(setf offset).
offset.
read-defun.
read-form.
read-form.
read-form.
read-form.
read-form.
read-form.
read-form.
read-form.
read-form.
read-form.
read-form.
seek-form.
write-defun.
write-form.
write-form.
write-form.
write-form.
write-form.
write-form.
write-form.
write-form.
write-form.
write-form.
write-form.
0
:offset
Representation of an enum-like value dispatch.
Each CASE must be a possible value of the VALUE-TYPE to match against
and either a constant to use as the associated value or an IO-TYPE
designator to describe how to parse the associated value.
This type parses from the representation
(CASE VALUE-TYPE (MATCH FORM)*)
For example:
(case uint8
(1 :linux)
(2 :windows)
(3 :darwin))
Defines a standard enum-like association. However, you may also use
other IO-TYPEs in the FORM:
(case uint8
(1 image)
(2 music-track)
(3 video))
Note that in order for the inverse writing operation to work, the
order of the entries matters and must usually be the reverse of what
would naturally be listed. Meaning that if SUB is a subtype of SUPER,
then SUPER must be listed /after/ SUB, or else SUPER will match both,
causing SUB to never be hit.
See VALUE-TYPE
See CASES
See IO-TYPECASE (type)
See IO-TYPE (type)
Type class for floating point IO-TYPEs.
Only IEEE floating point values are represented, depending on
implementation support with 2, 4, 8, and 16 octets.
This type parses from the representation
(FLOAT [OCTET-SIZE])
With OCTET-SIZE defaulting to 4.
The following shorthands are also defined:
FLOAT [16/32/64/128] [/-BE]
Where FLOAT16-BE designates a "16-bit short-float in
big-endian" and FLOAT32 designates a "32-bit single-float in
little-endian".
See NUMERIC-TYPE (type)
An IO-BACKEND for foreign / memory pointers.
You must pass in a SIZE along with the pointer that designates the
number of octets available in the buffer.
See IO-BACKEND (type)
Type class for integer IO-TYPEs.
If an integer is SIGNED-P, then its representation uses two’s
complement to represent the sign.
This type parses from the representation
(INTEGER [OCTET-SIZE] [:SIGNED/:UNSIGNED] [ORDER])
The following shorthands are also defined:
[S/U] INT [8/16/32/64/128] [/-BE]
Where UINT16-BE designates an "unsigned 16-bit integer in
big-endian" and SINT32 designates a "signed 32-bit integer in
little-endian".
See NUMERIC-TYPE (type)
t
:signed-p
An IO-BACKEND for octet / unsigned-byte 8 VECTORs.
Dispatches both from SIMPLE-ARRAYs and ARRAYs. In the latter case the
array is copied to a SIMPLE-ARRAY first, however. You may pass both a
START and END to designate a subsequence.
See IO-BACKEND (type)
An IO-BACKEND for STREAMs.
Dispatches both from STREAMs and PATHNAMEs.
See IO-BACKEND (type)
Type class to represent a character string.
This type parses from the representation
(STRING ELEMENT-COUNT [ENCODING] [NULL-TERMINATED-P])
The encoding defaults to UTF-8.
See ELEMENT-COUNT
See ENCODING
See NULL-TERMINATED-P
See IO-TYPE (type)
Representation of some structure composed out of multiple values.
See VALUE-TYPE
See CONSTRUCTOR
See SLOTS
See NAME
See FIND-SLOT
See DEFINE-IO-STRUCTURE
See IO-TYPE (type)
(setf constructor).
constructor.
default-value.
describe-object.
find-slot.
initargs.
lisp-type.
(setf name).
name.
octet-size.
octet-size-form.
print-object.
read-form.
read-form.
read-form.
(setf size-form).
size-form.
(setf slots).
slots.
(setf value-type).
value-type.
write-form.
write-form.
write-form.
:value-type
:constructor
:slots
:octet-size, :size-form
Representation of a constant / "magic" value within a structure or some padding.
If the VALUE-TYPE of the slot is known, a value of that type is
read. If the DEFAULT-VALUE is also known, the value is compared and if
not EQUALP, an error of type MAGIC-VALUE-MISMATCHED is signalled. If
the DEFAULT-VALUE is known but no explicit VALUE-TYPE is set, the
DEFAULT-VALUE must be a STRING or OCTET-VECTOR, a sequence of
equivalent length of which is parsed for comparison. If a VALUE-TYPE
is known but no DEFAULT-VALUE, the value is simply discarded.
See IO-STRUCTURE-SLOT (type)
Representation of a single slot in an IO-STRUCTURE.
See VALUE-TYPE
See OCTET-SIZE
See OFFSET
See NAME
See IO-STRUCTURE-MAGIC (type)
See IO-STRUCTURE (type)
Superclass for all known type classes for IO.
See READ-DEFUN
See WRITE-DEFUN
See CALL-READ-FORM
See CALL-WRITE-FORM
See READ-FORM
See WRITE-FORM
See LISP-TYPE
See DEFAULT-VALUE
See OCTET-SIZE
See READ-DEFUN
See WRITE-DEFUN
See CALL-READ-FORM
See CALL-WRITE-FORM
See READ-FORM
See WRITE-FORM
See INITARGS
See PARSE-IO-TYPE
See IO-TYPE
See DEFINE-IO-TYPE
See LIST-IO-TYPES
See DEFINE-IO-DISPATCH-FUNCTION
See DEFINE-IO-BACKEND-FUNCTION
See DEFINE-IO-FUNCTIONS
Representation of some runtime type dispatch.
This is useful to implement optional segments in an IO-TYPE or to dispatch parsing based on an earlier part of the parsing state.
See CASES
See IO-VALUE (type)
:cases
Representation of some form used purely for its runtime value.
This always has an unknown real type and size, and is the default type
representation for parsing any CONS-based IO-TYPE.
Meaning: (parse-io-type ’(foo)) ==> IO-VALUE
See FORM
See IO-TYPE (type)
Type class to represent a sequence of other values.
This type parses from the representation
(VECTOR ELEMENT-TYPE [ELEMENT-COUNT] [ELEMENT-OFFSET])
See ELEMENT-TYPE
See ELEMENT-COUNT
See ELEMENT-OFFSET
See STRIDE
See IO-TYPE (type)
default-value.
(setf element-count).
element-count.
(setf element-offset).
element-offset.
(setf element-type).
element-type.
initargs.
lisp-type.
octet-size.
octet-size-form.
print-object.
read-form.
read-form.
read-form.
read-form.
read-form.
(setf stride).
stride.
write-form.
write-form.
write-form.
write-form.
write-form.
(quote org.shirakumo.binary-structures:uint8)
:element-type
(quote *)
:element-count
:element-offset
:stride
Type class for numerical IO-TYPEs.
Every numeric type has a fixed OCTET-SIZE and a byte ORDER, which
defaults to :LITTLE-ENDIAN.
See OCTET-SIZE
See ORDER
See IO-TYPE (type)
Type class for an ambiguous IO-TYPE.
See IO-TYPE (type)
Returns the slot with the given name on the structure.
If no slot with the requested name exists on the structure, an error
of type NO-SUCH-SLOT is signalled.
See IO-STRUCTURE (type)
See IO-STRUCTURE-SLOT (type)
io-structure)) ¶io-structure-slot) value-variable) ¶io-structure) value-variable) ¶io-typecase) value-variable) ¶io-structure)) ¶automatically generated reader method
io-structure)) ¶automatically generated writer method
structure-object.
| Jump to: | %
(
A C D E F G I L M N O P R S T U V W |
|---|
| Jump to: | %
(
A C D E F G I L M N O P R S T U V W |
|---|
| Jump to: | *
A C D E F I N O S V |
|---|
| Jump to: | *
A C D E F I N O S V |
|---|
| Jump to: | B C D E F I N O P S T U |
|---|
| Jump to: | B C D E F I N O P S T U |
|---|