The deoxybyte-io Reference Manual

Table of Contents

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

The deoxybyte-io Reference Manual

This is the deoxybyte-io Reference Manual, version 0.15.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 10:08:05 2019 GMT+0.


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

1 Introduction

Introduction

The deoxybyte-io system is a selection of utility code focused on
transfer of data between Lisp and its environment. It includes:

- IO and parser conditions
- File and directory utilities
- Command line interface definition utilities
- Stream classes and methods
- Tabular text parsing
- Binary encoding and decoding *

* Nathan Froyd has released nibbles
(https://github.com/froydnj/nibbles) which implements octet-vector
operations similar to those in this system, only optimized for
efficiency. I'll consider replacing my implementations with a shim to
nibbles, or calling nibbles directly.


Installation

deoxybyte-io uses ASDF for system definition. Install as described in
the ASDF documentation and then load:

 (asdf:load-system :deoxybyte-io)

Alternatively, use the equivalent deoxybyte-systems:load-system function:

 (dxs:load-system :deoxybyte-io)


Tests

To run the unit and regression tests you need to have LIFT
installed. Run the tests:

 (asdf:test-system :deoxybyte-io)

Alternatively, use the equivalent deoxybyte-systems:test-system function:

 (dxs:test-system :deoxybyte-io)


Documentation

See the Lisp docstrings, particularly the package docstrings for an
overview. HTML documentation may be generated with the command:

 (dxs:document-system :deoxybyte-io)

at the REPL, provided that CLDOC is installed.


Dependencies

deoxybyte-systems       git://github.com/keithj/deoxybyte-systems.git
deoxybyte-utilities     git://github.com/keithj/deoxybyte-utilities.git

cl-fad                  http://www.weitz.de/cl-fad/
getopt                  git://git.b9.com/getopt.git

Optional dependencies

LIFT                    http://common-lisp.net/project/lift/
CLDOC                   http://common-lisp.net/project/cldoc/


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

2 Systems

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


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

2.1 deoxybyte-io

Author

Keith James

License

GPL v3

Version

0.15.0

Dependencies
Source

deoxybyte-io.asd (file)

Component

core (module)


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

3 Modules

Modules are listed depth-first from the system components tree.


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

3.1 deoxybyte-io/core

Parent

deoxybyte-io (system)

Location

src/

Components

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

4 Files

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


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

4.1 Lisp


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

4.1.1 deoxybyte-io.asd

Location

deoxybyte-io.asd

Systems

deoxybyte-io (system)


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

4.1.2 deoxybyte-io/core/package.lisp

Parent

core (module)

Location

src/package.lisp

Packages

uk.co.deoxybyte-io


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

4.1.3 deoxybyte-io/core/conditions.lisp

Dependency

package.lisp (file)

Parent

core (module)

Location

src/conditions.lisp

Exported Definitions
Internal Definitions

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

4.1.4 deoxybyte-io/core/deoxybyte-io.lisp

Dependency

conditions.lisp (file)

Parent

core (module)

Location

src/deoxybyte-io.lisp

Exported Definitions

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

4.1.5 deoxybyte-io/core/environment.lisp

Dependency

deoxybyte-io.lisp (file)

Parent

core (module)

Location

src/environment.lisp


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

4.1.6 deoxybyte-io/core/parse-float.lisp

Dependency

environment.lisp (file)

Parent

core (module)

Location

src/parse-float.lisp

Exported Definitions

parse-float (function)

Internal Definitions

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

4.1.7 deoxybyte-io/core/ieee-float.lisp

Dependency

parse-float.lisp (file)

Parent

core (module)

Location

src/ieee-float.lisp

Exported Definitions
Internal Definitions

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

4.1.8 deoxybyte-io/core/binary-operations.lisp

Dependency

ieee-float.lisp (file)

Parent

core (module)

Location

src/binary-operations.lisp

Exported Definitions
Internal Definitions

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

4.1.9 deoxybyte-io/core/streams.lisp

Dependency

binary-operations.lisp (file)

Parent

core (module)

Location

src/streams.lisp

Exported Definitions
Internal Definitions

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

4.1.10 deoxybyte-io/core/line-stream.lisp

Dependency

streams.lisp (file)

Parent

core (module)

Location

src/line-stream.lisp

Exported Definitions
Internal Definitions

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

4.1.11 deoxybyte-io/core/command-line-interface.lisp

Dependency

line-stream.lisp (file)

Parent

core (module)

Location

src/command-line-interface.lisp

Exported Definitions
Internal Definitions

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

4.1.12 deoxybyte-io/core/files-and-directories.lisp

Dependency

command-line-interface.lisp (file)

Parent

core (module)

Location

src/files-and-directories.lisp

Exported Definitions
Internal Definitions

merge-pathstrings (function)


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

4.1.13 deoxybyte-io/core/simple-table-parser.lisp

Dependency

files-and-directories.lisp (file)

Parent

core (module)

Location

src/simple-table-parser.lisp

Exported Definitions
Internal Definitions

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

4.1.14 deoxybyte-io/core/external-merge-sort.lisp

Dependency

simple-table-parser.lisp (file)

Parent

core (module)

Location

src/external-merge-sort.lisp

Exported Definitions
Internal Definitions

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

4.1.15 deoxybyte-io/core/external-line-sort.lisp

Dependency

external-merge-sort.lisp (file)

Parent

core (module)

Location

src/external-line-sort.lisp

Exported Definitions

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

4.1.16 deoxybyte-io/core/sbcl.lisp

Dependency

external-line-sort.lisp (file)

Parent

core (module)

Location

src/sbcl.lisp

Exported Definitions
Internal Definitions

get-system-argv (function)


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

5 Packages

Packages are listed by definition order.


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

5.1 uk.co.deoxybyte-io

The deoxybyte-io system is a selection of utility
code focused on transfer of data between Lisp and its environment. It includes:

- IO and parser conditions
- File and directory utilities
- Command line interface definition utilities
- Stream classes and methods
- Tabular text parsing
- Binary encoding and decoding

Source

package.lisp (file)

Nicknames
Use List
Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Special variables

Special Variable: *default-tmpdir*

The default temporary file directory pathname.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)

Special Variable: *default-tmpfile-defaults*

The defaults used to fill in temporary file pathnames.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)

Special Variable: *empty-field*

The default empty field string.

Package

uk.co.deoxybyte-io

Source

simple-table-parser.lisp (file)


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

6.1.2 Macros

Macro: check-field TEST-FORM RECORD FIELD &optional ERROR-MESSAGE &rest MESSAGE-ARGUMENTS

Checks FIELD of RECORD. If TEST-FORM returns false a {define-condition malformed-field-error} is raised. The default error message may be refined with an additional ERROR-MESSAGE.

Arguments:

- test-form (form): A form to be evaluated. If the form returns NIL, an error is raised.
- record (form): A form that evaluates to a record.
- field (form): A form that evaluates to a field in RECORD.

Optional:

- error-message (string): An error message string.

Rest:

- message-arguments (forms): Forms that evaluate to arguments for the error message.

Package

uk.co.deoxybyte-io

Source

deoxybyte-io.lisp (file)

Macro: check-record TEST-FORM RECORD &optional ERROR-MESSAGE &rest MESSAGE-ARGUMENTS

Checks RECORD. If TEST-FORM returns false a
{define-condition malformed-record-error} is raised. The default error message may be refined with an additional ERROR-MESSAGE.

Arguments:

- test-form (form): A form to be evaluated. If the form returns NIL, an error is raised.
- record (form): A form that evaluates to a record.

Optional:

- error-message (string): An error message string.

Rest:

- message-arguments (forms): Forms that evaluate to arguments for the error message.

Package

uk.co.deoxybyte-io

Source

deoxybyte-io.lisp (file)

Macro: define-cli NAME DIRECT-SUPERCLASSES OPTION-SPECS &rest OPTIONS

Defines a new CLI class NAME.

Arguments:

- name (symbol): The class name.
- direct-superclasses (list symbols): The direct superclasses.
- option-specs (list option-specs): The CLI option specifiers.

Each option-spec specifies a slot and its corresponding CLI option instance.

Arguments:

- slot-name (symbol)
- option-name (string)

Rest:

- cl-option instance initargs

Key:

- documentation (string): Slot (and hence cli-option) documentation.

e.g.

;;; (a "a" :required-option t :value-type ’string
;;; :documentation "Required option A.")

Rest:

- class-options as in defclass.

e.g.

;;; (define-cli example-cli (cli)
;;; ((a "a" :required-option t :value-type ’string
;;; :documentation "Required option A.")
;;; (b "b" :required-option nil :value-type ’integer :value-default 99 ;;; :documentation "Required option D."))
;;; (:documentation "An example CLI class definition."))

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Macro: define-integer-decoder NAME &key BYTES ORDER SIGNED

Defines a function NAME with one mandatory argument, a simple-array of unsigned-byte 8, and one optional argument, a fixnum index in that array that defaults to 0. The function returns the Lisp integer whose value is given by the bytes at that index in the byte array.

Key:

- bytes (fixnum): the number of bytes that comprise the number.
- order (sumbol): the byte order of the array, may be one
of :little-endian or :big-endian ( :network-byte-order may be used as a synonym for :big-endian ).
- signed (boolean): T if the bytes are a two’s complement representation of a signed integer.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Macro: define-integer-encoder NAME &key BYTES ORDER SIGNED

Defines a function NAME with two mandatory arguments, an integer and a simple-array of unsigned-byte 8, and one optional argument, a fixnum index in that array that defaults to 0. The function returns the buffer containing the encoded integer.

Key:

- bytes (fixnum): the number of bytes that comprise the number. - order (sumbol): the byte order of the array, may be one
of :little-endian or :big-endian ( :network-byte-order may be used as a synonym for :big-endian ).

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Macro: define-line-parser PARSER-NAME DELIMITER FIELDS &optional CONSTRAINTS

Defines a line parser function that splits lines and then parses and validates fields according to the FIELDS contraints and validates combinations of fields according to CONSTRAINTS.

Arguments:

- parser-name (symbol): a symbol naming the new function.
- delimiter (character): a character used to split the lines being parsed.
- fields (list list): a list of field definition lists. The form of a definition list is

;;; (symbolic-field-name &keys type ignore parser validator null-str)

which indicates the symbol to which the parsed field value will be stored in the alist returned by the function

