The reader Reference Manual

This is the reader Reference Manual, version 0.10.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jan 15 07:36:01 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 reader

A utility library intended at providing configurable reader macros for
common tasks such as accessors, hash-tables, sets, uiop:run-program, arrays and a few others.

Author

<>

License

MIT

Version

0.10.0

Dependencies
  • alexandria (system).
  • fiveam (system).
  • hash-set (system).
  • iterate (system).
  • split-sequence (system).
  • trivial-types (system).
  • uiop (system).
Source

reader.asd.

Child Component

reader.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 reader/reader.asd

Source

reader.asd.

Parent Component

reader (system).

ASDF Systems

reader.


3.1.2 reader/reader.lisp

Source

reader.asd.

Parent Component

reader (system).

Packages

reader.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 reader

Source

reader.lisp.

Use List
  • common-lisp.
  • hash-set.
  • iterate.
  • split-sequence.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *alists-are-lists*

If T, ALISTS will not be treated specially by READER:GET-VAL method for lists.

Package

reader.

Source

reader.lisp.

Special Variable: *array-function*

A symbol bound (at read-time) to a function that takes INITIAL-CONTENTS
as its argument and returns the array. INITIAL-CONTENTS is a list of nested-lists.

Package

reader.

Source

reader.lisp.

Special Variable: *get-val-array-function*

A symbol bound (at read-time) to a function that takes
(ARRAY &REST SUBSCRIPTS)
as arguments and returns the corresponding value.
This is assumed to have a SETF defined.
This variable is significant if READER:*GET-VAL-FUNCTION* is bound to READER:GET-VAL.

Package

reader.

Source

reader.lisp.

Special Variable: *get-val-function*

A symbol bound (at read-time) to a function that takes (OBJECT &REST KEY/S)
as arguments and returns the value corresponding to the KEY/S.

Package

reader.

Source

reader.lisp.

Special Variable: *hash-table-function*

A symbol bound (at read-time) to a function that takes (PLIST &KEY TEST)
as arguments and returns the hash-table.

Package

reader.

Source

reader.lisp.

Special Variable: *plists-are-lists*

If T, PLISTS will not be treated specially by READER:GET-VAL method for lists.

Package

reader.

Source

reader.lisp.

Special Variable: *set-function*

A symbol bound (at read-time) to a function that takes (LIST &KEY TEST)
as arguments and returns the set.

Package

reader.

Source

reader.lisp.


5.1.2 Macros

Macro: disable-reader-syntax ()
Package

reader.

Source

reader.lisp.

Macro: enable-reader-syntax (&rest reader-macro-identifiers)

READER-MACRO-IDENTIFIERS are any of the following symbols: GET-VAL, HASH-TABLE, NOT, STRING, DESCRIBE, ARRAY, SET, RUN-PROGRAM

Package

reader.

Source

reader.lisp.


5.1.3 Generic functions

Generic Function: get-val (object &rest key/s)
Package

reader.

Source

reader.lisp.

Methods
Method: get-val ((object array) &rest key/s)
Method: get-val ((object list) &rest key/s)
Method: get-val ((object hash-table) &rest key/s)
Method: get-val ((object sequence) &rest key/s)
Method: get-val ((object structure-object) &rest key/s)
Generic Function: (setf get-val) (object &rest key/s)
Package

reader.

Methods
Method: (setf get-val) ((object array) &rest key/s)
Source

reader.lisp.

Method: (setf get-val) ((object list) &rest key/s)
Source

reader.lisp.

Method: (setf get-val) ((object standard-object) &rest key/s)
Source

reader.lisp.

Method: (setf get-val) ((object structure-object) &rest key/s)
Source

reader.lisp.

Method: (setf get-val) ((object sequence) &rest key/s)
Source

reader.lisp.

Method: (setf get-val) ((object hash-table) &rest key/s)
Source

reader.lisp.


5.2 Internals


5.2.1 Constants

Constant: +reader-macro-doc+
Package

reader.

Source

reader.lisp.


5.2.2 Special variables

Special Variable: *previous-readtables*
Package

reader.

Source

reader.lisp.

Special Variable: *reader-macro-activation-functions*
Package

reader.

Source

reader.lisp.


5.2.3 Macros

Macro: defmethods-with-setf (fun-name lambda-list &rest methods)
Package

reader.

Source

reader.lisp.

Macro: setp (new-value place)
Package

reader.

Source

reader.lisp.

Macro: with-env (&body body)
Package

reader.

Source

reader.lisp.

Macro: with-reader-syntax (reader-macro-identifiers &body body)

This macro is only made for use by read-and-eval functionality, and rather directed towards tests than users. So, do not export.

