This is the named-readtables Reference Manual, version 0.9, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 06:03:53 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
named-readtablesLibrary that creates a namespace for readtables akin to the namespace of packages.
Gábor Melis <mega@retes.hu>
Tobias C. Rittweiler <trittweiler@common-lisp.net>
(GIT https://github.com/melisgl/named-readtables.git)
BSD, see LICENSE
0.9
mgl-pax-bootstrap (system).
package.lisp (file).
utils.lisp (file).
define-api.lisp (file).
cruft.lisp (file).
named-readtables.lisp (file).
doc.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
named-readtables/named-readtables.asdnamed-readtables/package.lispnamed-readtables/utils.lispnamed-readtables/define-api.lispnamed-readtables/cruft.lispnamed-readtables/named-readtables.lispnamed-readtables/doc.lispnamed-readtables/named-readtables.asdnamed-readtables (system).
named-readtables/utils.lisppackage.lisp (file).
named-readtables (system).
destructure-case (macro).
ensure-function (function).
ensure-list (function).
parse-body (function).
parse-ordinary-lambda-list (function).
required-argument (function).
simple-program-error (function).
simple-program-error (condition).
simple-style-warn (function).
simple-style-warning (condition).
without-package-lock (macro).
named-readtables/define-api.lisputils.lisp (file).
named-readtables (system).
define-api (macro).
named-readtables/cruft.lispdefine-api.lisp (file).
named-readtables (system).
%associate-docstring-with-readtable (function).
%associate-dummy-with-readtable (function).
%associate-name-with-readtable (function).
%associate-readtable-with-name (function).
%clear-readtable (function).
%find-readtable (function).
%get-dispatch-macro-character (function).
%get-macro-character (function).
%list-all-readtable-names (function).
%make-readtable-iterator (function).
%readtable-name (function).
%standard-readtable (function).
%unassociate-docstring-from-readtable (function).
%unassociate-dummy-from-readtable (function).
%unassociate-name-from-readtable (function).
%unassociate-readtable-from-name (function).
*named-readtables* (special variable).
*readtable-names* (special variable).
*readtable-to-docstring* (special variable).
*readtable-to-dummy-with-source-location* (special variable).
define-cruft (macro).
dispatch-macro-char-p (function).
do-readtable (macro).
funcall-or (function).
function= (function).
with-readtable-iterator (macro).
named-readtables/named-readtables.lispcruft.lisp (file).
named-readtables (system).
copy-named-readtable (function).
defreadtable (macro).
ensure-readtable (compiler macro).
ensure-readtable (function).
(setf find-readtable) (setf expander).
find-readtable (function).
in-readtable (macro).
list-all-named-readtables (function).
make-readtable (function).
merge-readtables-into (function).
named-readtable-designator (type).
reader-macro-conflict (condition).
readtable-does-already-exist (condition).
readtable-does-not-exist (condition).
readtable-error (condition).
readtable-name (function).
register-readtable (compiler macro).
register-readtable (function).
rename-readtable (function).
unregister-readtable (function).
%frob-swank-readtable-alist (function).
*case-preserving-standard-readtable* (special variable).
*empty-readtable* (special variable).
*reserved-readtable-names* (special variable).
*standard-readtable* (special variable).
check-reader-macro-conflict (function).
conflicting-dispatch-sub-char (reader method).
(setf conflicting-dispatch-sub-char) (writer method).
conflicting-macro-char (reader method).
(setf conflicting-macro-char) (writer method).
constant-standard-readtable-expression-p (function).
ensure-dispatch-macro-character (function).
existing-readtable-name (reader method).
(setf existing-readtable-name) (writer method).
find-reserved-readtable (function).
from-readtable (reader method).
(setf from-readtable) (writer method).
missing-readtable-name (reader method).
(setf missing-readtable-name) (writer method).
readtable-designator (type).
reserved-readtable-name-p (function).
signal-suspicious-registration-warning (function).
to-readtable (reader method).
(setf to-readtable) (writer method).
named-readtables/doc.lispnamed-readtables.lisp (file).
named-readtables (system).
@named-readtables-acknowledgements (special variable).
@named-readtables-api-idiosyncrasies (special variable).
@named-readtables-api-notes (special variable).
@named-readtables-examples (special variable).
@named-readtables-introduction (special variable).
@named-readtables-links (special variable).
@named-readtables-manual (special variable).
@named-readtables-overview (special variable).
@named-readtables-preregistered (special variable).
@named-readtables-reference (special variable).
pax-pages (function).
pax-sections (function).
Packages are listed by definition order.
editor-hints.named-readtablesSee NAMED-READTABLES::@NAMED-READTABLES-MANUAL.
named-readtables
common-lisp.
copy-named-readtable (function).
defreadtable (macro).
ensure-readtable (compiler macro).
ensure-readtable (function).
(setf find-readtable) (setf expander).
find-readtable (function).
in-readtable (macro).
list-all-named-readtables (function).
make-readtable (function).
merge-readtables-into (function).
named-readtable-designator (type).
reader-macro-conflict (condition).
readtable-does-already-exist (condition).
readtable-does-not-exist (condition).
readtable-error (condition).
readtable-name (function).
register-readtable (compiler macro).
register-readtable (function).
rename-readtable (function).
unregister-readtable (function).
%associate-docstring-with-readtable (function).
%associate-dummy-with-readtable (function).
%associate-name-with-readtable (function).
%associate-readtable-with-name (function).
%clear-readtable (function).
%find-readtable (function).
%frob-swank-readtable-alist (function).
%get-dispatch-macro-character (function).
%get-macro-character (function).
%list-all-readtable-names (function).
%make-readtable-iterator (function).
%readtable-name (function).
%standard-readtable (function).
%unassociate-docstring-from-readtable (function).
%unassociate-dummy-from-readtable (function).
%unassociate-name-from-readtable (function).
%unassociate-readtable-from-name (function).
*case-preserving-standard-readtable* (special variable).
*empty-readtable* (special variable).
*named-readtables* (special variable).
*readtable-names* (special variable).
*readtable-to-docstring* (special variable).
*readtable-to-dummy-with-source-location* (special variable).
*reserved-readtable-names* (special variable).
*standard-readtable* (special variable).
@named-readtables-acknowledgements (special variable).
@named-readtables-api-idiosyncrasies (special variable).
@named-readtables-api-notes (special variable).
@named-readtables-examples (special variable).
@named-readtables-introduction (special variable).
@named-readtables-links (special variable).
@named-readtables-manual (special variable).
@named-readtables-overview (special variable).
@named-readtables-preregistered (special variable).
@named-readtables-reference (special variable).
check-reader-macro-conflict (function).
conflicting-dispatch-sub-char (generic reader).
(setf conflicting-dispatch-sub-char) (generic writer).
conflicting-macro-char (generic reader).
(setf conflicting-macro-char) (generic writer).
constant-standard-readtable-expression-p (function).
define-api (macro).
define-cruft (macro).
destructure-case (macro).
dispatch-macro-char-p (function).
do-readtable (macro).
ensure-dispatch-macro-character (function).
ensure-function (function).
ensure-list (function).
existing-readtable-name (generic reader).
(setf existing-readtable-name) (generic writer).
find-reserved-readtable (function).
from-readtable (generic reader).
(setf from-readtable) (generic writer).
funcall-or (function).
function= (function).
missing-readtable-name (generic reader).
(setf missing-readtable-name) (generic writer).
parse-body (function).
parse-ordinary-lambda-list (function).
pax-pages (function).
pax-sections (function).
readtable-designator (type).
required-argument (function).
reserved-readtable-name-p (function).
signal-suspicious-registration-warning (function).
simple-program-error (function).
simple-program-error (condition).
simple-style-warn (function).
simple-style-warning (condition).
to-readtable (generic reader).
(setf to-readtable) (generic writer).
with-readtable-iterator (macro).
without-package-lock (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Define a new named readtable, whose name is given by the symbol NAME.
Or, if a readtable is already registered under that name, redefine
that one.
The readtable can be populated using the following OPTIONS:
- If the first element of OPTIONS is a string then it is associated
with the readtable as in ‘(SETF (DOCUMENTATION NAME ’READTABLE)
DOCSTRING)‘.
- ‘(:MERGE READTABLE-DESIGNATORS+)‘
Merge the macro character definitions from the readtables
designated into the new readtable being defined as per
MERGE-READTABLES-INTO. The copied options are
:DISPATCH-MACRO-CHAR, :MACRO-CHAR and :SYNTAX-FROM, but not
READTABLE-CASE.
If no :MERGE clause is given, an empty readtable is used. See
MAKE-READTABLE.
- ‘(:FUSE READTABLE-DESIGNATORS+)‘
Like :MERGE except:
Error conditions of type READER-MACRO-CONFLICT that are signaled
during the merge operation will be silently _continued_. It
follows that reader macros in earlier entries will be
overwritten by later ones. For backward compatibility, :FUZE is
accepted as an alias of :FUSE.
- ‘(:DISPATCH-MACRO-CHAR MACRO-CHAR SUB-CHAR FUNCTION)‘
Define a new sub character ‘SUB-CHAR‘ for the dispatching macro
character ‘MACRO-CHAR‘, per SET-DISPATCH-MACRO-CHARACTER. You
probably have to define ‘MACRO-CHAR‘ as a dispatching macro
character by the following option first.
- ‘(:MACRO-CHAR MACRO-CHAR FUNCTION [NON-TERMINATING-P])‘
Define a new macro character in the readtable, per
SET-MACRO-CHARACTER. If [FUNCTION][pax:argument] is the keyword
:DISPATCH, ‘MACRO-CHAR‘ is made a dispatching macro character,
per MAKE-DISPATCH-MACRO-CHARACTER.
- ‘(:SYNTAX-FROM FROM-READTABLE-DESIGNATOR FROM-CHAR TO-CHAR)‘
Set the character syntax of TO-CHAR in the readtable being
defined to the same syntax as FROM-CHAR as per
SET-SYNTAX-FROM-CHAR.
- ‘(:CASE CASE-MODE)‘
Defines the _case sensitivity mode_ of the resulting readtable.
Any number of option clauses may appear. The options are grouped by
their type, but in each group the order the options appeared
textually is preserved. The following groups exist and are executed
in the following order: :MERGE and :FUSE (one group), :CASE,
:MACRO-CHAR and :DISPATCH-MACRO-CHAR (one group), finally
:SYNTAX-FROM.
Notes:
The readtable is defined at load-time. If you want to have it
available at compilation time – say to use its reader-macros in the
same file as its definition – you have to wrap the DEFREADTABLE
form in an explicit EVAL-WHEN.
On redefinition, the target readtable is made empty first before
it’s refilled according to the clauses.
NIL, :STANDARD, :COMMON-LISP, :MODERN, and :CURRENT are preregistered readtable names.
Set *READTABLE* to the readtable referred to by the symbol NAME. Return the readtable.
find-readtable (function).
register-readtable (function).
Like COPY-READTABLE but takes a NAMED-READTABLE-DESIGNATOR as argument.
Looks up the readtable specified by NAME and returns it if it’s found. If it is not found, it registers the readtable designated by DEFAULT under the name represented by NAME; or if no default argument is given, it signals an error of type READTABLE-DOES-NOT-EXIST instead.
Looks for the readtable specified by NAME and returns it if it is found. Returns NIL otherwise.
Returns a list of all registered readtables. The returned list is guaranteed to be fresh, but may contain duplicates.
Creates and returns a new readtable under the specified
NAME.
MERGE takes a list of NAMED-READTABLE-DESIGNATORs and specifies the
readtables the new readtable is created from. (See the :MERGE clause
of DEFREADTABLE for details.)
If MERGE is NIL, an empty readtable is used instead.
If NAME is not given, an anonymous empty readtable is returned.
Notes:
An empty readtable is a readtable where each character’s syntax is the same as in the _standard readtable_ except that each macro character has been made a constituent. Basically: whitespace stays whitespace, everything else is constituent.
Copy macro character definitions of each readtable in
NAMED-READTABLES into RESULT-READTABLE.
If a macro character appears in more than one of the readtables,
i.e. if a conflict is discovered during the merge, an error of type
READER-MACRO-CONFLICT is signaled.
The copied options are :DISPATCH-MACRO-CHAR, :MACRO-CHAR and :SYNTAX-FROM, but not READTABLE-CASE.
Returns the name of the readtable designated by NAMED-READTABLE, or NIL.
Associate READTABLE with NAME. Returns the readtable.
Replaces the associated name of the readtable designated by OLD-NAME with NEW-NAME. If a readtable is already registered under NEW-NAME, an error of type READTABLE-DOES-ALREADY-EXIST is signaled.
Remove the association of NAMED-READTABLE. Returns T if successfull, NIL otherwise.
Continuable.
This condition is signaled during the merge process if a reader macro (be it a macro character or the sub character of a dispatch macro character) is present in the both source and the target readtable and the two respective reader macro functions differ.
(quote (editor-hints.named-readtables::required-argument))
:macro-char
(quote nil)
:sub-char
(quote (editor-hints.named-readtables::required-argument))
:from-readtable
(quote (editor-hints.named-readtables::required-argument))
:to-readtable
Continuable.
(quote (editor-hints.named-readtables::required-argument))
:readtable-name
(quote (editor-hints.named-readtables::required-argument))
:readtable-name
error.
Either a symbol or a readtable itself.
Dispatch VALUE to one of PATTERNS.
A cross between ‘case’ and ‘destructuring-bind’.
The pattern syntax is:
((HEAD . ARGS) . BODY)
The list of patterns is searched for a HEAD ‘eq’ to the car of
VALUE. If one is found, the BODY is executed with ARGS bound to the
corresponding values in the CDR of VALUE.
Iterate through a readtable’s macro characters, and dispatch macro characters.
Associate NAME with READTABLE for FIND-READTABLE to work.
Associate READTABLE with NAME for READTABLE-NAME to work.
Make all macro characters in READTABLE be constituents.
Return the readtable named NAME.
Ensure ANSI behaviour for GET-DISPATCH-MACRO-CHARACTER.
Ensure ANSI behaviour for GET-MACRO-CHARACTER.
Return a list of all available readtable names.
Return the name associated with READTABLE.
Return the standard readtable.
Remove the association between NAME and READTABLE
Remove the association between READTABLE and NAME.
Is CHAR a dispatch macro character in RT?
Returns the function designated by FUNCTION-DESIGNATOR:
if FUNCTION-DESIGNATOR is a function, it is returned, otherwise
it must be a function name and its FDEFINITION is returned.
If LIST is a list, it is returned. Otherwise returns the list designated by LIST.
Are reader-macro function-designators FN1 and FN2 the same?
Parses BODY into (values remaining-forms declarations doc-string). Documentation strings are recognized only if DOCUMENTATION is true. Syntax errors in body are signalled and WHOLE is used in the signal arguments when given.
Parses an ordinary lambda-list, returning as multiple values:
1. Required parameters.
2. Optional parameter specifications, normalized into form (NAME INIT SUPPLIEDP)
where SUPPLIEDP is NIL if not present.
3. Name of the rest parameter, or NIL.
4. Keyword parameter specifications, normalized into form ((KEYWORD-NAME NAME) INIT SUPPLIEDP)
where SUPPLIEDP is NIL if not present.
5. Boolean indicating &ALLOW-OTHER-KEYS presence.
6. &AUX parameter specifications, normalized into form (NAME INIT).
Signals a PROGRAM-ERROR is the lambda-list is malformed.
Signals an error for a missing argument of NAME. Intended for use as an initialization form for structure and class-slots, and a default value for required keyword arguments.
reader-macro-conflict)) ¶reader-macro-conflict)) ¶reader-macro-conflict)) ¶reader-macro-conflict)) ¶readtable-does-already-exist)) ¶readtable-does-already-exist)) ¶reader-macro-conflict)) ¶reader-macro-conflict)) ¶readtable-does-not-exist)) ¶readtable-does-not-exist)) ¶reader-macro-conflict)) ¶reader-macro-conflict)) ¶program-error.
simple-error.
simple-warning.
style-warning.
| Jump to: | %
(
C D E F G I L M P R S T U W |
|---|
| Jump to: | %
(
C D E F G I L M P R S T U W |
|---|
| Jump to: | *
@
F M R S T |
|---|
| Jump to: | *
@
F M R S T |
|---|
| Jump to: | C D E F N P R S T U |
|---|
| Jump to: | C D E F N P R S T U |
|---|