- parser-name (symbol): the expected type of the field value ( :string, :integer or :float, defaulting to :string), an optional boolean flag indicating that the field should be ignored, an optional parser function (defaults to a pass-through string parser), an optional validator function that returns T when the parsed field is valid and an optional string to indicate an null field (defaults to {defparameter *empty-field*} ).

Optional:

- constraints (list list): a list of field constraint definition lists. The form of a constraint definition list is

;;; (symbolic-constraint-name (symbolic-field-name list) validator)

The symbolic-field-name list should contain names of one or more fields and the validator must then be a function which accepts the parsed values of those fields in the same order and returns T when those fields have acceptable values.

Package

uk.co.deoxybyte-io

Source

simple-table-parser.lisp (file)

Macro: with-argv (ARGV) &body BODY

Executes BODY with ARGV bound to system argv list.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Macro: with-tmp-directory (DIRECTORY &rest REST) &body BODY

Executes BODY with DIRECTORY bound to a temporary directory that has been created with the MAKE-TMP-DIRECTORY function. If BODY executes without error, the temporary directory is deleted. If an error occurs, restarts DELETE-TMP-DIRECTORY and LEAVE-TMP-DIRECTORY are provided to control what happens.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)

Macro: with-tmp-pathname (PATHNAME &rest REST) &body BODY

Executes BODY with DIRECTORY bound to a pathname of a temporary file that has been created with the MAKE-TMP-PATHNAME function. If BODY executes without error, any file denoted by the temporary pathname is deleted. If an error occurs, restarts DELETE-TMP-PATHNAME and LEAVE-TMP-PATHNAME are provided to control what happens.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)


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

6.1.3 Functions

Function: absolute-pathname-p PATHNAME

Returns T if PATHSPEC is a pathname designator for an absolute file or directory, or NIL otherwise.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)

Function: decode-float32be BUFFER &optional INDEX

Decodes 4 byte float stored as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: decode-float32le BUFFER &optional INDEX

Decodes 4 byte float stored as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: decode-float64be BUFFER &optional INDEX

Decodes 8 byte float stored as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: decode-float64le BUFFER &optional INDEX

Decodes 8 byte float stored as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: decode-ieee-float32 N

Decodes an IEEE 754 encoded single-float from 32-bit integer
N. NaN, +Inf and -Inf are represented by the keywords :not-a-number :positive-infinity or :negative-infinity respectively.

Package

uk.co.deoxybyte-io

Source

ieee-float.lisp (file)

Function: decode-ieee-float64 N

Decodes an IEEE 754 encoded double-float from 64-bit integer
N. NaN, +Inf and -Inf are represented by the keywords :not-a-number :positive-infinity or :negative-infinity respectively.

Package

uk.co.deoxybyte-io

Source

ieee-float.lisp (file)

Function: decode-int16be BUFFER &optional INDEX

Decodes a signed 2 byte integer stored as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: decode-int16le BUFFER &optional INDEX

Decodes a signed 2 byte integer stored as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: decode-int32be BUFFER &optional INDEX

Decodes a signed 4 byte integer stored as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: decode-int32le BUFFER &optional INDEX

Decodes a signed 4 byte integer stored as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: decode-int64be BUFFER &optional INDEX

Decodes a signed 8 byte integer stored as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: decode-int64le BUFFER &optional INDEX

Decodes a signed 8 byte integer stored as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: decode-int8be BUFFER &optional INDEX

Decodes a signed 1 byte integer stored as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: decode-int8le BUFFER &optional INDEX

Decodes a signed 1 byte integer stored as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: decode-uint16be BUFFER &optional INDEX

Decodes an unsigned 2 byte integer stored as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: decode-uint16le BUFFER &optional INDEX

Decodes an unsigned 2 byte integer stored as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: decode-uint32be BUFFER &optional INDEX

Decodes an unsigned 4 byte integer stored as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: decode-uint32le BUFFER &optional INDEX

Decodes an unsigned 4 byte integer stored as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: decode-uint64be BUFFER &optional INDEX

Decodes an unsigned 8 byte integer stored as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: decode-uint64le BUFFER &optional INDEX

Decodes an unsigned 8 byte integer stored as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: decode-uint8be BUFFER &optional INDEX

Decodes an unsigned 1 byte integer stored as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: decode-uint8le BUFFER &optional INDEX

Decodes an unsigned 1 byte integer stored as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: default-float-parser FIELD-NAME STR &key START END NULL-STR

Returns a float parsed from simple-base-string record STR between START and END, or NIL if STR is STRING= to NULL-STR between START and END.

Package

uk.co.deoxybyte-io

Source

simple-table-parser.lisp (file)

Function: default-integer-parser FIELD-NAME STR &key START END NULL-STR

Returns an integer parsed from simple-base-string record STR between START and END, or NIL if STR is STRING= to NULL-STR between START and END.

Package

uk.co.deoxybyte-io

Source

simple-table-parser.lisp (file)

Function: delete-tmp-directory CONDITION

Invokes the DELETE-TMP-DIRECTORY restart, if established.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)

Function: delete-tmp-pathname CONDITION

Invokes the DELETE-TMP-PATHNAME restart, if established.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)

Function: directory-pathname PATHNAME

Returns a new pathname that represents the directory component of PATHSPEC.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)

Function: encode-float32be VALUE BUFFER &optional INDEX

Encodes 4 byte float as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: encode-float32le VALUE BUFFER &optional INDEX

Encodes 4 byte float as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: encode-float64be VALUE BUFFER &optional INDEX

Encodes 8 byte float as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: encode-float64le VALUE BUFFER &optional INDEX

Encodes 8 byte float as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: encode-ieee-float32 F

Encodes single-float F as a 32-bit integer using IEEE 754 encoding. NaN, +Inf and -Inf may be represented by using the keywords :not-a-number :positive-infinity or :negative-infinity respectively, as an argument.

Package

uk.co.deoxybyte-io

Source

ieee-float.lisp (file)

Function: encode-ieee-float64 F

Encodes double-float F as a 64-bit integer using IEEE 754 encoding. NaN, +Inf and -Inf may be represented by using the keywords :not-a-number :positive-infinity or :negative-infinity respectively, as an argument.

Package

uk.co.deoxybyte-io

Source

ieee-float.lisp (file)

Function: encode-int16be VALUE BUFFER &optional INDEX

Encodes a 2 byte integer as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: encode-int16le VALUE BUFFER &optional INDEX

Encodes a 2 byte integer as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: encode-int32be VALUE BUFFER &optional INDEX

Encodes a 4 byte integer as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: encode-int32le VALUE BUFFER &optional INDEX

Encodes a 4 byte integer as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: encode-int64be VALUE BUFFER &optional INDEX

Encodes a 8 byte integer as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: encode-int64le VALUE BUFFER &optional INDEX

Encodes a 8 byte integer as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: encode-int8be VALUE BUFFER &optional INDEX

Encodes a 1 byte integer as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: encode-int8le VALUE BUFFER &optional INDEX

Encodes a 1 byte integer as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: encode-uint16be VALUE BUFFER &optional INDEX

Encodes a 2 byte integer as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: encode-uint16le VALUE BUFFER &optional INDEX

Encodes a 2 byte integer as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: encode-uint32be VALUE BUFFER &optional INDEX

Encodes a 4 byte integer as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: encode-uint32le VALUE BUFFER &optional INDEX

Encodes a 4 byte integer as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: encode-uint64be VALUE BUFFER &optional INDEX

Encodes a 8 byte integer as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: encode-uint64le VALUE BUFFER &optional INDEX

Encodes a 8 byte integer as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: encode-uint8be VALUE BUFFER &optional INDEX

Encodes a 1 byte integer as consecutive bytes in BUFFER, in big-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: encode-uint8le VALUE BUFFER &optional INDEX

Encodes a 1 byte integer as consecutive bytes in BUFFER, in little-endian byte order, starting at INDEX.

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Function: ensure-file-exists FILESPEC

Creates the file designated by FILESPEC, if it does not exist. Returns the pathname of FILESPEC.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)

Function: environment-variable VARIABLE-NAME

Returns the string value of VARIABLE-NAME, or NIL.

Package

uk.co.deoxybyte-io

Source

sbcl.lisp (file)

Writer

(setf environment-variable) (function)

Function: (setf environment-variable) VALUE VARIABLE-NAME

Sets the value of VARIABLE-NAME to VALUE, which maye be a string or a symbol.

Package

uk.co.deoxybyte-io

Source

sbcl.lisp (file)

Reader

environment-variable (function)

Function: file-pathname PATHNAME

Returns a new pathname that represents the file component of PATHSPEC.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)

Function: leaf-directory-pathname PATHNAME

Returns a new relative pathname that represents the leaf directory component of PATHSPEC.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)

Function: leave-tmp-directory CONDITION

Invokes the LEAVE-TMP-DIRECTORY restart, if established.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)

Function: leave-tmp-pathname CONDITION

Invokes the LEAVE-TMP-PATHNAME restart, if established.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)

Function: make-tmp-directory &key TMPDIR BASENAME IF-EXISTS MODE

Creates a new temporary directory and returns its pathname. The new directory’s pathname is created using {defun tmp-pathname} . The IF-EXISTS keyword argument determines what happens if a directory by that name already exists; options are :error which causes a FILE-ERROR to be raised, :supersede which causes the existing directory to be deleted and a new, empty one created and NIL where no directory is created an NIL is returned to indicate failure.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)

Function: option-value KEY PARSED-ARGS &optional DEFAULT

Returns the value from alist PARSED-ARGS for the option named by the symbol KEY.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Function: parse-float STRING &key START END RADIX JUNK-ALLOWED

Converts a substring of STRING, as delimited by START and END, to a floating point number, if possible. START and END default to the beginning and end of the string. RADIX must be between 2 and 36.
A floating point number will be returned if the string consists of an optional string of spaces and an optional sign, followed by a string of digits optionally containing a decimal point, and an optional e or E followed by an optionally signed integer. The use of e/E to indicate an exponent only works for RADIX = 10. Returns the floating point number, if any, and the index for the first character after the number.

Package

uk.co.deoxybyte-io

Source

parse-float.lisp (file)

Function: pathname-extender PATHNAME &key TYPE SEPARATOR GENERATOR

Returns a function of zero arity that returns modified copies of a pathname argument. The pathname is modified by extending its namestring. The new namestring is composed of the original namestring SEPARATOR (defaults to NIL) and a value taken from calling the function GENERATOR (defaults to a numeric generator starting from 0, incrementing by 1). TYPE may be used to specify the type of the new pathname, otherwise the original type will be used.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)

