BINARY-TYPES full listing

BINARY-RECORD-ALIST

(BINARY-RECORD-ALIST OBJ) [function]

Description		Returns an assoc-list representation of (the slots of) a binary record object.
Calls		BINARY-RECORD-SLOTS, FIND-BINARY-TYPE, MAPCAN, RECORD-SLOT-NAME, RECORD-SLOT-TYPE, SLOT-BOUNDP, SLOT-VALUE and TYPE-OF
Location		tools/binary-types.lisp

BINARY-RECORD-SLOT-NAMES

(BINARY-RECORD-SLOT-NAMES TYPE &OPTIONAL (PADDING-SLOTS-P NIL)) [function]

Description		Returns a list of the slot-names of TYPE, in sequence.
Calls		BINARY-RECORD-SLOTS, FIND-BINARY-TYPE, MAPCAN, MAPCAR, RECORD-SLOT-NAME and RECORD-SLOT-TYPE
Location		tools/binary-types.lisp

BINARY-SLOT-TYPE

(BINARY-SLOT-TYPE TYPE SLOT-NAME) [function]

Calls		BINARY-RECORD-SLOTS, FIND, FIND-BINARY-TYPE and RECORD-SLOT-TYPE
Location		tools/binary-types.lisp

BINARY-SLOT-VALUE

(BINARY-SLOT-VALUE OBJECT SLOT-NAME) [function]

Description		Return the ``binary'' value of a slot, i.e the value mapped by any MAP-ON-WRITE slot mapper function.
Calls		BINARY-RECORD-SLOTS, FIND-BINARY-TYPE, FUNCALL, RECORD-SLOT-ON-WRITE, RECORD-SLOT-TYPE, SLOT-VALUE and TYPE-OF
Location		tools/binary-types.lisp

BITFIELD-COMPUTE-NUMERIC-VALUE

(BITFIELD-COMPUTE-NUMERIC-VALUE TYPE SYMBOLIC-VALUE) [function]

Description		Returns the numeric representation of a bitfields symbolic value.
Called By		ENUM-VALUE
Calls		(SETF LDB), BITFIELD-ENTRY-BYTESPEC, BITFIELD-ENTRY-VALUE, BITFIELD-HASH, DPB and GETHASH
Location		tools/binary-types.lisp

BITFIELD-COMPUTE-SYMBOLIC-VALUE

(BITFIELD-COMPUTE-SYMBOLIC-VALUE TYPE NUMERIC-VALUE) [function]

Description		Return the symbolic value of a numeric bitfield
Calls		BITFIELD-ENTRY-BYTESPEC, BITFIELD-ENTRY-VALUE, BITFIELD-HASH, ERROR, LDB and MAPHASH
Location		tools/binary-types.lisp

BITFIELD-ENTRY-BYTESPEC

(BITFIELD-ENTRY-BYTESPEC (OBJ BITFIELD-ENTRY)) [function]

(SETF BITFIELD-ENTRY-BYTESPEC)

((SETF BITFIELD-ENTRY-BYTESPEC) (OBJ BITFIELD-ENTRY)) [function]

BITFIELD-ENTRY-P

(BITFIELD-ENTRY-P OBJ) [predicate]

BITFIELD-ENTRY-VALUE

(BITFIELD-ENTRY-VALUE (OBJ BITFIELD-ENTRY)) [function]

(SETF BITFIELD-ENTRY-VALUE)

((SETF BITFIELD-ENTRY-VALUE) (OBJ BITFIELD-ENTRY)) [function]

COPY-BITFIELD-ENTRY

(COPY-BITFIELD-ENTRY (OBJ BITFIELD-ENTRY)) [function]

DEFINE-BINARY-CLASS

(DEFINE-BINARY-CLASS TYPE-NAME SUPERS SLOTS) [macro]

Calls		MAKE-RECORD-SLOT, MAPCAN, MAPCAR and PARSE-SLOT-SPECIFIER
Location		tools/binary-types.lisp

DEFINE-BINARY-STRING

(DEFINE-BINARY-STRING TYPE-NAME SIZE &KEY TERMINATORS) [macro]

DEFINE-BINARY-STRUCT

(DEFINE-BINARY-STRUCT NAME-AND-OPTIONS DUMMY-OPTIONS) [macro]

Calls		MAKE-RECORD-SLOT, MAPCAN, MAPCAR, PARSE-SLOT-DESCRIPTION and REST
Location		tools/binary-types.lisp

DEFINE-BITFIELD

(DEFINE-BITFIELD TYPE-NAME STORAGE-TYPE SPEC) [macro]