Package

reader.

Source

reader.lisp.


5.2.4 Ordinary functions

Function: %enable-reader-syntax (readtable &rest reader-macro-identifiers)
Package

reader.

Source

reader.lisp.

Function: array-reader-macro (stream char n)
Package

reader.

Source

reader.lisp.

Function: describe-reader-macro (stream char)
Package

reader.

Source

reader.lisp.

Function: er (string)
Package

reader.

Source

reader.lisp.

Function: get-val-reader-macro (stream char)
Package

reader.

Source

reader.lisp.

Function: hash-table-reader-macro (stream char)
Package

reader.

Source

reader.lisp.

Function: list-to-hash-set-with-test (list &key test)
Package

reader.

Source

reader.lisp.

Function: make-t-array-from-initial-contents (initial-contents)
Package

reader.

Source

reader.lisp.

Function: not-reader-macro (stream char)
Package

reader.

Source

reader.lisp.

Function: read-array (stream)
Package

reader.

Source

reader.lisp.

Function: read-row-from-string (string)
Package

reader.

Source

reader.lisp.

Function: read-stream-as-string-until (stream until-char)
Package

reader.

Source

reader.lisp.

Function: read-stream-until (stream until-char)
Package

reader.

Source

reader.lisp.

Function: run-program-reader-macro (stream char n)
Package

reader.

Source

reader.lisp.

Function: set-reader-macro (stream char n)
Package

reader.

Source

reader.lisp.

Function: string-reader-macro (stream char)
Package

reader.

Source

reader.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   D   E   F   G   H   L   M   N   R   S   W  
Index Entry  Section

%
%enable-reader-syntax: Private ordinary functions

(
(setf get-val): Public generic functions
(setf get-val): Public generic functions
(setf get-val): Public generic functions
(setf get-val): Public generic functions
(setf get-val): Public generic functions
(setf get-val): Public generic functions
(setf get-val): Public generic functions

A
array-reader-macro: Private ordinary functions

D
defmethods-with-setf: Private macros
describe-reader-macro: Private ordinary functions
disable-reader-syntax: Public macros

E
enable-reader-syntax: Public macros
er: Private ordinary functions

F
Function, %enable-reader-syntax: Private ordinary functions
Function, array-reader-macro: Private ordinary functions
Function, describe-reader-macro: Private ordinary functions
Function, er: Private ordinary functions
Function, get-val-reader-macro: Private ordinary functions
Function, hash-table-reader-macro: Private ordinary functions
Function, list-to-hash-set-with-test: Private ordinary functions
Function, make-t-array-from-initial-contents: Private ordinary functions
Function, not-reader-macro: Private ordinary functions
Function, read-array: Private ordinary functions
Function, read-row-from-string: Private ordinary functions
Function, read-stream-as-string-until: Private ordinary functions
Function, read-stream-until: Private ordinary functions
Function, run-program-reader-macro: Private ordinary functions
Function, set-reader-macro: Private ordinary functions
Function, string-reader-macro: Private ordinary functions

G
Generic Function, (setf get-val): Public generic functions
Generic Function, get-val: Public generic functions
get-val: Public generic functions
get-val: Public generic functions
get-val: Public generic functions
get-val: Public generic functions
get-val: Public generic functions
get-val: Public generic functions
get-val-reader-macro: Private ordinary functions

H
hash-table-reader-macro: Private ordinary functions

L
list-to-hash-set-with-test: Private ordinary functions

M
Macro, defmethods-with-setf: Private macros
Macro, disable-reader-syntax: Public macros
Macro, enable-reader-syntax: Public macros
Macro, setp: Private macros
Macro, with-env: Private macros
Macro, with-reader-syntax: Private macros
make-t-array-from-initial-contents: Private ordinary functions
Method, (setf get-val): Public generic functions
Method, (setf get-val): Public generic functions
Method, (setf get-val): Public generic functions
Method, (setf get-val): Public generic functions
Method, (setf get-val): Public generic functions
Method, (setf get-val): Public generic functions
Method, get-val: Public generic functions
Method, get-val: Public generic functions
Method, get-val: Public generic functions
Method, get-val: Public generic functions
Method, get-val: Public generic functions

N
not-reader-macro: Private ordinary functions

R
read-array: Private ordinary functions
read-row-from-string: Private ordinary functions
read-stream-as-string-until: Private ordinary functions
read-stream-until: Private ordinary functions
run-program-reader-macro: Private ordinary functions

S
set-reader-macro: Private ordinary functions
setp: Private macros
string-reader-macro: Private ordinary functions

W
with-env: Private macros
with-reader-syntax: Private macros