Function: pathname-generator DIRECTORY NAME &key TYPE SEPARATOR GENERATOR

Returns a function of zero arity that generates pathnames when called. The generated pathnames are relative to DIRECTORY and have a namestring composed of NAME, SEPARATOR (defaults to NIL) and a value taken from calling the function GENERATOR (defaults to a numeric generator starting from 0, incrementing by 1). TYPE may be used to specify the type of the new pathnames.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)

Function: pathstring PATHNAME

Returns a string representing PATHNAME. This function is similar to CL:NAMESTRING, but is designed to be portable whereas the return value of CL:NAMESTRING is implementation-dependent.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)

Function: print-backtrace STREAM &optional DEPTH
Package

uk.co.deoxybyte-io

Source

sbcl.lisp (file)

Function: quit-lisp &key STATUS
Package

uk.co.deoxybyte-io

Source

sbcl.lisp (file)

Function: relative-pathname-p PATHNAME

Returns T if PATHSPEC is a pathname designator for a relative file or directory, or NIL otherwise.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)

Function: tmp-pathname &key TMPDIR BASENAME TYPE

Returns a pathname suitable for use as a temporary file or directory. The directory component of the new pathname is TMPDIR, defaulting to *DEFAULT-TMPDIR*. The NAME component of the new pathname is a concatenation of BASENAME, defaulting to an empty string, and a pseudo-random number. The type component of the new pathname is TYPE, defaulting to NIL.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)


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

6.1.4 Generic functions

Generic Function: boolean-option-p OPTION

Returns T if OPTION does not require a value, or NIL otherwise.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Methods
Method: boolean-option-p (OPTION cli-option)
Generic Function: cli-help CLI &optional STREAM

Prints the help string for CLI to STREAM (which
defaults to *ERROR-OUTPUT*). This is usually the class documentation string of CLI, plus all of the option help.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Methods
Method: cli-help (CLI cli) &optional STREAM
Generic Function: documentation-of CLI &optional NAME

Returns documentation of CLI or a CLI option identified by NAME.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Methods
Method: documentation-of (CLI cli) &optional NAME
Generic Function: external-merge-sort SORT-INPUT-STREAM SORT-OUTPUT-STREAM PREDICATE &key KEY BUFFER-SIZE

Performs an external merge sort on the elements
read from SORT-INPUT-STREAM and writes the sorted elements to SORT-OUTPUT-STREAM.

Arguments:

- sort-input-stream (sort-input-stream): The stream whose elements are to be sorted.
- sort-output-stream (sort-output-stream): A stream whose elements are sorted.

- predicate (function designator): The sorting predicate, as in CL:SORT, a function of two arguments that returns a generalized boolean.

Key:

- key (function designator): A function of one argument, or nil.

- buffer-size (fixnum): The size of the in-memory sort buffer and hence the number of elements written to disk in the external merge file.

Returns:

- The total number of elements sorted (fixnum).
- The number of {defclass merge-stream} s used in sorting (fixnum).

Package

uk.co.deoxybyte-io

Source

external-merge-sort.lisp (file)

Methods
Method: external-merge-sort (IN sort-input-stream) (OUT sort-output-stream) PREDICATE &key KEY BUFFER-SIZE
Generic Function: field-of CONDITION
Package

uk.co.deoxybyte-io

Methods
Method: field-of (CONDITION malformed-field-error)
Source

conditions.lisp (file)

Generic Function: find-line LINE-INPUT-STREAM TEST &optional MAX-LINES

Iterates through lines read from LINE-INPUT-STREAM
until a line matching predicate TEST is found or until a number of lines equal to MAX-LINES have been examined.

Package

uk.co.deoxybyte-io

Source

line-stream.lisp (file)

Methods
Method: find-line (STREAM line-input-stream) TEST &optional MAX-LINES
Generic Function: help-message CLI MESSAGE &optional STREAM

Prints a help MESSAGE and help for each avaliable option in CLI to STREAM.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Methods
Method: help-message (CLI cli) (MESSAGE string) &optional STREAM
Generic Function: line-stack-of OBJECT
Generic Function: (setf line-stack-of) NEW-VALUE OBJECT
Package

uk.co.deoxybyte-io

Methods
Method: line-stack-of (LINE-INPUT-STREAM line-input-stream)
Method: (setf line-stack-of) NEW-VALUE (LINE-INPUT-STREAM line-input-stream)

A list of lines that have been pushed back into the stream to be read again.

Source

line-stream.lisp (file)

Generic Function: make-line-stream STREAM

Returns a new {defclass line-stream} created from STREAM.

Package

uk.co.deoxybyte-io

Source

line-stream.lisp (file)

Methods
Method: make-line-stream (STREAM stream)
Generic Function: make-merge-stream SORT-INPUT-STREAM PREDICATE &key KEY BUFFER-SIZE

Returns a new {defclass merge-stream} appropriate
to SORT-INPUT-STREAM. The new stream must return sorted elements read from SORT-INPUT-STREAM.

Arguments:

- sort-input-stream (sort-input-stream): The stream whose elements are to be sorted.

- predicate (function designator): The sorting predicate, as in CL:SORT, a function of two arguments that returns a generalized boolean.

Key:

- key (function designator): A function of one argument, or nil.

- buffer-size (fixnum): The size of the in-memory sort buffer and hence the number of elements written to disk in the external merge file.

Returns:

- a {defclass merge-stream} from which sorted elements may be read.

Package

uk.co.deoxybyte-io

Source

external-merge-sort.lisp (file)

Methods
Method: make-merge-stream (STREAM line-sort-input-stream) PREDICATE &key KEY BUFFER-SIZE
Source

external-line-sort.lisp (file)

Generic Function: more-lines-p LINE-INPUT-STREAM

Returns T if {defclass line-input-stream} contains unread data.

Package

uk.co.deoxybyte-io

Source

line-stream.lisp (file)

Methods
Method: more-lines-p (STREAM character-line-input-stream)
Method: more-lines-p (STREAM octet-line-input-stream)
Generic Function: name-of CONDITION
Package

uk.co.deoxybyte-io

Methods
Method: name-of (CLI-OPTION cli-option)

The name string of the option.

Source

command-line-interface.lisp (file)

Method: name-of (CONDITION cli-option-warning)
Source

conditions.lisp (file)

Method: name-of (CONDITION cli-option-error)
Source

conditions.lisp (file)

Generic Function: option-help CLI NAME &optional STREAM

Prints the help string for option NAME to STREAM (which defaults to *ERROR-OUTPUT*).

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Methods
Method: option-help (CLI cli) (NAME string) &optional STREAM
Method: option-help (CLI cli) (SLOT symbol) &optional STREAM
Generic Function: option-of CLI NAME

Returns the CLI option identified by NAME.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Methods
Method: option-of (CLI cli) (NAME string)
Method: option-of (CLI cli) (NAME symbol)
Generic Function: option-slot-p CLI SLOT

Returns T if SLOT is an option slot in CLI, or NIL
otherwise. The default implementation returns T, meaning that all slots are expected to contain option objects. Overriding this method means that slots may be added for other purposes.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Methods
Method: option-slot-p (CLI cli) (SLOT symbol)
Generic Function: option-slots-of CLI

Returns a new, sorted list of CLI option slots.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Methods
Method: option-slots-of (CLI cli)
Generic Function: options-of CLI

Returns a new, sorted list of CLI options.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Methods
Method: options-of (CLI cli)
Generic Function: parse-command-line CLI ARGLIST

Parses a system command line to create a mapping of
option keywords to Lisp objects. Where multiple values are to be accepted for an argument e.g. ’integer-list , they must be comma-separated on the command line e.g. 1,2,3,4.

Arguments:

- cli (object): A CLI instance.
- arglist (list string): A list of CLI string arguments.

Returns:

- alist mapping slots to parsed values
- list of unmatched argument strings
- list of unknown argument strings

e.g

;;; (define-cli example-cli (cli)
;;; ((a "a" :required-option t :value-type ’string
;;; :documentation "Required option A.")
;;; (b "b" :required-option t :value-type ’integer
;;; :documentation "Required option D.")
;;; (c "c" :required-option nil :value-type ’string :default "foo" ;;; :documentation "Option C."))
;;; (:documentation "An example CLI class definition."))

;;; (parse-command-line (make-instance ’example-cli)
;;; (list "–a" "aaa" "–b" "1")))

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Methods
Method: parse-command-line (CLI cli) ARGLIST
Generic Function: pop-line LINE-INPUT-STREAM LINE

Pops one line from {defclass line-input-stream} .

Package

uk.co.deoxybyte-io

Source

line-stream.lisp (file)

Methods
Method: pop-line (STREAM line-input-stream) (LINE string)
Generic Function: push-line LINE-INPUT-STREAM LINE

Pushes LINE back onto {defclass line-input-stream} .

Package

uk.co.deoxybyte-io

Source

line-stream.lisp (file)

Methods
Method: push-line (STREAM line-input-stream) (LINE string)
Generic Function: record-of CONDITION
Package

uk.co.deoxybyte-io

Methods
Method: record-of (CONDITION malformed-record-error)
Source

conditions.lisp (file)

Generic Function: required-option-p OBJECT
Package

uk.co.deoxybyte-io

Methods
Method: required-option-p (CLI-OPTION cli-option)

T if option is required on the command line, or NIL otherwise.

Source

command-line-interface.lisp (file)

Generic Function: required-value-p OPTION

Returns T if OPTION requires a value, or NIL otherwise.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Methods
Method: required-value-p (OPTION cli-option)
Generic Function: stream-close STREAM &key ABORT

Closes STREAM, returning T if STREAM was open. If
ABORT is T, attempts to clean up any side effects of having created stream.

Package

uk.co.deoxybyte-io

Source

streams.lisp (file)

Methods
Method: stream-close (STREAM wrapped-stream-mixin) &key ABORT
Generic Function: stream-head-of OBJECT
Generic Function: (setf stream-head-of) NEW-VALUE OBJECT
Package

uk.co.deoxybyte-io

Methods
Method: stream-head-of (MERGE-STREAM merge-stream)
Method: (setf stream-head-of) NEW-VALUE (MERGE-STREAM merge-stream)

Returns the next element from
MERGE-STREAM without removing it. Part of the external merge sort protocol.

Source

external-merge-sort.lisp (file)