Calls		MAKE-PAIRS, MAPCAN, MAPCAR and REST
Location		tools/binary-types.lisp

DEFINE-ENUM

(DEFINE-ENUM TYPE-NAME STORAGE-NAME) [macro]

Description		A simple wrapper around DEFINE-BITFIELD for simple enum types.
Location		tools/binary-types.lisp

DEFINE-FIXED-SIZE-NT-STRING

(DEFINE-FIXED-SIZE-NT-STRING TYPE-NAME SIZE) [macro]

DEFINE-NULL-TERMINATED-STRING

(DEFINE-NULL-TERMINATED-STRING TYPE-NAME SIZE) [macro]

DEFINE-SIGNED

(DEFINE-SIGNED NAME SIZE &OPTIONAL (ENDIAN NIL)) [macro]

DEFINE-UNSIGNED

(DEFINE-UNSIGNED NAME SIZE &OPTIONAL ENDIAN) [macro]

ENUM-VALUE

(ENUM-VALUE TYPE SYMBOLIC-VALUE) [function]

Description		For an enum type (actually, for any bitfield-based type), ~ look up the numeric value of a symbol.
Calls		BITFIELD-COMPUTE-NUMERIC-VALUE and FIND-BINARY-TYPE
Location		tools/binary-types.lisp

FIND-BINARY-TYPE

(FIND-BINARY-TYPE NAME &OPTIONAL (ERRORP T)) [function]

Called By		(SETF FIND-BINARY-TYPE), BINARY-RECORD-ALIST, BINARY-RECORD-SLOT-NAMES, BINARY-SLOT-TYPE, BINARY-SLOT-VALUE, ENUM-VALUE, MERGE-BINARY-RECORDS and SLOT-OFFSET
Calls		ERROR and GETHASH
Location		tools/binary-types.lisp

(SETF FIND-BINARY-TYPE)

((SETF FIND-BINARY-TYPE) VALUE NAME) [function]

Calls		(SETF GETHASH), CLASS-OF, FIND-BINARY-TYPE, TYPE-OF and WARN
Location		tools/binary-types.lisp

FIND-BINARY-TYPE-NAME

(FIND-BINARY-TYPE-NAME TYPE) [function]

Calls		MAPHASH
Location		tools/binary-types.lisp

MAKE-BITFIELD-ENTRY

(MAKE-BITFIELD-ENTRY)

MAKE-PAIRS

(MAKE-PAIRS LIST) [function]

