Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the net.didierverna.declt Reference Manual, version 3.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:52:06 2021 GMT+0.
| • Introduction | What net.didierverna.declt is all about | |
| • Systems | The systems documentation | |
| • Modules | The modules documentation | |
| • Files | The files documentation | |
| • Packages | The packages documentation | |
| • Definitions | The symbols documentation | |
| • Indexes | Concepts, functions, variables and data types |
Declt (pronounce dec'let) is a reference manual generator for Common Lisp. It extracts and formats documentation from ASDF systems, including the system itself, its local dependencies (subsystems), components, packages and an extensive list of definitions (variables, functions etc.). The formatted documentation comes with full indexing and cross-references.
Reference manuals are generated in Texinfo, which can subsequently be converted into info, HTML, DVI, PostScript or PDF.
In your favorite Lisp REPL, type this:
(asdf:load-system :net.didierverna.declt)
(net.didierverna.declt:nickname-package)
(declt:declt :my.asdf.system)
You will end up with a file named my.asdf.system.texi in the current
directory. This is a Texinfo file that can further be compiled into various
formats, such as Info, HTML, or PDF. For example, in order to get a PDF, type
this in the same directory:
makeinfo --pdf my.asdf.system.texi
And enjoy reading the resulting my.asdf.system.pdf...
The DECLT function accepts a number of keyword parameters for tweaking the
output. Please refer to the docstring for more information.
A typical example of a Declt-generated reference manual is that of Declt itself.
Declt also comes with a user manual. Please see the projet's homepage.
Next: Modules, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The net.didierverna.declt system | ||
| • The net.didierverna.declt.core system | ||
| • The net.didierverna.declt.setup system |
Next: The net․didierverna․declt․core system, Previous: Systems, Up: Systems [Contents][Index]
Documentation Extractor from Common Lisp to Texinfo
Didier Verna
http://www.lrde.epita.fr/~didier/software/lisp/misc.php#declt
BSD
A reference manual generator for Common Lisp libraries
Declt (pronounce dec’let) is a reference manual generator for Common Lisp.
It extracts and formats documentation from ASDF systems, including the system
itself, its local dependencies (subsystems), components, packages and an
extensive list of definitions (variables, functions etc.). The formatted
documentation comes with full indexing and cross-references.
Reference manuals are generated in Texinfo format which can subsequently be converted into info, HTML, DVI, PostScript or PDF.
3.0
sbcl
net.didierverna.declt.asd (file)
Next: The net․didierverna․declt․setup system, Previous: The net․didierverna․declt system, Up: Systems [Contents][Index]
Documentation Extractor from Common Lisp to Texinfo, core library
Didier Verna
http://www.lrde.epita.fr/~didier/software/lisp/misc.php#declt
BSD
A reference manual generator for Common Lisp libraries
Declt’s core functionality. For a more complete description of Declt, see the net.didierverna.declt system.
3.0
sbcl
Previous: The net․didierverna․declt․core system, Up: Systems [Contents][Index]
Documentation Extractor from Common Lisp to Texinfo, setup library
Didier Verna
http://www.lrde.epita.fr/~didier/software/lisp/misc.php#declt
BSD
Declt’s preload setup library
Declt’s setup library provides support for various preload configuration parameters. For a more complete description of Declt, see the net.didierverna.declt system.
setup.lisp (file)
Modules are listed depth-first from the system components tree.
| • The net.didierverna.declt.core/src module | ||
| • The net.didierverna.declt.core/src/util module | ||
| • The net.didierverna.declt.core/src/item module | ||
| • The net.didierverna.declt.core/src/doc module |
Next: The net․didierverna․declt․core/src/util module, Previous: Modules, Up: Modules [Contents][Index]
meta.lisp (file)
net.didierverna.declt.core (system)
core/src/
Next: The net․didierverna․declt․core/src/item module, Previous: The net․didierverna․declt․core/src module, Up: Modules [Contents][Index]
src (module)
core/src/util/
Next: The net․didierverna․declt․core/src/doc module, Previous: The net․didierverna․declt․core/src/util module, Up: Modules [Contents][Index]
util (module)
src (module)
core/src/item/
Previous: The net․didierverna․declt․core/src/item module, Up: Modules [Contents][Index]
item (module)
src (module)
core/src/doc/
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files |
Next: The net․didierverna․declt․core․asd file, Previous: Lisp files, Up: Lisp files [Contents][Index]
net.didierverna.declt.asd
net.didierverna.declt (system)
Next: The net․didierverna․declt․setup․asd file, Previous: The net․didierverna․declt․asd file, Up: Lisp files [Contents][Index]
core/net.didierverna.declt.core.asd
net.didierverna.declt.core (system)
Next: The net․didierverna․declt․core/quickutil․lisp file, Previous: The net․didierverna․declt․core․asd file, Up: Lisp files [Contents][Index]
setup/net.didierverna.declt.setup.asd
net.didierverna.declt.setup (system)
Next: The net․didierverna․declt․core/meta․lisp file, Previous: The net․didierverna․declt․setup․asd file, Up: Lisp files [Contents][Index]
net.didierverna.declt.core (system)
core/quickutil.lisp
Next: The net․didierverna․declt․core/src/util/misc․lisp file, Previous: The net․didierverna․declt․core/quickutil․lisp file, Up: Lisp files [Contents][Index]
quickutil.lisp (file)
net.didierverna.declt.core (system)
core/meta.lisp
nickname-package (function)
Next: The net․didierverna․declt․core/src/util/asdf․lisp file, Previous: The net․didierverna․declt․core/meta․lisp file, Up: Lisp files [Contents][Index]
util (module)
core/src/util/misc.lisp
Next: The net․didierverna․declt․core/src/util/texi․lisp file, Previous: The net․didierverna․declt․core/src/util/misc․lisp file, Up: Lisp files [Contents][Index]
misc.lisp (file)
util (module)
core/src/util/asdf.lisp
Next: The net․didierverna․declt․core/src/item/item․lisp file, Previous: The net․didierverna․declt․core/src/util/asdf․lisp file, Up: Lisp files [Contents][Index]
asdf.lisp (file)
util (module)
core/src/util/texi.lisp
Next: The net․didierverna․declt․core/src/item/symbol․lisp file, Previous: The net․didierverna․declt․core/src/util/texi․lisp file, Up: Lisp files [Contents][Index]
item (module)
core/src/item/item.lisp
Next: The net․didierverna․declt․core/src/item/package․lisp file, Previous: The net․didierverna․declt․core/src/item/item․lisp file, Up: Lisp files [Contents][Index]
item.lisp (file)
item (module)
core/src/item/symbol.lisp
Next: The net․didierverna․declt․core/src/item/asdf․lisp file, Previous: The net․didierverna․declt․core/src/item/symbol․lisp file, Up: Lisp files [Contents][Index]
symbol.lisp (file)
item (module)
core/src/item/package.lisp
Next: The net․didierverna․declt․core/src/doc/doc․lisp file, Previous: The net․didierverna․declt․core/src/item/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
item (module)
core/src/item/asdf.lisp
Next: The net․didierverna․declt․core/src/doc/symbol․lisp file, Previous: The net․didierverna․declt․core/src/item/asdf․lisp file, Up: Lisp files [Contents][Index]
doc (module)
core/src/doc/doc.lisp
Next: The net․didierverna․declt․core/src/doc/package․lisp file, Previous: The net․didierverna․declt․core/src/doc/doc․lisp file, Up: Lisp files [Contents][Index]
doc.lisp (file)
doc (module)
core/src/doc/symbol.lisp
Next: The net․didierverna․declt․core/src/doc/asdf․lisp file, Previous: The net․didierverna․declt․core/src/doc/symbol․lisp file, Up: Lisp files [Contents][Index]
symbol.lisp (file)
doc (module)
core/src/doc/package.lisp
Next: The net․didierverna․declt․core/src/declt․lisp file, Previous: The net․didierverna․declt․core/src/doc/package․lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
doc (module)
core/src/doc/asdf.lisp
Next: The net․didierverna․declt․setup/setup․lisp file, Previous: The net․didierverna․declt․core/src/doc/asdf․lisp file, Up: Lisp files [Contents][Index]
doc (module)
src (module)
core/src/declt.lisp
declt (function)
Previous: The net․didierverna․declt․core/src/declt․lisp file, Up: Lisp files [Contents][Index]
net.didierverna.declt.setup (system)
setup/setup.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The quickutil package | ||
| • The net.didierverna.declt package | ||
| • The net.didierverna.declt.setup package |
Next: The net․didierverna․declt package, Previous: Packages, Up: Packages [Contents][Index]
Package that contains the actual utility functions.
quickutil.lisp (file)
qtl
common-lisp
Next: The net․didierverna․declt․setup package, Previous: The quickutil package, Up: Packages [Contents][Index]
The Documentation Extractor from Common Lisp to Texinfo package.
meta.lisp (file)
Previous: The net․didierverna․declt package, Up: Packages [Contents][Index]
Documentation Extractor from Common Lisp to Texinfo.
setup.lisp (file)
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions | ||
| • Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported special variables | ||
| • Exported macros | ||
| • Exported functions |
Next: Exported macros, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
The major level of this release.
setup.lisp (file)
The minor level of this release.
setup.lisp (file)
The name of this release.
The general naming theme for Declt is "Star Trek characters".
setup.lisp (file)
The status of this release.
setup.lisp (file)
The status level of this release.
setup.lisp (file)
Next: Exported functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
Creates new variable bindings, and conditionally executes FORMS.
BINDINGS must be either single binding of the form:
(variable initial-form)
or a list of bindings of the form:
((variable-1 initial-form-1)
(variable-2 initial-form-2)
...
(variable-n initial-form-n))
All initial-forms are executed sequentially in the specified order. Then all
the variables are bound to the corresponding values.
If all variables were bound to true values, then FORMS are executed as an implicit PROGN.
quickutil.lisp (file)
Creates new variable bindings, and conditionally executes FORMS.
BINDINGS must be either single binding of the form:
(variable initial-form)
or a list of bindings of the form:
((variable-1 initial-form-1)
(variable-2 initial-form-2)
...
(variable-n initial-form-n))
Each initial-form is executed in turn, and the variable bound to the
corresponding value. Initial-form expressions can refer to variables
previously bound by the WHEN-LET*.
Execution of WHEN-LET* stops immediately if any initial-form evaluates to NIL. If all initial-forms evaluate to true, then FORMS are executed as an implicit PROGN.
quickutil.lisp (file)
Previous: Exported macros, Up: Exported definitions [Contents][Index]
Return KEY’s value in the current Declt configuration.
setup.lisp (file)
Set KEY to VALUE in the current Declt configuration.
setup.lisp (file)
Generate a reference manual in Texinfo format for ASDF SYSTEM-NAME.
SYSTEM-NAME is an ASDF system designator.
The following keyword arguments are available.
- LIBRARY-NAME: name of the library being documented. Defaults to the system
name.
- TAGLINE: small text to be used as the manual’s subtitle, or NIL.
Defaults to the system long name or description.
- VERSION: version information, or NIL. Defaults to the system version.
- CONTACT: contact information, or NIL. Defaults to the system maintainer(s)
and author(s). Accepts a contact string, or a list of such. See
‘parse-contact-string’ for more information.
- COPYRIGHT-YEARS: copyright years information or NIL. Defaults to the current
year.
- LICENSE: license information. Defaults to NIL. Also accepts :mit, :boost,
:bsd, :gpl, and :lgpl.
- INTRODUCTION: introduction chapter contents. Defaults to NIL.
- CONCLUSION: conclusion chapter contents. Defaults to NIL.
- TEXI-NAME: Texinfo file basename sans extension. Defaults to the system
name.
- TEXI-DIRECTORY: Texinfo file directory. Defaults to the current directory.
- INFO-NAME: Info file basename sans extension. Defaults to TEXI-NAME.
- HYPERLINKS: create hyperlinks to files or directories. Defaults to NIL.
- DECLT-NOTICE: small credit paragraph to Declt, or NIL. Defaults to
:long. Also accepts :short.
INTRODUCTION and CONCLUSION are currently expected to be in Texinfo format.
declt.lisp (file)
Add NICKNAME (:DECLT by default) to the :NET.DIDIERVERNA.DECLT package.
meta.lisp (file)
Return the current version of Declt.
TYPE can be one of :number, :short or :long.
A version number is computed as major*10000 + minor*100 + patchlevel, leaving
two digits for each level. Alpha, beta and rc status are ignored in version
numbers.
A short version is something like 1.3{a,b,rc}4, or 1.3.4 for patchlevel.
Alpha, beta or rc levels start at 1. Patchlevels start at 0 but are ignored
in the output, so that 1.3.0 appears as just 1.3.
A long version is something like
1.3 {alpha,beta,release candidate,patchlevel} 4 "James T. Kirk". As for
the short version, a patchlevel of 0 is ignored in the output.
setup.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal special variables | ||
| • Internal macros | ||
| • Internal functions | ||
| • Internal generic functions | ||
| • Internal structures | ||
| • Internal types |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
The list of definition categories.
Each category is of type (:KEYWORD DESCRIPTION-STRING).
symbol.lisp (file)
The Declt configuration settings.
This variable contains a property list of configuration options.
Current options are:
- :swank-eval-in-emacs (Boolean)
See section A.1 of the user manual for more information.
setup.lisp (file)
An association list of Texinfo fragile (anchor) characters. Elements are the form (CHAR . ALT) where CHAR is the fragile (anchor) character and ALT is an alternative Unicode character.
texi.lisp (file)
declt.lisp (file)
The Declt readtable.
meta.lisp (file)
The numbered, unumbered and appendix section names sorted by level.
texi.lisp (file)
An association list of Texinfo special characters.
Elements are the form (CHAR . COMMAND) where CHAR is the special character and
COMMAND is the name of the corresponding Texinfo alphabetic command.
texi.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
Execute BODY within a @deftp Class NAME environment. NAME is escaped for Texinfo prior to rendering. BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a @deftp {KIND Method Combination} NAME environment.
NAME is escaped for Texinfo prior to rendering.
BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a @deffn {Compiler Macro} NAME LAMBDA-LIST environment.
NAME and LAMBDA-LIST are escaped for Texinfo prior to rendering.
BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a @deftp Condition NAME environment.
NAME is escaped for Texinfo prior to rendering.
BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a @defvr {Constant} NAME environment.
NAME is escaped for Texinfo prior to rendering.
BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a @deffn CATEGORY NAME LAMBDA-LIST environment.
CATEGORY, NAME, LAMBDA-LIST, SPECIALIZERS and QUALIFIERS are escaped for
Texinfo prior to rendering.
BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a @deffn {Generic Function} NAME LAMBDA-LIST environment.
NAME and LAMBDA-LIST are escaped for Texinfo prior to rendering.
BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a @deffn Macro NAME LAMBDA-LIST environment. NAME and LAMBDA-LIST are escaped for Texinfo prior to rendering. BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a @deffn Method NAME LAMBDA-LIST environment.
NAME, LAMBDA-LIST, SPECIALIZERS and QUALIFIERS are escaped for Texinfo prior
to rendering.
BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a @deffn {Setf Expander} NAME LAMBDA-LIST environment.
NAME and LAMBDA-LIST are escaped for Texinfo prior to rendering.
BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a @defvr {Slot} Name environment. NAME is escaped for Texinfo prior to rendering. BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a @defvr {Special Variable} NAME environment.
NAME is escaped for Texinfo prior to rendering.
BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a @deftp Structure NAME environment.
NAME is escaped for Texinfo prior to rendering.
BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a @defvr {Symbol Macro} NAME environment.
NAME is escaped for Texinfo prior to rendering.
BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a @deftp CATEGORY NAME [LAMBDA-LIST] environment. CATEGORY, NAME and LAMBDA-LIST are escaped for Texinfo prior to rendering. BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a @deftp Type NAME [LAMBDA-LIST] environment. NAME and LAMBDA-LIST are escaped for Texinfo prior to rendering. BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a @deffn Function NAME LAMBDA-LIST environment. NAME and LAMBDA-LIST are escaped for Texinfo prior to rendering. BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a @defvr {CATEGORY} NAME environment. CATEGORY and NAME are escaped for Texinfo prior to rendering. BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within an itemize @item. BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within an @itemize KIND environment. BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a @multitable environment. FRACTIONS is the list of column fractions to use. BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a @table KIND environment. BODY should render on *standard-output*.
texi.lisp (file)
Execute BODY within a table @item TITLE. BODY should render on *standard-output*.
texi.lisp (file)
Set SYMBOL’s indentation to INDENT in (X)Emacs.
SYMBOL and INDENT need not be quoted.
See CLINDENT for more information.
meta.lisp (file)
Push OBJECT at the end of PLACE.
misc.lisp (file)
Set the current readtable to the value of NAME::*READTABLE*.
meta.lisp (file)
Render CLASSOID’s definition of KIND in CONTEXT.
symbol.lisp (file)
Render method COMBINATION’s definition of KIND in CONTEXT.
symbol.lisp (file)
Render FUNCOID(S) definition of KIND in CONTEXT.
symbol.lisp (file)
Render METHOD(S) definition in CONTEXT.
GENERIC-SOURCE is the source of the generic function. METHOD(S) sources are
not advertised if they are the same as GENERIC-SOURCE.
symbol.lisp (file)
Execute BODY with *standard-output* redirected to a string. Return that string.
texi.lisp (file)
Render VAROID definition of KIND in CONTEXT.
symbol.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
setup.lisp (file)
Render ANCHOR as an @anchor.
ANCHOR is escaped for Texinfo prior to rendering.
Rendering is done on *standard-output*.
texi.lisp (file)
Render @deffnx CATEGORY NAME LAMBDA-LIST on *standard-output*. CATEGORY, NAME, LAMBDA-LIST, SPECIALIZERS and QUALIFIERS are escaped for Texinfo prior to rendering.
texi.lisp (file)
Render @deffnx {Generic Function} NAME LAMBDA-LIST on *standard-output*
texi.lisp (file)
Render @deffnx Method NAME LAMBDA-LIST on *standard-output*.
NAME, LAMBDA-LIST, SPECIALIZERS and QUALIFIERS are escaped for Texinfo prior
to rendering.
texi.lisp (file)
Render @deffnx {Setf Expander} NAME LAMBDA-LIST on *standard-output*
texi.lisp (file)
Render @deffnx Function NAME LAMBDA-LIST on *standard-output*.
texi.lisp (file)
Render a LIST of items within an @itemize KIND environment.
If RENDERER is non-nil, it must be a function of one argument (every LIST
element) that performs the rendering on *standard-output* directly. Otherwise,
the rendering is done by calling format, as explained below.
- FORMAT is the format string to use for every LIST element.
- KEY is a function of one argument (every LIST element) used to provide
the necessary arguments to the FORMAT string. If multiple arguments are
needed, they should be returned by KEY as multiple values.
texi.lisp (file)
Render ANCHOR as an @ref with online and printed LABEL.
Both ANCHOR and LABEL are escaped for Texinfo prior to rendering.
LABEL is rendered in teletype.
Rendering is done on *standard-output*.
texi.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
Add the STATUS DEFINITIONS categories nodes to PARENT in CONTEXT.
symbol.lisp (file)
Add the STATUS CATEGORY node to PARENT for DEFINITIONS in CONTEXT.
symbol.lisp (file)
Add CHILD node to PARENT node and return CHILD.
texi.lisp (file)
Add CATEGORY kind of DEFINITION for SYMBOL to POOL.
symbol.lisp (file)
Add all definitions to CONTEXT.
declt.lisp (file)
Add the definitions node to PARENT in CONTEXT.
symbol.lisp (file)
Add all external definitions to CONTEXT.
declt.lisp (file)
Add the files node to PARENT in CONTEXT.
asdf.lisp (file)
Add all internal definitions to CONTEXT.
declt.lisp (file)
Add the modules node to PARENT in CONTEXT.
asdf.lisp (file)
Add all package definitions to CONTEXT.
declt.lisp (file)
Add the packages node to PARENT in CONTEXT.
package.lisp (file)
Add the STATUS DEFINITIONS node to PARENT in CONTEXT.
symbol.lisp (file)
Add and return the CATEGORY kind of definition for SYMBOL to pool, if any.
symbol.lisp (file)
Add all categorized definitions for SYMBOL to POOL.
symbol.lisp (file)
Add the systems node to PARENT in CONTEXT.
asdf.lisp (file)
Render ITEM’s anchor.
doc.lisp (file)
Anchor and index ITEM.
doc.lisp (file)
Convert boolean VALUE to a form suitable for feature testing.
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
Set SYMBOL’s indentation to INDENT in (X)Emacs.
This function sets SYMBOL’s common-lisp-indent-function property.
If INDENT is a symbol, use its indentation definition.
Otherwise, INDENT is considered as an indentation definition.
meta.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
Return the list of all components of (sub)TYPE from ASDF MODULE.
asdf.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
Return CONTEXT’s main system directory.
doc.lisp (file)
doc.lisp (file)
doc.lisp (file)
doc.lisp (file)
doc.lisp (file)
doc.lisp (file)
doc.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
doc.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
texi.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
Return the current time as a string.
misc.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
Return DEFINITION’s symbol home package.
symbol.lisp (file)
Return DEFINITION’s symbol home package name.
symbol.lisp (file)
Return OBJECT’s definition source.
symbol.lisp (file)
Return DEFINITION’s source for TYPE.
symbol.lisp (file)
symbol.lisp (file)
Return the number of elements in definitions POOL.
symbol.lisp (file)
Return ASDF SYSTEM’s defsystem dependencies.
misc.lisp (file)
When OBJECT, escape its name for Texinfo.
texi.lisp (file)
When OBJECT, escape its name for use as a Texinfo anchor name.
In addition to regular escaping, periods, commas, colons, and parenthesis are
replaced with alternative Unicode characters.
texi.lisp (file)
When OBJECT, escape its name for use as a Texinfo anchor label.
In addition to regular escaping, colons are replaced with alternative Unicode
characters.
texi.lisp (file)
Return the subset of DEFINITIONS that belong to FILE.
asdf.lisp (file)
Create and return a FILE node in CONTEXT.
asdf.lisp (file)
Return the list of all packages defined in FILE.
asdf.lisp (file)
Finalize the definitions in POOL1 and POOL2.
Currently, this means resolving:
- classes subclasses,
- classes superclasses,
- classes direct methods,
- slots readers,
- slots writers,
- generic functions method combinations,
- method combinations operators (for short ones) and users (for both),
- heterogeneous accessors,
- (generic) functions and macros (short form) setf expanders definitions.
symbol.lisp (file)
Find a method definition for METHOD in POOL. Return NIL if not found.
symbol.lisp (file)
Return the length of the first word in STRING. Initial whitespace characters are skipped.
texi.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
Generate the offline quickutil file.
meta.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
Read an argument list for the DEFINDENT macro.
meta.lisp (file)
Return the list of all Lisp source file components from ASDF MODULE.
asdf.lisp (file)
Return the list of all ASDF SYSTEM’s Lisp source file pathnames. The list includes the system definition file.
asdf.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
doc.lisp (file)
symbol.lisp (file)
Create and return a new definitions pool.
A definitions pool is a hash table of categorized definitions.
Keys must be of the form (NAME :CATEGORY).
- NAME is the symbol naming the definition,
- :CATEGORY is one listed in *CATEGORIES*.
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
texi.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
Return a list of direct slot definitions for CLASS.
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
Like MAPCAN, but work on a definitions POOL.
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
Return METHOD’s name.
Return a second value of T if METHOD is a writer method.
symbol.lisp (file)
Return the list of all module components from ASDF MODULE.
asdf.lisp (file)
Create and return a MODULE node in CONTEXT.
asdf.lisp (file)
texi.lisp (file)
texi.lisp (file)
texi.lisp (file)
texi.lisp (file)
texi.lisp (file)
texi.lisp (file)
texi.lisp (file)
texi.lisp (file)
texi.lisp (file)
texi.lisp (file)
texi.lisp (file)
Return T if OBJECT is a non-empty string.
misc.lisp (file)
Return T if STRING is non empty and does not span multiple lines.
misc.lisp (file)
Return the subset of DEFINITIONS that belong to PACKAGE.
package.lisp (file)
Return the list of external symbols from PACKAGE.
package.lisp (file)
Return the list of internal definitions from PACKAGE.
package.lisp (file)
Parse CONTACT(S) as either a contact string, or a list of such.
A contact string is of the form "My Name <my@address>", both name and
address being optional.
Return two values: a list of name(s) and a list of address(es). The two lists maintain correspondence between names and addresses: they are of the same length and may contain null elements, for contact strings lacking either one.
misc.lisp (file)
Parse STRING as "My Name <my@address>".
Both name and address are optional. If only an address is provided, the angle
brackets may be omitted. Return name and address, as two potentially NIL
values.
misc.lisp (file)
Return a list of all generic definitions in POOL using method COMBINATION.
symbol.lisp (file)
Return METHOD’s qualifiers.
symbol.lisp (file)
Read one line from STREAM.
Return a list of two values:
- the line itself, or STREAM,
- whether a newline character is missing at the end of the line.
texi.lisp (file)
Render COMPONENT’s reference.
asdf.lisp (file)
Return COMPONENT’s location RELATIVE-TO.
asdf.lisp (file)
setup.lisp (file)
Render DEFINITION’s documentation core in CONTEXT.
The documentation core includes all common definition attributes:
- package,
- source location.
Each element is rendered as a table item.
symbol.lisp (file)
Render COMPONENT’s DEPENDENCIES RELATIVE-TO. Optionally PREFIX the title.
asdf.lisp (file)
Render ITEM’s documentation string. Rendering is done on *standard-output*.
doc.lisp (file)
Render references to a list of external DEFINITIONS.
symbol.lisp (file)
Render the header of the Texinfo file.
declt.lisp (file)
Render a headline for DEFINITION. Also anchor and index it.
symbol.lisp (file)
Render CLASSOID’s direct default initargs.
symbol.lisp (file)
Render references to a list of internal DEFINITIONS.
symbol.lisp (file)
Render LAMBDA-LIST with potential SPECIALIZERS.
LAMBDA-LIST and SPECIALIZERS are escaped for Texinfo prior to rendering.
Rendering is done on *standard-output*.
texi.lisp (file)
Render an itemized location line for PATHNAME in CONTEXT. Rendering is done on *standard-output*.
doc.lisp (file)
Render GENERIC definition’s method combination documentation. The standard method combination is not rendered.
symbol.lisp (file)
Render NODE at LEVEL and all its children at LEVEL+1.
texi.lisp (file)
Render a list of PACKAGES references.
asdf.lisp (file)
Render references to a LIST of items.
References are rendered in a table item named TITLE as a list, unless there is
only one item in LIST.
Rendering is done on *standard-output*.
doc.lisp (file)
Render SLOT’s documentation.
symbol.lisp (file)
Render SLOT definition’s PROPERTY value as a table item.
symbol.lisp (file)
Render CLASSOID’s direct slots documentation.
symbol.lisp (file)
Render an itemized source line for ITEM in CONTEXT. Rendering is done on *standard-output*.
doc.lisp (file)
Render TEXT for Texinfo.
Rendering is done on *standard-output*.
The rendering takes care of escaping the text for Texinfo, and attempts to
embellish the output by detecting potential paragraphs from standalone lines.
texi.lisp (file)
Render the whole nodes hierarchy starting at toplevel NODE.
texi.lisp (file)
Render a package use/used-by LIST with TITLE in CONTEXT.
package.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
Return whether SYMBOL defines a setf-expander.
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
Return SLOT definition’s PROPERTY value.
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
Return METHOD’s specializers.
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
Return T if COMPONENT can be found under RELATIVE-TO.
asdf.lisp (file)
Return the list of SYSTEM subsystems RELATIVE-TO. This function recursively descends all found subsystems.
asdf.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
Return the basename part of ASDF SYSTEM’s definition file.
asdf.lisp (file)
Return all SYSTEM dependencies.
This includes both :defsystem-depends-on and :depends-on.
asdf.lisp (file)
Return ASDF SYSTEM’s directory.
asdf.lisp (file)
Return the list of ASDF SYSTEM’s external symbols.
asdf.lisp (file)
Return the name part of ASDF SYSTEM’s definition file.
asdf.lisp (file)
Return the type part of ASDF SYSTEM’s definition file.
asdf.lisp (file)
Return the list of ASDF SYSTEM’s internal symbols.
asdf.lisp (file)
Return the list of located packages defined in ASDF SYSTEM.
These are the packages for which source location is available via
introspection. We can hence verify that the file defining them indeed belongs
to SYSTEM.
asdf.lisp (file)
Create and return a SYSTEM node in CONTEXT.
asdf.lisp (file)
Return the list of packages defined in ASDF SYSTEM.
asdf.lisp (file)
Return the list of unlocated packages defined in ASDF SYSTEM.
These are the packages for which source location is unavailable via
introspection. We thus need to guess. The current heuristic considers packages
named SYSTEM/foobar, regardless of case.
asdf.lisp (file)
Read a series of ~"string" to be concatenated together.
meta.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
Check that STRING is of the form nonblank@nonblank, after trimming. Return that string, or issue a warning and return NIL.
misc.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
symbol.lisp (file)
Next: Internal structures, Previous: Internal functions, Up: Internal definitions [Contents][Index]
Return ITEM’s anchor name.
doc.lisp (file)
Return COMPONENT’s anchor name.
asdf.lisp (file)
Return PACKAGE’s anchor name.
package.lisp (file)
Return METHOD’s qualified symbol name, specializers and qualifiers .
symbol.lisp (file)
Return DEFINITION’s qualified symbol name. This is the default method for most definitions.
symbol.lisp (file)
Surround ITEM’s anchor name with "go to the [...] <type>".
Return all CATEGORY definitions from POOL.
symbol.lisp (file)
Default method used for root CATEGORYs.
Method used for ordinary accessors.
Method used for ordinary writers.
Note that this only returns standalone (toplevel) writers.
Method used for generic accessors.
Method used for generic writers.
Note that this only returns standalone (toplevel) generic writers.
Method used for short method combinations.
Method used for long method combinations.
Method used for setf expanders.
Return a list of definitions using method COMBINATION.
The list may boil down to a generic function definition, but may also contain
both a reader and a writer.
symbol.lisp (file)
Default method, for non generic function definitions. Return nil.
Method for simple generic and writer definitions.
Method for generic accessor definitions.
Return the list of definitions from DEFINITION that belong to FILE.
asdf.lisp (file)
Default method for definitions not containing sub-definitions.
Handle MACRO and its setf expander.
Handle ACCESSOR, its writer and its setf expander.
Handle ACCESSOR-METHOD and its writer method.
Handle GENERIC function and its methods.
Handle GENERIC-ACCESSOR, its generic writer and its setf expander.
Return the list of definitions from DEFINITION that belong to PACKAGE.
package.lisp (file)
Default method for definitions not containing sub-definitions.
Handle MACRO and its setf expander.
Handle ACCESSOR, its writer and its setf expander.
Handle ACCESSOR-METHOD and its writer method.
Handle GENERIC function and its methods.
Handle GENERIC-ACCESSOR, its generic writer and its setf expander.
Return ITEM’s docstring (Lisp documentation).
item.lisp (file)
Return PACKAGE’s docstring.
package.lisp (file)
Return TYPE’s docstring.
symbol.lisp (file)
Return CLASSOID’s docstring.
symbol.lisp (file)
Return method COMBINATION’s docstring.
symbol.lisp (file)
Return SLOT’s docstring.
symbol.lisp (file)
Return setf EXPANDER’s docstring.
symbol.lisp (file)
Return generic WRITER’s docstring.
symbol.lisp (file)
Return METHOD’s docstring.
symbol.lisp (file)
Return WRITER’s docstring.
symbol.lisp (file)
Return COMPILER-MACRO’s docstring.
symbol.lisp (file)
Return FUNCOID’s docstring.
symbol.lisp (file)
Return NIL because symbol macros don’t have a docstring.
symbol.lisp (file)
Return SPECIAL variable’s docstring.
symbol.lisp (file)
Return CONSTANT’s docstring.
symbol.lisp (file)
Render ITEM’s documentation in CONTEXT.
doc.lisp (file)
Render SYSTEM’s documentation in CONTEXT.
asdf.lisp (file)
Render MODULE’s documentation in CONTEXT.
asdf.lisp (file)
Render lisp FILE’s documentation in CONTEXT.
asdf.lisp (file)
Render COMPONENT’s documentation in CONTEXT.
asdf.lisp (file)
Anchor and index COMPONENT in CONTEXT. Document it in a @table environment.
asdf.lisp (file)
Render PACKAGE’s documentation in CONTEXT.
package.lisp (file)
Render TYPE’s documentation in CONTEXT.
symbol.lisp (file)
Render CLASS’s documentation in CONTEXT.
symbol.lisp (file)
Render STRUCTURE’s documentation in CONTEXT.
symbol.lisp (file)
Render CONDITION’s documentation in CONTEXT.
symbol.lisp (file)
Render long method COMBINATION’s documentation in CONTEXT.
symbol.lisp (file)
Render short method COMBINATION’s documentation in CONTEXT.
symbol.lisp (file)
Render setf EXPANDER’s documentation in CONTEXT.
symbol.lisp (file)
Render generic ACCESSOR’s documentation in CONTEXT.
symbol.lisp (file)
Render generic WRITER’s documentation in CONTEXT.
symbol.lisp (file)
Render GENERIC’s documentation in CONTEXT.
symbol.lisp (file)
Render accessor METHOD’s documentation in CONTEXT.
symbol.lisp (file)
Render METHOD’s documentation in CONTEXT. GENERIC-SOURCE is the source of METHOD’s generic function.
symbol.lisp (file)
Render ACCESSOR’s documentation in CONTEXT.
symbol.lisp (file)
Render WRITER’s documentation in CONTEXT.
symbol.lisp (file)
Render FUNCTION’s documentation in CONTEXT.
symbol.lisp (file)
Render COMPILER-MACRO’s documentation in CONTEXT.
symbol.lisp (file)
Render MACRO’s documentation in CONTEXT.
symbol.lisp (file)
Render SYMBOL-MACRO’s documentation in CONTEXT.
symbol.lisp (file)
Render SPECIAL variable’s documentation in CONTEXT.
symbol.lisp (file)
Render CONSTANT’s documentation in CONTEXT.
symbol.lisp (file)
Find a CATEGORY definition for NAME in POOL.
If ERRORP, throw an error if not found. Otherwise, just return NIL.
symbol.lisp (file)
Default method used for root CATEGORYs
Method used to find accessor definitions.
Method used to find writer definitions.
Name must be that of the reader (not the SETF form).
Method used to find generic accessor definitions.
Method used to find generic writer definitions. Name must be that of the reader (not the SETF form).
Return a suitable headline function for DEFINITION.
symbol.lisp (file)
Return #’@DEFUNX.
Return #’@DEFGENERICX.
Return #’@DEFSETFX.
Render ITEM’s indexing command.
doc.lisp (file)
Render SYSTEM’s indexing command.
asdf.lisp (file)
Render MODULE’s indexing command.
asdf.lisp (file)
Render HTML-FILE’s indexing command.
asdf.lisp (file)
Render DOC-FILE’s indexing command.
asdf.lisp (file)
Render STATIC-FILE’s indexing command.
asdf.lisp (file)
Render JAVA-FILE’s indexing command.
asdf.lisp (file)
Render C-FILE’s indexing command.
asdf.lisp (file)
Render LISP-FILE’s indexing command.
asdf.lisp (file)
Render OTHER-FILE’s indexing command.
asdf.lisp (file)
Render PACKAGE’s indexing command.
package.lisp (file)
Render TYPE’s indexing command.
symbol.lisp (file)
Render CLASS’s indexing command.
symbol.lisp (file)
Render STRUCTURE’s indexing command.
symbol.lisp (file)
Render CONDITION’s indexing command.
symbol.lisp (file)
Render long method COMBINATION’s indexing command.
symbol.lisp (file)
Render short method COMBINATION’s indexing command.
symbol.lisp (file)
Render SLOT’s indexing command.
symbol.lisp (file)
Render setf EXPANDER’s indexing command.
symbol.lisp (file)
Render GENERIC’s indexing command.
symbol.lisp (file)
Render METHOD’s indexing command.
symbol.lisp (file)
Render FUNCTION’s indexing command.
symbol.lisp (file)
Render COMPILER-MACRO’s indexing command.
symbol.lisp (file)
Render MACRO’s indexing command.
symbol.lisp (file)
Render SYMBOL-MACRO’s indexing command.
symbol.lisp (file)
Render SPECIAL’s indexing command.
symbol.lisp (file)
Render CONSTANT’s indexing command.
symbol.lisp (file)
Return OBJECT’s lambda-list.
symbol.lisp (file)
Return FUNCTION’s lambda-list.
Return FUNCOID’s lambda-list.
Return setf EXPANDER’s lambda-list.
Return METHOD’s lambda-list.
Return TYPE’s lambda-list.
Return OBJECT’s name as a string.
texi.lisp (file)
Return SOURCE-FILE’s name, possibly adding its extension.
asdf.lisp (file)
Return COMPONENT’s name.
asdf.lisp (file)
Return PACKAGE’s name.
package.lisp (file)
Return setf EXPANDER’s name, that is (setf <name>).
symbol.lisp (file)
Return GENERIC-WRITER’s name, that is (setf <name>).
symbol.lisp (file)
Return WRITER-METHOD’s name, that is (setf <name>).
symbol.lisp (file)
Return WRITER’s name, that is (setf <name>).
symbol.lisp (file)
Return DEFINITION’s symbol name.
symbol.lisp (file)
Princ object to a string.
Return SYMBOL’s name.
Return revealed CHAR.
Return STRING.
Return PATHNAME’s name.
Return a printable form of SPECIALIZER. If QUALIFY, also qualify the symbols.
texi.lisp (file)
Return either SPECIALIZER itself, or its class name when appropriate.
Return the (eql object) list corresponding to SPECIALIZER in a string.
Return a list of reader definitions for SLOT.
symbol.lisp (file)
Defaut method for class and condition slots.
Method for structure slots.
Render ITEM’s reference.
doc.lisp (file)
Render SYSTEM’s reference.
asdf.lisp (file)
Render MODULE’s reference.
asdf.lisp (file)
Render SOURCE-FILE’s reference.
asdf.lisp (file)
Render unreferenced COMPONENT.
asdf.lisp (file)
Render PACKAGE’s reference.
package.lisp (file)
Render DEFINITION’s reference.
symbol.lisp (file)
Render COMPONENT’s DEPENDENCY-DEF RELATIVE-TO.
Dependencies are referenced only if they are RELATIVE-TO the system being
documented. Otherwise, they are just listed.
asdf.lisp (file)
Render COMPONENT’s SIMPLE-COMPONENT-NAME dependency RELATIVE-TO.
Render COMPONENT’s DEPENDENCY-DEF (a list) RELATIVE-TO.
Reveal blanks in OBJECT’s representation.
texi.lisp (file)
Return either CHAR or a non-blank representation for it.
Return STRING with blank characters revealed.
Empty strings are represented by the empty set symbol.
Return ITEM’s definition source pathname.
item.lisp (file)
Return PACKAGE’s definition source.
package.lisp (file)
Return TYPE’s definition source.
symbol.lisp (file)
Return CLASS’s definition source.
symbol.lisp (file)
Return STRUCTURE’s definition source.
symbol.lisp (file)
Return CONDITION’s definition source.
symbol.lisp (file)
Return method COMBINATION’s definition source.
symbol.lisp (file)
Return METHOD’s definition source.
symbol.lisp (file)
symbol.lisp (file)
Return FUNCOID’s definition source.
symbol.lisp (file)
Return SYMBOL-MACRO’s definition source.
symbol.lisp (file)
Return SPECIAL’s definition source.
symbol.lisp (file)
Return CONSTANT’s definition source.
symbol.lisp (file)
Return SYSTEM’s subsystem from DEPENDENCY-DEF or nil.
asdf.lisp (file)
Return SYSTEM’s subsystem named SIMPLE-COMPONENT-NAME or nil.
Return SYSTEM’s subsystem from DEPENDENCY-DEF or nil.
Return ITEM’s title.
doc.lisp (file)
Return COMPONENT’s title.
asdf.lisp (file)
Return PACKAGE’s title.
package.lisp (file)
Surround ITEM’s title with "the [...] <type>".
Return ITEM’s type name.
item.lisp (file)
Return "system"
asdf.lisp (file)
Return "module"
asdf.lisp (file)
Return "file"
asdf.lisp (file)
Return "package".
package.lisp (file)
Return "type"
symbol.lisp (file)
Return "class"
symbol.lisp (file)
Return "structure"
symbol.lisp (file)
Return "condition"
symbol.lisp (file)
Return "long method combination".
symbol.lisp (file)
Return "short method combination".
symbol.lisp (file)
Return "setf expander"
symbol.lisp (file)
Return "method"
symbol.lisp (file)
Return "generic function"
symbol.lisp (file)
Return "function"
symbol.lisp (file)
Return "compiler macro"
symbol.lisp (file)
Return "macro"
symbol.lisp (file)
Return "symbol macro"
symbol.lisp (file)
Return "special variable"
symbol.lisp (file)
Return "constant"
symbol.lisp (file)
Return CONMPONENT’s virtual path.
This is the string of successive component names to access COMPONENT from the
toplevel system, separated by slashes. File components also get their
extension at the end.
asdf.lisp (file)
Default method for all components.
Potentially add SOURCE-FILE’s extension at the end of the virtual path.
Return a list of writer definitions for SLOT.
symbol.lisp (file)
Default method for class and condition slots.
Method for structure slots.
Next: Internal types, Previous: Internal generic functions, Up: Internal definitions [Contents][Index]
Structure for accessor function definitions.
This structure holds a writer and a setf expander definition that expands
this function.
symbol.lisp (file)
function-definition (structure)
accessor-definition-writer (function)
(setf accessor-definition-writer) (function)
accessor-definition-access-expander (function)
(setf accessor-definition-access-expander) (function)
Structure for accessor method definitions. This structure holds the writer method definition.
symbol.lisp (file)
method-definition (structure)
accessor-method-definition-writer (function)
(setf accessor-method-definition-writer) (function)
Structure for class definitions.
This structure holds the direct superclasses and direct subclasses
definitions.
symbol.lisp (file)
classoid-definition (structure)
Base structure for class-like (supporting inheritance) values. This structure holds links to the direct ancestors and descendants definitions, direct methods definitions and direct slots.
symbol.lisp (file)
definition (structure)
docstring (method)
classoid-definition-parents (function)
(setf classoid-definition-parents) (function)
classoid-definition-children (function)
(setf classoid-definition-children) (function)
classoid-definition-methods (function)
(setf classoid-definition-methods) (function)
classoid-definition-slots (function)
(setf classoid-definition-slots) (function)
Structure for method combination definitions.
This structure holds the method combination object and a list of users, that
is, generic functions using this method combination.
symbol.lisp (file)
definition (structure)
combination-definition-combination (function)
(setf combination-definition-combination) (function)
combination-definition-users (function)
(setf combination-definition-users) (function)
Structure for compiler macro definitions.
symbol.lisp (file)
funcoid-definition (structure)
Structure for condition definitions.
symbol.lisp (file)
classoid-definition (structure)
Structure for constant definitions.
symbol.lisp (file)
definition (structure)
The documentation context structure.
doc.lisp (file)
structure-object (structure)
context-systems (function)
(setf context-systems) (function)
context-packages (function)
(setf context-packages) (function)
context-external-definitions (function)
(setf context-external-definitions) (function)
context-internal-definitions (function)
(setf context-internal-definitions) (function)
context-hyperlinksp (function)
(setf context-hyperlinksp) (function)
Base structure for definitions named by symbols.
This structure holds the symbol naming the definition and a slot for marking
foreign definitions, i.e. those which do not pertain to the system being
documented.
symbol.lisp (file)
structure-object (structure)
definition-symbol (function)
(setf definition-symbol) (function)
definition-foreignp (function)
(setf definition-foreignp) (function)
Base structure for definitions of functional values.
This structure holds the generic, ordinary or macro function.
symbol.lisp (file)
definition (structure)
funcoid-definition-function (function)
(setf funcoid-definition-function) (function)
Structure for ordinary function definitions.
This structure holds a setf expander definition that expands to this
function.
symbol.lisp (file)
funcoid-definition (structure)
function-definition-update-expander (function)
(setf function-definition-update-expander) (function)
Structure for generic accessor function definitions.
This structure holds a generic writer and a setf expander definition that
expands this function.
symbol.lisp (file)
generic-definition (structure)
generic-accessor-definition-writer (function)
(setf generic-accessor-definition-writer) (function)
generic-accessor-definition-access-expander (function)
(setf generic-accessor-definition-access-expander) (function)
Structure for generic function definitions.
This structure holds a setf expander definition that expands to this function,
the combination definition and the list of method definitions.
symbol.lisp (file)
funcoid-definition (structure)
generic-definition-update-expander (function)
(setf generic-definition-update-expander) (function)
generic-definition-combination (function)
(setf generic-definition-combination) (function)
generic-definition-methods (function)
(setf generic-definition-methods) (function)
Structure for generic writer function definitions. This structure holds the corresponding reader definition.
symbol.lisp (file)
generic-definition (structure)
generic-writer-definition-reader (function)
(setf generic-writer-definition-reader) (function)
Structure for long method combination definitions.
symbol.lisp (file)
combination-definition (structure)
Structure for macro definitions.
This structure holds a setf expander definition that expands this macro and a
setf expander definition that expands to this macro.
symbol.lisp (file)
funcoid-definition (structure)
macro-definition-access-expander (function)
(setf macro-definition-access-expander) (function)
macro-definition-update-expander (function)
(setf macro-definition-update-expander) (function)
Base structure for method definitions. This structure holds the method object.
symbol.lisp (file)
definition (structure)
method-definition-method (function)
(setf method-definition-method) (function)
The NODE structure.
This structure holds Texinfo nodes.
texi.lisp (file)
structure-object (structure)
node-name (function)
(setf node-name) (function)
node-synopsis (function)
(setf node-synopsis) (function)
:numbered
node-section-type (function)
(setf node-section-type) (function)
node-section-name (function)
(setf node-section-name) (function)
node-next (function)
(setf node-next) (function)
node-previous (function)
(setf node-previous) (function)
node-up (function)
(setf node-up) (function)
node-children (function)
(setf node-children) (function)
node-before-menu-contents (function)
(setf node-before-menu-contents) (function)
node-after-menu-contents (function)
(setf node-after-menu-contents) (function)
Structure for setf expander definitions.
This structure holds the access definition and the update object. For
short forms, this object is a macro or (generic) function definition. For long
forms, it’s a function.
symbol.lisp (file)
definition (structure)
setf-expander-definition-access (function)
(setf setf-expander-definition-access) (function)
setf-expander-definition-update (function)
(setf setf-expander-definition-update) (function)
Structure for short method combination definitions. This structure holds the operator definition.
symbol.lisp (file)
combination-definition (structure)
short-combination-definition-operator (function)
(setf short-combination-definition-operator) (function)
Structure for slot definitions.
This structure holds the slot object and the readers and writers definitions.
symbol.lisp (file)
definition (structure)
slot-definition-slot (function)
(setf slot-definition-slot) (function)
slot-definition-readers (function)
(setf slot-definition-readers) (function)
slot-definition-writers (function)
(setf slot-definition-writers) (function)
Structure for special variables definitions.
symbol.lisp (file)
definition (structure)
Structure for structure definition.
symbol.lisp (file)
classoid-definition (structure)
Structure for symbol macro definitions.
symbol.lisp (file)
definition (structure)
Structure for type definitions.
symbol.lisp (file)
definition (structure)
Structure for ordinary writer function definitions. This structure holds the corresponding reader definition.
symbol.lisp (file)
function-definition (structure)
writer-definition-reader (function)
(setf writer-definition-reader) (function)
Structure for writer method definitions.
symbol.lisp (file)
method-definition (structure)
name (method)
Previous: Internal structures, Up: Internal definitions [Contents][Index]
misc.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index | ||
| • Function index | ||
| • Variable index | ||
| • Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | F L M N |
|---|
| Jump to: | F L M N |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | %
(
@
A B C D E F G H I L M N O P Q R S T V W |
|---|