Generic Function: stream-merge MERGE-STREAM

Returns the next element from MERGE-STREAM as part
of the a merging operation between several {defclass merge-stream } s.

Package

uk.co.deoxybyte-io

Source

external-merge-sort.lisp (file)

Methods
Method: stream-merge (STREAM line-merge-stream)
Source

external-line-sort.lisp (file)

Generic Function: stream-of OBJECT
Package

uk.co.deoxybyte-io

Methods
Method: stream-of (WRAPPED-STREAM-MIXIN wrapped-stream-mixin)

The underlying stream from which data are read.

Source

streams.lisp (file)

Generic Function: stream-open FILESPEC CLASS &rest INITARGS

Returns a Gray stream of CLASS

Package

uk.co.deoxybyte-io

Source

streams.lisp (file)

Methods
Method: stream-open FILESPEC CLASS &rest INITARGS
Generic Function: stream-read-element SORT-INPUT-STREAM

Returns the next element from SORT-INPUT-STREAM.

Package

uk.co.deoxybyte-io

Source

external-merge-sort.lisp (file)

Methods
Method: stream-read-element (STREAM line-sort-input-stream)
Source

external-line-sort.lisp (file)

Generic Function: stream-write-element ELEMENT SORT-OUTPUT-STREAM

Writes ELEMENT to SORT-OUTPUT-STREAM.

Package

uk.co.deoxybyte-io

Source

external-merge-sort.lisp (file)

Methods
Method: stream-write-element (LINE string) (STREAM line-sort-output-stream)
Source

external-line-sort.lisp (file)

Generic Function: test-of OBJECT
Package

uk.co.deoxybyte-io

Methods
Method: test-of (STREAM-FILTER-MIXIN stream-filter-mixin)

A function designator for a test that returns
T when the next datum read from the stream is to be ignored.

Source

streams.lisp (file)

Generic Function: value-default-of OBJECT
Package

uk.co.deoxybyte-io

Methods
Method: value-default-of (CLI-OPTION cli-option)

A default value of the required value-type.

Source

command-line-interface.lisp (file)

Generic Function: value-parser-of OBJECT
Package

uk.co.deoxybyte-io

Methods
Method: value-parser-of (CLI-OPTION cli-option)

A value parser function for option
that is capable of parsing a string to the correct type.

Source

command-line-interface.lisp (file)

Generic Function: value-type-of OBJECT
Package

uk.co.deoxybyte-io

Methods
Method: value-type-of (CLI-OPTION cli-option)

The type of the value of the option. A
type of T indicates a boolean option. Valid types are the symbols string, integer, character, float, string-list, integer-list, character-list, float-list and T (indicating boolean, i.e. no value).

Source

command-line-interface.lisp (file)


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

6.1.5 Conditions

Condition: cli-error ()

The parent type of all CLI error conditions.

Package

uk.co.deoxybyte-io

Source

conditions.lisp (file)

Direct superclasses

error (condition)

Direct subclasses
Direct methods

cli-of (method)

Direct slots
Slot: cli

The CLI object relevant to the error.

Initargs

:cli

Initform

(quote nil)

Readers

cli-of (generic function)

Condition: cli-option-error ()

The parent type of all CLI option error conditions.

Package

uk.co.deoxybyte-io

Source

conditions.lisp (file)

Direct superclasses

cli-error (condition)

Direct subclasses
Direct methods

name-of (method)

Direct slots
Slot: name

The option name.

Initargs

:name

Readers

name-of (generic function)

Condition: cli-option-warning ()

The parent type of all CLI option warning conditions.

Package

uk.co.deoxybyte-io

Source

conditions.lisp (file)

Direct superclasses

cli-warning (condition)

Direct subclasses
Direct methods

name-of (method)

Direct slots
Slot: name

The option name.

Initargs

:name

Readers

name-of (generic function)

Condition: cli-warning ()

The parent type of all CLI warning conditions.

Package

uk.co.deoxybyte-io

Source

conditions.lisp (file)

Direct superclasses

warning (condition)

Direct subclasses

cli-option-warning (condition)

Direct methods

cli-of (method)

Direct slots
Slot: cli

The CLI object relevant to the warning.

Initargs

:cli

Initform

(quote nil)

Readers

cli-of (generic function)

Condition: field-validation-error ()

An error that is raised when a record field fails validation.

Package

uk.co.deoxybyte-io

Source

conditions.lisp (file)

Direct superclasses

malformed-field-error (condition)

Condition: general-parse-error ()

The parent type of all parse error conditions.

Package

uk.co.deoxybyte-io

Source

conditions.lisp (file)

Direct superclasses
  • formatted-condition (condition)
  • io-error (condition)
Direct subclasses
Condition: incompatible-value ()

An error that is raised when an option is supplied with an invalid value.

Package

uk.co.deoxybyte-io

Source

conditions.lisp (file)

Direct superclasses

cli-option-error (condition)

Direct methods
Direct slots
Slot: type

The expected type of option value.

Initargs

:type

Readers

type-of (generic function)

Slot: value

The invalid value.

Initargs

:value

Readers

value-of (generic function)

Condition: io-error ()

The parent type of all IO error conditions.

Package

uk.co.deoxybyte-io

Source

conditions.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

general-parse-error (condition)

Condition: io-warning ()

The parent type of all IO warning conditions.

Package

uk.co.deoxybyte-io

Source

conditions.lisp (file)

Direct superclasses

warning (condition)

Condition: malformed-field-error ()

An error that is raised when a field-based record contains a malformed field within it.

Package

uk.co.deoxybyte-io

Source

conditions.lisp (file)

Direct superclasses

malformed-record-error (condition)

Direct subclasses

field-validation-error (condition)

Direct methods

field-of (method)

Direct slots
Slot: field

The malformed field.

Initargs

:field

Initform

(quote nil)

Readers

field-of (generic function)

Condition: malformed-file-error ()

An error that is raised when a file is malformed for any reason.

Package

uk.co.deoxybyte-io

Source

conditions.lisp (file)

Direct superclasses

general-parse-error (condition)

Direct methods

file-of (method)

Direct slots
Slot: file

The malformed file.

Initargs

:file

Initform

(quote nil)

Readers

file-of (generic function)

Condition: malformed-record-error ()

An error that is raised when a record is malformed for any reason.

Package

uk.co.deoxybyte-io

Source

conditions.lisp (file)

Direct superclasses

general-parse-error (condition)

Direct subclasses
Direct methods

record-of (method)

Direct slots
Slot: record

The malformed record.

Initargs

:record

Initform

(quote nil)

Readers

record-of (generic function)

Condition: missing-required-option ()

An error that is raised when a required option is missing.

Package

uk.co.deoxybyte-io

Source

conditions.lisp (file)

Direct superclasses

cli-option-error (condition)

Condition: missing-required-value ()

An error that is raised when a required value for an option is missing.

Package

uk.co.deoxybyte-io

Source

conditions.lisp (file)

Direct superclasses

cli-option-error (condition)

Condition: record-validation-error ()

An error that is raised when a record fails validation of one or more of its parts.

Package

uk.co.deoxybyte-io

Source

conditions.lisp (file)

Direct superclasses

malformed-record-error (condition)

Condition: unknown-command ()

An error that is raised when the main command is not recognised.

Package

uk.co.deoxybyte-io

Source

conditions.lisp (file)

Direct superclasses

cli-error (condition)

Direct methods

command-of (method)

Direct slots
Slot: command

The unknown command.

Initargs

:command

Readers

command-of (generic function)

Condition: unknown-option ()
Package

uk.co.deoxybyte-io

Source

conditions.lisp (file)

Direct superclasses

cli-option-warning (condition)

Condition: unmatched-option ()
Package

uk.co.deoxybyte-io

Source

conditions.lisp (file)

Direct superclasses

cli-option-warning (condition)


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

6.1.6 Classes

Class: character-line-input-stream ()
Package

uk.co.deoxybyte-io

Source

line-stream.lisp (file)

Direct superclasses
Direct methods
  • stream-read-sequence (method)
  • stream-read-line (method)
  • stream-clear-input (method)
  • stream-file-position (method)
  • stream-element-type (method)
  • more-lines-p (method)
Class: cli ()

The base class of all command line
interfaces. Command line options are added as slots, the slot documentation acting as the coomand line option documentation.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Class: cli-option ()

The base class of all command line options.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: name

The name string of the option.

Initargs

:name

Initform

(error "an option name is required")

Readers

name-of (generic function)

Slot: required-option

T if option is required on the command line, or NIL otherwise.

Initargs

:required-option

Readers

required-option-p (generic function)

Slot: value-type

The type of the value of the option. A
type of T indicates a boolean option. Valid types are the symbols string, integer, character, float, string-list, integer-list, character-list, float-list and T (indicating boolean, i.e. no value).

Initargs

:value-type

Initform

(quote string)

Readers

value-type-of (generic function)

Slot: value-parser

A value parser function for option
that is capable of parsing a string to the correct type.

Readers

value-parser-of (generic function)

Slot: value-default

A default value of the required value-type.

Initargs

:value-default

Readers

value-default-of (generic function)

Class: io-stream-mixin ()
Package

uk.co.deoxybyte-io

Source

streams.lisp (file)

Direct superclasses
  • fundamental-output-stream (class)
  • fundamental-input-stream (class)
Direct subclasses

merge-stream (class)

Direct methods
  • stream-force-output (method)
  • stream-finish-output (method)
  • stream-clear-output (method)
  • stream-clear-input (method)
Class: line-input-stream ()

A line-based stream that allows lines to be pushed back into a stack to be re-read.

Package

uk.co.deoxybyte-io

Source

line-stream.lisp (file)

Direct superclasses
Direct subclasses
Direct methods
Direct slots
Slot: line-stack

A list of lines that have been pushed back into the stream to be read again.

Readers

line-stack-of (generic function)

Writers

(setf line-stack-of) (generic function)

Class: line-merge-stream ()
Package

uk.co.deoxybyte-io

Source

external-line-sort.lisp (file)

Direct superclasses
Direct methods
Class: line-output-stream ()
Package

uk.co.deoxybyte-io

Source

line-stream.lisp (file)

Direct superclasses
  • fundamental-output-stream (class)
  • line-stream (class)
Direct subclasses
Direct methods

stream-write-sequence (method)

Class: line-sort-input-stream ()
Package

uk.co.deoxybyte-io

Source

external-line-sort.lisp (file)