Description		(make-pairs '(1 2 3 4)) => ((1 . 2) (3 . 4))
Called By		DEFINE-BITFIELD
Location		tools/binary-types.lisp

MAKE-RECORD-SLOT

(MAKE-RECORD-SLOT &KEY NAME TYPE ON-WRITE) [function]

Called By		DEFINE-BINARY-CLASS and DEFINE-BINARY-STRUCT
Location		tools/binary-types.lisp

MERGE-BINARY-RECORDS

(MERGE-BINARY-RECORDS OBJ1 OBJ2) [function]

Description		Returns a record where every non-bound slot in obj1 is replaced with that slot's value from obj2.
Calls		(SETF SLOT-VALUE), BINARY-RECORD-SLOTS, CLASS-OF, ERROR, FIND-BINARY-TYPE, MAKE-INSTANCE, RECORD-SLOT-NAME, SLOT-BOUNDP, SLOT-VALUE and TYPE-OF
Location		tools/binary-types.lisp

PARSE-BT-SPEC

(PARSE-BT-SPEC EXPR) [function]

Description		Takes a binary-type specifier (a symbol, integer, or define-xx form), and returns three values: the binary-type's name, the equivalent lisp type, and any nested declaration that must be expanded separately.
Calls		ERROR, FIND-PACKAGE, QUOTED-NAME-P and SYMBOL-PACKAGE
Location		tools/binary-types.lisp

PRINT-OBJECT

(PRINT-OBJECT (TYPE BINARY-INTEGER) STREAM) [method]

Calls		BINARY-TYPE-NAME, CALL-NEXT-METHOD, FORMAT, PRINT-UNREADABLE-OBJECT, SLOT-VALUE and TYPE
Location		tools/binary-types.lisp

QUOTED-NAME-P

(QUOTED-NAME-P FORM) [function]

Called By		PARSE-BT-SPEC
Location		tools/binary-types.lisp

READ-BINARY-STRING

(READ-BINARY-STRING STREAM &KEY SIZE TERMINATORS) [function]

Description		Read a string from STREAM, terminated by any member of the list TERMINATORS. If SIZE is provided and non-nil, exactly SIZE octets are read, but the returned string is still terminated by TERMINATORS. The string and the number of octets read are returned.
Called By		LOAD-BINARY-STRING
Location		tools/binary-types.lisp

RECORD-SLOT-NAME

(RECORD-SLOT-NAME S) [function]

Called By		BINARY-RECORD-ALIST, BINARY-RECORD-SLOT-NAMES, MERGE-BINARY-RECORDS and SLOT-OFFSET
Location		tools/binary-types.lisp

RECORD-SLOT-ON-WRITE

(RECORD-SLOT-ON-WRITE S) [function]

Called By		BINARY-SLOT-VALUE
Location		tools/binary-types.lisp

RECORD-SLOT-TYPE

(RECORD-SLOT-TYPE S) [function]

Called By		BINARY-RECORD-ALIST, BINARY-RECORD-SLOT-NAMES, BINARY-SLOT-TYPE and BINARY-SLOT-VALUE
Location		tools/binary-types.lisp

SLOT-OFFSET

(SLOT-OFFSET TYPE SLOT-NAME) [function]

Description		Return the offset (in number of octets) of SLOT-NAME in TYPE.
Calls		BINARY-RECORD-SLOT-OFFSET, BINARY-RECORD-SLOTS, ERROR, FIND-BINARY-TYPE, FIND-IF and RECORD-SLOT-NAME
Location		tools/binary-types.lisp

WITH-BINARY-FILE

(WITH-BINARY-FILE STREAM-VAR) [macro]

Description		This is a thin wrapper around WITH-OPEN-FILE, that tries to set the stream's element-type to that required by READ-BINARY and WRITE-BINARY. A run-time assertion on the stream's actual element type is performed, unless you disable this feature by setting the keyword option :check-stream to nil.
Called By		LOAD-SAVEHEADER
Calls		(SETF GETF), COPY-LIST and REMF
Location		tools/binary-types.lisp

WITH-BINARY-INPUT-FROM-LIST

(WITH-BINARY-INPUT-FROM-LIST STREAM-VAR) [macro]

Description		Bind STREAM-VAR to an object that, when passed to READ-BINARY, provides 8-bit bytes from LIST-FORM, which must yield a list. Binds *BINARY-READ-BYTE* appropriately. This macro will break if this binding is shadowed.
Calls		MAKE-SYMBOL
Location		tools/binary-types.lisp

WITH-BINARY-INPUT-FROM-VECTOR

(WITH-BINARY-INPUT-FROM-VECTOR STREAM-VAR) [macro]

Description		Bind STREAM-VAR to an object that, when passed to READ-BINARY, provides 8-bit bytes from VECTOR-FORM, which must yield a vector. Binds *BINARY-READ-BYTE* appropriately. This macro will break if this binding is shadowed.
Calls		MAKE-SYMBOL
Location		tools/binary-types.lisp

WITH-BINARY-OUTPUT-TO-LIST

(WITH-BINARY-OUTPUT-TO-LIST STREAM-VAR) [macro]

Description		Inside BODY, calls to WRITE-BINARY with stream STREAM-VAR will collect the individual 8-bit bytes in a list (of integers). This list is returned by the form. (There is no way to get at the return-value of BODY.) This macro depends on the binding of *BINARY-WRITE-BYTE*, which should not be shadowed.
Calls		MAKE-SYMBOL
Location		tools/binary-types.lisp

WITH-BINARY-OUTPUT-TO-VECTOR

(WITH-BINARY-OUTPUT-TO-VECTOR STREAM-VAR) [macro]

Description		Arrange for STREAM-VAR to collect octets in a vector. VECTOR-OR-SIZE-FORM is either a form that evaluates to a vector, or an integer in which case a new vector of that size is created. The vector's fill-pointer is used as the write-index. If ADJUSTABLE nil (or not provided), an error will occur if the array is too small. Otherwise, the array will be adjusted in size, using VECTOR-PUSH-EXTEND. If ADJUSTABLE is an integer, that value will be passed as the EXTENSION argument to VECTOR-PUSH-EXTEND. If VECTOR-OR-SIZE-FORM is an integer, the created vector is returned, otherwise the value of BODY.
Calls		ERROR and MAKE-SYMBOL
Location		tools/binary-types.lisp

WRITE-BINARY-RECORD

(WRITE-BINARY-RECORD OBJECT STREAM) [generic]

WRITE-BINARY-RECORD

(WRITE-BINARY-RECORD OBJECT STREAM) [method]

Calls		FIND-BINARY-TYPE, TYPE-OF and WRITE-BINARY
Location		tools/binary-types.lisp