Direct superclasses
Direct methods
Class: line-sort-output-stream ()
Package

uk.co.deoxybyte-io

Source

external-line-sort.lisp (file)

Direct superclasses
Direct methods

stream-write-element (method)

Class: line-stream ()

A line-based stream. Useful for building readers and writers for ad-hoc text data sources.

Package

uk.co.deoxybyte-io

Source

line-stream.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods

stream-element-type (method)

Class: merge-stream ()

An IO stream for merging sorted data.

Package

uk.co.deoxybyte-io

Source

external-merge-sort.lisp (file)

Direct superclasses

io-stream-mixin (class)

Direct subclasses

line-merge-stream (class)

Direct methods
Direct slots
Slot: stream-head

Returns the next element from
MERGE-STREAM without removing it. Part of the external merge sort protocol.

Initargs

:stream-head

Readers

stream-head-of (generic function)

Writers

(setf stream-head-of) (generic function)

Class: octet-line-input-stream ()

A {defclass line-input-stream} whose lines are
arrays of bytes. Allows buffered reading of lines of (unsigned-byte 8) from a stream.

Package

uk.co.deoxybyte-io

Source

line-stream.lisp (file)

Direct superclasses
Direct methods
  • stream-read-sequence (method)
  • stream-read-line (method)
  • stream-clear-input (method)
  • stream-file-position (method)
  • stream-element-type (method)
  • more-lines-p (method)
Direct slots
Slot: buffer

The buffer from which lines are read.

Initargs

:buffer

Initform

(make-array uk.co.deoxybyte-io::+octet-buffer-size+ :element-type (quote uk.co.deoxybyte-utilities:octet) :initial-element 0)

Slot: eol-code

The end of line character code. If two characters are used, this is the first of the pair.

Initargs

:eol-code

Initform

(char-code #\newline)

Slot: num-bytes

The number of bytes that were read into the buffer from the stream.

Initform

0

Slot: offset

The offset in the byte buffer from which the next byte is to be read.

Initform

0

Class: sort-input-stream ()

An input stream for reading and sorting the stream contents.

Package

uk.co.deoxybyte-io

Source

external-merge-sort.lisp (file)

Direct superclasses

fundamental-input-stream (class)

Direct subclasses

line-sort-input-stream (class)

Direct methods

external-merge-sort (method)

Class: sort-output-stream ()

An output stream for sorting and writing the stream contents.

Package

uk.co.deoxybyte-io

Source

external-merge-sort.lisp (file)

Direct superclasses

fundamental-output-stream (class)

Direct subclasses

line-sort-output-stream (class)

Direct methods

external-merge-sort (method)

Class: stream-filter-mixin ()

A mixin that provides a filtering function for
streams. Any data encountered while reading or writing for which the test returns T are ignored and skipped.

Package

uk.co.deoxybyte-io

Source

streams.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

test-of (method)

Direct slots
Slot: test

A function designator for a test that returns
T when the next datum read from the stream is to be ignored.

Initargs

:test

Readers

test-of (generic function)

Class: wrapped-stream-mixin ()

A Gray-stream wrapping a standard Lisp stream.

Package

uk.co.deoxybyte-io

Source

streams.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: stream

The underlying stream from which data are read.

Initargs

:stream

Readers

stream-of (generic function)


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

6.2 Internal definitions


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

6.2.1 Constants

Constant: +exponent-bias-32+

Exponent bias for float32

Package

uk.co.deoxybyte-io

Source

ieee-float.lisp (file)

Constant: +exponent-bias-64+

Exponent bias for float64

Package

uk.co.deoxybyte-io

Source

ieee-float.lisp (file)

Constant: +frac-factor-32+

Mantissa fraction float32 multiplication factor

Package

uk.co.deoxybyte-io

Source

ieee-float.lisp (file)

Constant: +frac-factor-64+

Mantissa fraction float64 multiplication factor

Package

uk.co.deoxybyte-io

Source

ieee-float.lisp (file)

Constant: +min-norm-exponent-32+

Smallest normalized float32 exponent

Package

uk.co.deoxybyte-io

Source

ieee-float.lisp (file)

Constant: +min-norm-exponent-64+

Smallest normalized float64 exponent

Package

uk.co.deoxybyte-io

Source

ieee-float.lisp (file)

Constant: +negative-infinity-32+
Package

uk.co.deoxybyte-io

Source

ieee-float.lisp (file)

Constant: +negative-infinity-64+
Package

uk.co.deoxybyte-io

Source

ieee-float.lisp (file)

Constant: +not-a-number-32+
Package

uk.co.deoxybyte-io

Source

ieee-float.lisp (file)

Constant: +not-a-number-64+
Package

uk.co.deoxybyte-io

Source

ieee-float.lisp (file)

Constant: +octet-buffer-size+

Buffer size for {defclass octet-line-input-stream} internal buffer.

Package

uk.co.deoxybyte-io

Source

line-stream.lisp (file)

Constant: +positive-infinity-32+
Package

uk.co.deoxybyte-io

Source

ieee-float.lisp (file)

Constant: +positive-infinity-64+
Package

uk.co.deoxybyte-io

Source

ieee-float.lisp (file)


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

6.2.2 Special variables

Special Variable: *list-separator-char*

The separator character used in multi-value arguments.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Special Variable: *whitespace-chars*
Package

uk.co.deoxybyte-io

Source

parse-float.lisp (file)


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

6.2.3 Macros

Macro: define-float-decoder NAME &key BYTES ORDER

Defines a function NAME with one mandatory argument, a simple-array of unsigned-byte 8, and one optional argument, a fixnum index in that array that defaults to 0. The function returns the Lisp float whose value is given by the bytes at that index in the byte array.

Key:

- bytes (fixnum): the number of bytes that comprise the number.
- order (sumbol): the byte order of the array, may be one
of :little-endian or :big-endian ( :network-byte-order may be used as a synonym for :big-endian ).

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)

Macro: define-float-encoder NAME &key BYTES ORDER

Defines a function NAME with two mandatory arguments, a float and a simple-array of unsigned-byte 8, and one optional argument, a fixnum index in that array that defaults to 0. The function returns the buffer containing the encoded float.

Key:

- bytes (fixnum): the number of bytes that comprise the number. - order (sumbol): the byte order of the array, may be one
of :little-endian or :big-endian ( :network-byte-order may be used as a synonym for :big-endian ).

Package

uk.co.deoxybyte-io

Source

binary-operations.lisp (file)


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

6.2.4 Functions

Function: %stream-read-sequence STREAM SEQUENCE START END
Package

uk.co.deoxybyte-io

Source

line-stream.lisp (file)

Function: %stream-write-sequence STREAM SEQUENCE START END
Package

uk.co.deoxybyte-io

Source

line-stream.lisp (file)

Function: collect-constraint-args FORM

Returns an argument list form to be used by CROSS-VALIDATE by quoting the field-names in FORM and re-ordering the elements.

Package

uk.co.deoxybyte-io

Source

simple-table-parser.lisp (file)

Function: collect-parser-args FIELD

Returns an argument list form for FIELD to be used by PARSE-FIELD which has suitable parsers and validators set up for the standard field types: :string , :integer and :float .

Package

uk.co.deoxybyte-io

Source

simple-table-parser.lisp (file)

Function: default-string-parser FIELD-NAME STR &key START END NULL-STR

Returns a string subsequence from simple-string record STR between START and END, or NIL if STR is STRING= to NULL-STR between START and END.

Package

uk.co.deoxybyte-io

Source

simple-table-parser.lisp (file)

Function: default-validator VALUE

The default validator always returns T.

Package

uk.co.deoxybyte-io

Source

simple-table-parser.lisp (file)

Function: get-system-argv ()
Package

uk.co.deoxybyte-io

Source

sbcl.lisp (file)

Function: key-string OPTION
Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Function: merge-element MERGE-STREAMS PREDICATE KEY

Returns the next element from one of MERGE-STREAMS. The returned element is the on that sorts first according to PREDICATE and KEY, as required by the merge-sort algorithm.

Package

uk.co.deoxybyte-io

Source

external-merge-sort.lisp (file)

Function: merge-pathstrings PATHNAME &optional DEFAULT-PATHNAME DEFAULT-VERSION

Merges PATHNAME with defaults, using CL:MERGE-PATHNAMES, and calls {defun pathstring} on the result.

Package

uk.co.deoxybyte-io

Source

files-and-directories.lisp (file)

Function: normalise-whitespace STR
Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Function: parse-character STRING

Returns a character parsed from STRING of length 1 character.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Function: parse-character-list STRING

Returns a list of integers parsed from STRING after splitting on the *list-separator-char* character.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Function: parse-field FIELD-NAME LINE START END NULL-STR PARSER &optional VALIDATOR

Returns a value parsed from LINE between START and END using PARSER and VALIDATOR.

Package

uk.co.deoxybyte-io

Source

simple-table-parser.lisp (file)

Function: parse-float-list STRING

Returns a list of floats parsed from STRING after splitting on the *list-separator-char* character.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Function: parse-integer-list STRING

Returns a list of integers parsed from STRING after splitting on the *list-separator-char* character.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Function: parse-string-list STRING

Returns a list of strings parsed from STRING by splitting on the *list-separator-char* character.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Function: print-error-message CONDITION &optional STREAM
Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Function: read-octet-line STREAM

Reads chunks of bytes up to the next newline or end of stream, returning them in a list. The newline is not included. Returns two values - a list of chunks and either NIL or T to indicate whether a terminating newline was missing. When the stream underlying the buffer is exhausted the list of chunks will be empty.

Package

uk.co.deoxybyte-io

Source

line-stream.lisp (file)

Function: signal-malformed-field FIELD STR START END REASON

Signals a MALFORMED-FIELD-ERROR for FIELD in STR between START and END for REASON.

Package

uk.co.deoxybyte-io

Source

simple-table-parser.lisp (file)

Function: subst-chars STR CHAR &rest CHARS

Returns a copy of STR where any occurrence of CHARS are substituted by CHAR.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Function: validate-record NAME FIELDS VALIDATOR &rest FIELD-NAMES

Returns a pair of constraint NAME and either T or NIL, indicating the result of applying VALIDATOR to values from the alist of parsed FIELDS named by FIELD-NAMES.

Package

uk.co.deoxybyte-io

Source

simple-table-parser.lisp (file)

Function: value-type-string OPTION
Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Function: whitespacep CHAR
Package

uk.co.deoxybyte-io

Source

parse-float.lisp (file)

Function: wrap-string STR &optional STREAM

Format STR, wrapped at 70 characters, to STREAM.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)


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

6.2.5 Generic functions

Generic Function: cli-of CONDITION
Package

uk.co.deoxybyte-io

Methods
Method: cli-of (CONDITION cli-warning)
Source

conditions.lisp (file)

Method: cli-of (CONDITION cli-error)
Source

conditions.lisp (file)

Generic Function: command-of CONDITION
Package

uk.co.deoxybyte-io

Methods
Method: command-of (CONDITION unknown-command)
Source

conditions.lisp (file)

Generic Function: file-of CONDITION
Package

uk.co.deoxybyte-io

Methods
Method: file-of (CONDITION malformed-file-error)
Source

conditions.lisp (file)

Generic Function: find-option-slot CLI NAME

Returns the slot named NAME from CLI.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Methods
Method: find-option-slot (CLI cli) (NAME string)
Generic Function: parse-safely CLI OPTION VALUE

Returns a parsed VALUE of the correct Lisp type for
OPTION or raises an {define-condition incompatible-argument} error.

Package

uk.co.deoxybyte-io

Source

command-line-interface.lisp (file)

Methods
Method: parse-safely (CLI cli) (OPTION cli-option) VALUE
Generic Function: stream-delete-file STREAM

Equivalent to CL:DELETE-FILE.

Package

uk.co.deoxybyte-io

Source

streams.lisp (file)

Methods
Method: stream-delete-file (STREAM merge-stream)
Source

external-merge-sort.lisp (file)

Method: stream-delete-file (STREAM wrapped-stream-mixin)
Generic Function: stream-write-line STRING STREAM &optional START END
Package

uk.co.deoxybyte-io

Source

line-stream.lisp (file)

Methods
Method: stream-write-line (STR string) (STREAM character-line-output-stream) &optional START END
Method: stream-write-line (STR string) (STREAM octet-line-output-stream) &optional START END
Generic Function: type-of CONDITION
Package

uk.co.deoxybyte-io

Methods
Method: type-of (CONDITION incompatible-value)
Source

conditions.lisp (file)

Generic Function: value-of CONDITION
Package

uk.co.deoxybyte-io

Methods
Method: value-of (CONDITION incompatible-value)
Source

conditions.lisp (file)


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

6.2.6 Classes

Class: character-line-output-stream ()
Package

uk.co.deoxybyte-io

Source

line-stream.lisp (file)

Direct superclasses

line-output-stream (class)

Direct methods

stream-write-line (method)

Class: octet-line-output-stream ()
Package

uk.co.deoxybyte-io

Source

line-stream.lisp (file)

Direct superclasses

line-output-stream (class)

Direct methods

stream-write-line (method)


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

6.2.7 Types

Type: octet-buffer ()

Buffer type for {defclass octet-line-input-stream} internal buffer.

Package

uk.co.deoxybyte-io

Source

line-stream.lisp (file)

Type: octet-buffer-index ()

Index type for {defclass octet-line-input-stream} internal buffer.

Package

uk.co.deoxybyte-io

Source

line-stream.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   D   F   L   M  
Index Entry  Section

D
deoxybyte-io.asd: The deoxybyte-io․asd file
deoxybyte-io/core: The deoxybyte-io/core module
deoxybyte-io/core/binary-operations.lisp: The deoxybyte-io/core/binary-operations․lisp file
deoxybyte-io/core/command-line-interface.lisp: The deoxybyte-io/core/command-line-interface․lisp file
deoxybyte-io/core/conditions.lisp: The deoxybyte-io/core/conditions․lisp file
deoxybyte-io/core/deoxybyte-io.lisp: The deoxybyte-io/core/deoxybyte-io․lisp file
deoxybyte-io/core/environment.lisp: The deoxybyte-io/core/environment․lisp file
deoxybyte-io/core/external-line-sort.lisp: The deoxybyte-io/core/external-line-sort․lisp file
deoxybyte-io/core/external-merge-sort.lisp: The deoxybyte-io/core/external-merge-sort․lisp file
deoxybyte-io/core/files-and-directories.lisp: The deoxybyte-io/core/files-and-directories․lisp file
deoxybyte-io/core/ieee-float.lisp: The deoxybyte-io/core/ieee-float․lisp file
deoxybyte-io/core/line-stream.lisp: The deoxybyte-io/core/line-stream․lisp file
deoxybyte-io/core/package.lisp: The deoxybyte-io/core/package․lisp file
deoxybyte-io/core/parse-float.lisp: The deoxybyte-io/core/parse-float․lisp file
deoxybyte-io/core/sbcl.lisp: The deoxybyte-io/core/sbcl․lisp file
deoxybyte-io/core/simple-table-parser.lisp: The deoxybyte-io/core/simple-table-parser․lisp file
deoxybyte-io/core/streams.lisp: The deoxybyte-io/core/streams․lisp file

F
File, Lisp, deoxybyte-io.asd: The deoxybyte-io․asd file
File, Lisp, deoxybyte-io/core/binary-operations.lisp: The deoxybyte-io/core/binary-operations․lisp file
File, Lisp, deoxybyte-io/core/command-line-interface.lisp: The deoxybyte-io/core/command-line-interface․lisp file
File, Lisp, deoxybyte-io/core/conditions.lisp: The deoxybyte-io/core/conditions․lisp file
File, Lisp, deoxybyte-io/core/deoxybyte-io.lisp: The deoxybyte-io/core/deoxybyte-io․lisp file
File, Lisp, deoxybyte-io/core/environment.lisp: The deoxybyte-io/core/environment․lisp file
File, Lisp, deoxybyte-io/core/external-line-sort.lisp: The deoxybyte-io/core/external-line-sort․lisp file
File, Lisp, deoxybyte-io/core/external-merge-sort.lisp: The deoxybyte-io/core/external-merge-sort․lisp file
File, Lisp, deoxybyte-io/core/files-and-directories.lisp: The deoxybyte-io/core/files-and-directories․lisp file
File, Lisp, deoxybyte-io/core/ieee-float.lisp: The deoxybyte-io/core/ieee-float․lisp file
File, Lisp, deoxybyte-io/core/line-stream.lisp: The deoxybyte-io/core/line-stream․lisp file
File, Lisp, deoxybyte-io/core/package.lisp: The deoxybyte-io/core/package․lisp file
File, Lisp, deoxybyte-io/core/parse-float.lisp: The deoxybyte-io/core/parse-float․lisp file
File, Lisp, deoxybyte-io/core/sbcl.lisp: The deoxybyte-io/core/sbcl․lisp file
File, Lisp, deoxybyte-io/core/simple-table-parser.lisp: The deoxybyte-io/core/simple-table-parser․lisp file
File, Lisp, deoxybyte-io/core/streams.lisp: The deoxybyte-io/core/streams․lisp file

L
Lisp File, deoxybyte-io.asd: The deoxybyte-io․asd file
Lisp File, deoxybyte-io/core/binary-operations.lisp: The deoxybyte-io/core/binary-operations․lisp file
Lisp File, deoxybyte-io/core/command-line-interface.lisp: The deoxybyte-io/core/command-line-interface․lisp file
Lisp File, deoxybyte-io/core/conditions.lisp: The deoxybyte-io/core/conditions․lisp file
Lisp File, deoxybyte-io/core/deoxybyte-io.lisp: The deoxybyte-io/core/deoxybyte-io․lisp file
Lisp File, deoxybyte-io/core/environment.lisp: The deoxybyte-io/core/environment․lisp file
Lisp File, deoxybyte-io/core/external-line-sort.lisp: The deoxybyte-io/core/external-line-sort․lisp file
Lisp File, deoxybyte-io/core/external-merge-sort.lisp: The deoxybyte-io/core/external-merge-sort․lisp file
Lisp File, deoxybyte-io/core/files-and-directories.lisp: The deoxybyte-io/core/files-and-directories․lisp file
Lisp File, deoxybyte-io/core/ieee-float.lisp: The deoxybyte-io/core/ieee-float․lisp file
Lisp File, deoxybyte-io/core/line-stream.lisp: The deoxybyte-io/core/line-stream․lisp file
Lisp File, deoxybyte-io/core/package.lisp: The deoxybyte-io/core/package․lisp file
Lisp File, deoxybyte-io/core/parse-float.lisp: The deoxybyte-io/core/parse-float․lisp file
Lisp File, deoxybyte-io/core/sbcl.lisp: The deoxybyte-io/core/sbcl․lisp file
Lisp File, deoxybyte-io/core/simple-table-parser.lisp: The deoxybyte-io/core/simple-table-parser․lisp file
Lisp File, deoxybyte-io/core/streams.lisp: The deoxybyte-io/core/streams․lisp file

M
Module, deoxybyte-io/core: The deoxybyte-io/core module

Jump to:   D   F   L   M  

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

A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   K   L   M   N   O   P   Q   R   S   T   V   W  
Index Entry  Section

%
%stream-read-sequence: Internal functions
%stream-write-sequence: Internal functions

(
(setf environment-variable): Exported functions
(setf line-stack-of): Exported generic functions
(setf line-stack-of): Exported generic functions
(setf stream-head-of): Exported generic functions
(setf stream-head-of): Exported generic functions

A
absolute-pathname-p: Exported functions

B
boolean-option-p: Exported generic functions
boolean-option-p: Exported generic functions

C
check-field: Exported macros
check-record: Exported macros
cli-help: Exported generic functions
cli-help: Exported generic functions
cli-of: Internal generic functions
cli-of: Internal generic functions
cli-of: Internal generic functions
collect-constraint-args: Internal functions
collect-parser-args: Internal functions
command-of: Internal generic functions
command-of: Internal generic functions

D
decode-float32be: Exported functions
decode-float32le: Exported functions
decode-float64be: Exported functions
decode-float64le: Exported functions
decode-ieee-float32: Exported functions
decode-ieee-float64: Exported functions
decode-int16be: Exported functions
decode-int16le: Exported functions
decode-int32be: Exported functions
decode-int32le: Exported functions
decode-int64be: Exported functions
decode-int64le: Exported functions
decode-int8be: Exported functions
decode-int8le: Exported functions
decode-uint16be: Exported functions
decode-uint16le: Exported functions
decode-uint32be: Exported functions
decode-uint32le: Exported functions
decode-uint64be: Exported functions
decode-uint64le: Exported functions
decode-uint8be: Exported functions
decode-uint8le: Exported functions
default-float-parser: Exported functions
default-integer-parser: Exported functions
default-string-parser: Internal functions
default-validator: Internal functions
define-cli: Exported macros
define-float-decoder: Internal macros
define-float-encoder: Internal macros
define-integer-decoder: Exported macros
define-integer-encoder: Exported macros
define-line-parser: Exported macros
delete-tmp-directory: Exported functions
delete-tmp-pathname: Exported functions
directory-pathname: Exported functions
documentation-of: Exported generic functions
documentation-of: Exported generic functions

E
encode-float32be: Exported functions
encode-float32le: Exported functions
encode-float64be: Exported functions
encode-float64le: Exported functions
encode-ieee-float32: Exported functions
encode-ieee-float64: Exported functions
encode-int16be: Exported functions
encode-int16le: Exported functions
encode-int32be: Exported functions
encode-int32le: Exported functions
encode-int64be: Exported functions
encode-int64le: Exported functions
encode-int8be: Exported functions
encode-int8le: Exported functions
encode-uint16be: Exported functions
encode-uint16le: Exported functions
encode-uint32be: Exported functions
encode-uint32le: Exported functions
encode-uint64be: Exported functions
encode-uint64le: Exported functions
encode-uint8be: Exported functions
encode-uint8le: Exported functions
ensure-file-exists: Exported functions
environment-variable: Exported functions
external-merge-sort: Exported generic functions
external-merge-sort: Exported generic functions

F
field-of: Exported generic functions
field-of: Exported generic functions
file-of: Internal generic functions
file-of: Internal generic functions
file-pathname: Exported functions
find-line: Exported generic functions
find-line: Exported generic functions
find-option-slot: Internal generic functions
find-option-slot: Internal generic functions
Function, %stream-read-sequence: Internal functions
Function, %stream-write-sequence: Internal functions
Function, (setf environment-variable): Exported functions
Function, absolute-pathname-p: Exported functions
Function, collect-constraint-args: Internal functions
Function, collect-parser-args: Internal functions
Function, decode-float32be: Exported functions
Function, decode-float32le: Exported functions
Function, decode-float64be: Exported functions
Function, decode-float64le: Exported functions
Function, decode-ieee-float32: Exported functions
Function, decode-ieee-float64: Exported functions
Function, decode-int16be: Exported functions
Function, decode-int16le: Exported functions
Function, decode-int32be: Exported functions
Function, decode-int32le: Exported functions
Function, decode-int64be: Exported functions
Function, decode-int64le: Exported functions
Function, decode-int8be: Exported functions
Function, decode-int8le: Exported functions
Function, decode-uint16be: Exported functions
Function, decode-uint16le: Exported functions
Function, decode-uint32be: Exported functions
Function, decode-uint32le: Exported functions
Function, decode-uint64be: Exported functions
Function, decode-uint64le: Exported functions
Function, decode-uint8be: Exported functions
Function, decode-uint8le: Exported functions
Function, default-float-parser: Exported functions
Function, default-integer-parser: Exported functions
Function, default-string-parser: Internal functions
Function, default-validator: Internal functions
Function, delete-tmp-directory: Exported functions
Function, delete-tmp-pathname: Exported functions
Function, directory-pathname: Exported functions
Function, encode-float32be: Exported functions
Function, encode-float32le: Exported functions
Function, encode-float64be: Exported functions
Function, encode-float64le: Exported functions
Function, encode-ieee-float32: Exported functions
Function, encode-ieee-float64: Exported functions
Function, encode-int16be: Exported functions
Function, encode-int16le: Exported functions
Function, encode-int32be: Exported functions
Function, encode-int32le: Exported functions
Function, encode-int64be: Exported functions
Function, encode-int64le: Exported functions
Function, encode-int8be: Exported functions
Function, encode-int8le: Exported functions
Function, encode-uint16be: Exported functions
Function, encode-uint16le: Exported functions
Function, encode-uint32be: Exported functions
Function, encode-uint32le: Exported functions
Function, encode-uint64be: Exported functions
Function, encode-uint64le: Exported functions
Function, encode-uint8be: Exported functions
Function, encode-uint8le: Exported functions
Function, ensure-file-exists: Exported functions
Function, environment-variable: Exported functions
Function, file-pathname: Exported functions
Function, get-system-argv: Internal functions
Function, key-string: Internal functions
Function, leaf-directory-pathname: Exported functions
Function, leave-tmp-directory: Exported functions
Function, leave-tmp-pathname: Exported functions
Function, make-tmp-directory: Exported functions
Function, merge-element: Internal functions
Function, merge-pathstrings: Internal functions
Function, normalise-whitespace: Internal functions
Function, option-value: Exported functions
Function, parse-character: Internal functions
Function, parse-character-list: Internal functions
Function, parse-field: Internal functions
Function, parse-float: Exported functions
Function, parse-float-list: Internal functions
Function, parse-integer-list: Internal functions
Function, parse-string-list: Internal functions
Function, pathname-extender: Exported functions
Function, pathname-generator: Exported functions
Function, pathstring: Exported functions
Function, print-backtrace: Exported functions
Function, print-error-message: Internal functions
Function, quit-lisp: Exported functions
Function, read-octet-line: Internal functions
Function, relative-pathname-p: Exported functions
Function, signal-malformed-field: Internal functions
Function, subst-chars: Internal functions
Function, tmp-pathname: Exported functions
Function, validate-record: Internal functions
Function, value-type-string: Internal functions
Function, whitespacep: Internal functions
Function, wrap-string: Internal functions

G
Generic Function, (setf line-stack-of): Exported generic functions
Generic Function, (setf stream-head-of): Exported generic functions
Generic Function, boolean-option-p: Exported generic functions
Generic Function, cli-help: Exported generic functions
Generic Function, cli-of: Internal generic functions
Generic Function, command-of: Internal generic functions
Generic Function, documentation-of: Exported generic functions
Generic Function, external-merge-sort: Exported generic functions
Generic Function, field-of: Exported generic functions
Generic Function, file-of: Internal generic functions
Generic Function, find-line: Exported generic functions
Generic Function, find-option-slot: Internal generic functions
Generic Function, help-message: Exported generic functions
Generic Function, line-stack-of: Exported generic functions
Generic Function, make-line-stream: Exported generic functions
Generic Function, make-merge-stream: Exported generic functions
Generic Function, more-lines-p: Exported generic functions
Generic Function, name-of: Exported generic functions
Generic Function, option-help: Exported generic functions
Generic Function, option-of: Exported generic functions
Generic Function, option-slot-p: Exported generic functions
Generic Function, option-slots-of: Exported generic functions
Generic Function, options-of: Exported generic functions
Generic Function, parse-command-line: Exported generic functions
Generic Function, parse-safely: Internal generic functions
Generic Function, pop-line: Exported generic functions
Generic Function, push-line: Exported generic functions
Generic Function, record-of: Exported generic functions
Generic Function, required-option-p: Exported generic functions
Generic Function, required-value-p: Exported generic functions
Generic Function, stream-close: Exported generic functions
Generic Function, stream-delete-file: Internal generic functions
Generic Function, stream-head-of: Exported generic functions
Generic Function, stream-merge: Exported generic functions
Generic Function, stream-of: Exported generic functions
Generic Function, stream-open: Exported generic functions
Generic Function, stream-read-element: Exported generic functions
Generic Function, stream-write-element: Exported generic functions
Generic Function, stream-write-line: Internal generic functions
Generic Function, test-of: Exported generic functions
Generic Function, type-of: Internal generic functions
Generic Function, value-default-of: Exported generic functions
Generic Function, value-of: Internal generic functions
Generic Function, value-parser-of: Exported generic functions
Generic Function, value-type-of: Exported generic functions
get-system-argv: Internal functions

H
help-message: Exported generic functions
help-message: Exported generic functions

K
key-string: Internal functions

L
leaf-directory-pathname: Exported functions
leave-tmp-directory: Exported functions
leave-tmp-pathname: Exported functions
line-stack-of: Exported generic functions
line-stack-of: Exported generic functions

M
Macro, check-field: Exported macros
Macro, check-record: Exported macros
Macro, define-cli: Exported macros
Macro, define-float-decoder: Internal macros
Macro, define-float-encoder: Internal macros
Macro, define-integer-decoder: Exported macros
Macro, define-integer-encoder: Exported macros
Macro, define-line-parser: Exported macros
Macro, with-argv: Exported macros
Macro, with-tmp-directory: Exported macros
Macro, with-tmp-pathname: Exported macros
make-line-stream: Exported generic functions
make-line-stream: Exported generic functions
make-merge-stream: Exported generic functions
make-merge-stream: Exported generic functions
make-tmp-directory: Exported functions
merge-element: Internal functions
merge-pathstrings: Internal functions
Method, (setf line-stack-of): Exported generic functions
Method, (setf stream-head-of): Exported generic functions
Method, boolean-option-p: Exported generic functions
Method, cli-help: Exported generic functions
Method, cli-of: Internal generic functions
Method, cli-of: Internal generic functions
Method, command-of: Internal generic functions
Method, documentation-of: Exported generic functions
Method, external-merge-sort: Exported generic functions
Method, field-of: Exported generic functions
Method, file-of: Internal generic functions
Method, find-line: Exported generic functions
Method, find-option-slot: Internal generic functions
Method, help-message: Exported generic functions
Method, line-stack-of: Exported generic functions
Method, make-line-stream: Exported generic functions
Method, make-merge-stream: Exported generic functions
Method, more-lines-p: Exported generic functions
Method, more-lines-p: Exported generic functions
Method, name-of: Exported generic functions
Method, name-of: Exported generic functions
Method, name-of: Exported generic functions
Method, option-help: Exported generic functions
Method, option-help: Exported generic functions
Method, option-of: Exported generic functions
Method, option-of: Exported generic functions
Method, option-slot-p: Exported generic functions
Method, option-slots-of: Exported generic functions
Method, options-of: Exported generic functions
Method, parse-command-line: Exported generic functions
Method, parse-safely: Internal generic functions
Method, pop-line: Exported generic functions
Method, push-line: Exported generic functions
Method, record-of: Exported generic functions
Method, required-option-p: Exported generic functions
Method, required-value-p: Exported generic functions
Method, stream-close: Exported generic functions
Method, stream-delete-file: Internal generic functions
Method, stream-delete-file: Internal generic functions
Method, stream-head-of: Exported generic functions
Method, stream-merge: Exported generic functions
Method, stream-of: Exported generic functions
Method, stream-open: Exported generic functions
Method, stream-read-element: Exported generic functions
Method, stream-write-element: Exported generic functions
Method, stream-write-line: Internal generic functions
Method, stream-write-line: Internal generic functions
Method, test-of: Exported generic functions
Method, type-of: Internal generic functions
Method, value-default-of: Exported generic functions
Method, value-of: Internal generic functions
Method, value-parser-of: Exported generic functions
Method, value-type-of: Exported generic functions
more-lines-p: Exported generic functions
more-lines-p: Exported generic functions
more-lines-p: Exported generic functions

N
name-of: Exported generic functions
name-of: Exported generic functions
name-of: Exported generic functions
name-of: Exported generic functions
normalise-whitespace: Internal functions

O
option-help: Exported generic functions
option-help: Exported generic functions
option-help: Exported generic functions
option-of: Exported generic functions
option-of: Exported generic functions
option-of: Exported generic functions
option-slot-p: Exported generic functions
option-slot-p: Exported generic functions
option-slots-of: Exported generic functions
option-slots-of: Exported generic functions
option-value: Exported functions
options-of: Exported generic functions
options-of: Exported generic functions

P
parse-character: Internal functions
parse-character-list: Internal functions
parse-command-line: Exported generic functions
parse-command-line: Exported generic functions
parse-field: Internal functions
parse-float: Exported functions
parse-float-list: Internal functions
parse-integer-list: Internal functions
parse-safely: Internal generic functions
parse-safely: Internal generic functions
parse-string-list: Internal functions
pathname-extender: Exported functions
pathname-generator: Exported functions
pathstring: Exported functions
pop-line: Exported generic functions
pop-line: Exported generic functions
print-backtrace: Exported functions
print-error-message: Internal functions
push-line: Exported generic functions
push-line: Exported generic functions

Q
quit-lisp: Exported functions

R
read-octet-line: Internal functions
record-of: Exported generic functions
record-of: Exported generic functions
relative-pathname-p: Exported functions
required-option-p: Exported generic functions
required-option-p: Exported generic functions
required-value-p: Exported generic functions
required-value-p: Exported generic functions

S
signal-malformed-field: Internal functions
stream-close: Exported generic functions
stream-close: Exported generic functions
stream-delete-file: Internal generic functions
stream-delete-file: Internal generic functions
stream-delete-file: Internal generic functions
stream-head-of: Exported generic functions
stream-head-of: Exported generic functions
stream-merge: Exported generic functions
stream-merge: Exported generic functions
stream-of: Exported generic functions
stream-of: Exported generic functions
stream-open: Exported generic functions
stream-open: Exported generic functions
stream-read-element: Exported generic functions
stream-read-element: Exported generic functions
stream-write-element: Exported generic functions
stream-write-element: Exported generic functions
stream-write-line: Internal generic functions
stream-write-line: Internal generic functions
stream-write-line: Internal generic functions
subst-chars: Internal functions

T
test-of: Exported generic functions
test-of: Exported generic functions
tmp-pathname: Exported functions
type-of: Internal generic functions
type-of: Internal generic functions

V
validate-record: Internal functions
value-default-of: Exported generic functions
value-default-of: Exported generic functions
value-of: Internal generic functions
value-of: Internal generic functions
value-parser-of: Exported generic functions
value-parser-of: Exported generic functions
value-type-of: Exported generic functions
value-type-of: Exported generic functions
value-type-string: Internal functions

W
whitespacep: Internal functions
with-argv: Exported macros
with-tmp-directory: Exported macros
with-tmp-pathname: Exported macros
wrap-string: Internal functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   K   L   M   N   O   P   Q   R   S   T   V   W  

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

A.3 Variables

Jump to:   *   +  
B   C   E   F   L   N   O   R   S   T   V  
Index Entry  Section

*
*default-tmpdir*: Exported special variables
*default-tmpfile-defaults*: Exported special variables
*empty-field*: Exported special variables
*list-separator-char*: Internal special variables
*whitespace-chars*: Internal special variables

+
+exponent-bias-32+: Internal constants
+exponent-bias-64+: Internal constants
+frac-factor-32+: Internal constants
+frac-factor-64+: Internal constants
+min-norm-exponent-32+: Internal constants
+min-norm-exponent-64+: Internal constants
+negative-infinity-32+: Internal constants
+negative-infinity-64+: Internal constants
+not-a-number-32+: Internal constants
+not-a-number-64+: Internal constants
+octet-buffer-size+: Internal constants
+positive-infinity-32+: Internal constants
+positive-infinity-64+: Internal constants

B
buffer: Exported classes

C
cli: Exported conditions
cli: Exported conditions
command: Exported conditions
Constant, +exponent-bias-32+: Internal constants
Constant, +exponent-bias-64+: Internal constants
Constant, +frac-factor-32+: Internal constants
Constant, +frac-factor-64+: Internal constants
Constant, +min-norm-exponent-32+: Internal constants
Constant, +min-norm-exponent-64+: Internal constants
Constant, +negative-infinity-32+: Internal constants
Constant, +negative-infinity-64+: Internal constants
Constant, +not-a-number-32+: Internal constants
Constant, +not-a-number-64+: Internal constants
Constant, +octet-buffer-size+: Internal constants
Constant, +positive-infinity-32+: Internal constants
Constant, +positive-infinity-64+: Internal constants

E
eol-code: Exported classes

F
field: Exported conditions
file: Exported conditions

L
line-stack: Exported classes

N
name: Exported conditions
name: Exported conditions
name: Exported classes
num-bytes: Exported classes

O
offset: Exported classes

R
record: Exported conditions
required-option: Exported classes

S
Slot, buffer: Exported classes
Slot, cli: Exported conditions
Slot, cli: Exported conditions
Slot, command: Exported conditions
Slot, eol-code: Exported classes
Slot, field: Exported conditions
Slot, file: Exported conditions
Slot, line-stack: Exported classes
Slot, name: Exported conditions
Slot, name: Exported conditions
Slot, name: Exported classes
Slot, num-bytes: Exported classes
Slot, offset: Exported classes
Slot, record: Exported conditions
Slot, required-option: Exported classes
Slot, stream: Exported classes
Slot, stream-head: Exported classes
Slot, test: Exported classes
Slot, type: Exported conditions
Slot, value: Exported conditions
Slot, value-default: Exported classes
Slot, value-parser: Exported classes
Slot, value-type: Exported classes
Special Variable, *default-tmpdir*: Exported special variables
Special Variable, *default-tmpfile-defaults*: Exported special variables
Special Variable, *empty-field*: Exported special variables
Special Variable, *list-separator-char*: Internal special variables
Special Variable, *whitespace-chars*: Internal special variables
stream: Exported classes
stream-head: Exported classes

T
test: Exported classes
type: Exported conditions

V
value: Exported conditions
value-default: Exported classes
value-parser: Exported classes
value-type: Exported classes

Jump to:   *   +  
B   C   E   F   L   N   O   R   S   T   V  

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

A.4 Data types

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

C
character-line-input-stream: Exported classes
character-line-output-stream: Internal classes
Class, character-line-input-stream: Exported classes
Class, character-line-output-stream: Internal classes
Class, cli: Exported classes
Class, cli-option: Exported classes
Class, io-stream-mixin: Exported classes
Class, line-input-stream: Exported classes
Class, line-merge-stream: Exported classes
Class, line-output-stream: Exported classes
Class, line-sort-input-stream: Exported classes
Class, line-sort-output-stream: Exported classes
Class, line-stream: Exported classes
Class, merge-stream: Exported classes
Class, octet-line-input-stream: Exported classes
Class, octet-line-output-stream: Internal classes
Class, sort-input-stream: Exported classes
Class, sort-output-stream: Exported classes
Class, stream-filter-mixin: Exported classes
Class, wrapped-stream-mixin: Exported classes
cli: Exported classes
cli-error: Exported conditions
cli-option: Exported classes
cli-option-error: Exported conditions
cli-option-warning: Exported conditions
cli-warning: Exported conditions
Condition, cli-error: Exported conditions
Condition, cli-option-error: Exported conditions
Condition, cli-option-warning: Exported conditions
Condition, cli-warning: Exported conditions
Condition, field-validation-error: Exported conditions
Condition, general-parse-error: Exported conditions
Condition, incompatible-value: Exported conditions
Condition, io-error: Exported conditions
Condition, io-warning: Exported conditions
Condition, malformed-field-error: Exported conditions
Condition, malformed-file-error: Exported conditions
Condition, malformed-record-error: Exported conditions
Condition, missing-required-option: Exported conditions
Condition, missing-required-value: Exported conditions
Condition, record-validation-error: Exported conditions
Condition, unknown-command: Exported conditions
Condition, unknown-option: Exported conditions
Condition, unmatched-option: Exported conditions

D
deoxybyte-io: The deoxybyte-io system

F
field-validation-error: Exported conditions

G
general-parse-error: Exported conditions

I
incompatible-value: Exported conditions
io-error: Exported conditions
io-stream-mixin: Exported classes
io-warning: Exported conditions

L
line-input-stream: Exported classes
line-merge-stream: Exported classes
line-output-stream: Exported classes
line-sort-input-stream: Exported classes
line-sort-output-stream: Exported classes
line-stream: Exported classes

M
malformed-field-error: Exported conditions
malformed-file-error: Exported conditions
malformed-record-error: Exported conditions
merge-stream: Exported classes
missing-required-option: Exported conditions
missing-required-value: Exported conditions

O
octet-buffer: Internal types
octet-buffer-index: Internal types
octet-line-input-stream: Exported classes
octet-line-output-stream: Internal classes

P
Package, uk.co.deoxybyte-io: The uk․co․deoxybyte-io package

R
record-validation-error: Exported conditions

S
sort-input-stream: Exported classes
sort-output-stream: Exported classes
stream-filter-mixin: Exported classes
System, deoxybyte-io: The deoxybyte-io system

T
Type, octet-buffer: Internal types
Type, octet-buffer-index: Internal types

U
uk.co.deoxybyte-io: The uk․co․deoxybyte-io package
unknown-command: Exported conditions
unknown-option: Exported conditions
unmatched-option: Exported conditions

W
wrapped-stream-mixin: Exported classes

Jump to:   C   D   F   G   I   L   M   O   P   R   S   T   U   W