Return DEFINITION’s category name.
system-definition)) ¶Return "system"
module-definition)) ¶Return "module"
file-definition)) ¶Return "file"
package-definition)) ¶Return "package".
alias-definition)) ¶Return the category name of alias DEFINITION’s referee.
slot-definition)) ¶Return "slot".
class-definition)) ¶Return "class".
condition-definition)) ¶Return "condition".
structure-definition)) ¶Return "structure".
writer-method-definition)) ¶Return "writer method".
reader-method-definition)) ¶Return "reader method".
method-definition)) ¶Return "method".
combination-definition)) ¶Return "method combination".
generic-writer-definition)) ¶Return "generic writer".
generic-reader-definition)) ¶Return "generic reader".
generic-function-definition)) ¶Return "generic function".
ordinary-writer-definition)) ¶Return "writer".
ordinary-reader-definition)) ¶Return "reader".
ordinary-function-definition)) ¶Return "function".
expander-definition)) ¶Return "setf expander".
type-definition)) ¶Return "type".
compiler-macro-definition)) ¶Return "compiler macro".
macro-definition)) ¶Return "macro".
symbol-macro-definition)) ¶Return "symbol macro".
special-definition)) ¶Return "special variable".
constant-definition)) ¶Return "constant".
Render DEFINITION’s documentation in CONTEXT.
system-definition) context &key) ¶Render DEFINITION’s system-specific bits in CONTEXT.
module-definition) context &key) ¶Render module DEFINITION’s references in CONTEXT.
lisp-file-definition) context &key) ¶Render lisp file DEFINITION’s references in CONTEXT.
component-definition) context &key) ¶Render ASDF component DEFINITION’s documentation in CONTEXT.
component-definition) context &key) ¶Anchor, index and document component DEFINITION in CONTEXT. Documentation is done in a @table environment.
package-definition) context &key) ¶Render package DEFINITION’s documentation in context.
alias-definition) context &key) ¶Render alias DEFINITION’s documentation in CONTEXT.
typed-structure-slot-definition) context &key) ¶Render typed structure slot DEFINITION’s documentation in CONTEXT. More specifically, render DEFINITION’s reader and writer references.
clos-slot-definition) context &key) ¶Render CLOS slot DEFINITION’s documentation in CONTEXT.
More specifically, render DEFINITION’s reader and writer references.
slot-definition) context &key) ¶Render slot DEFINITION’s documentation in context.
More specifically, render DEFINITION’s value type, and for CLOS slots render
allocation, initform, and initargs.
typed-structure-definition) context &key) ¶Render typed structure DEFINITION’s type documentation in CONTEXT.
clos-classoid-mixin) context &key) ¶Render CLOS classoid mixin DEFINITION’s documentation in CONTEXT. More specifically, render DEFINITION’s direct superclasses, subclasses, methods, and initargs references.
classoid-definition) context &key) ¶Close classoid DEFINITION’s documentation environment in CONTEXT.
More specifically:
- close the @table environment,
- close the @deftp environment.
classoid-definition) context &key) ¶Render classoid DEFINITION’s direct slots references in CONTEXT.
classoid-definition) context &key) ¶Open classoid DEFINITION’s documentation environment in CONTEXT.
More specifically:
- open a @deftp environment,
- anchor and index DEFINITION,
- render DEFINITION’s docstring,
- open a @table environment,
- render DEFINITIONS’s core documentation.
method-definition) context &key inline writer) ¶Open method DEFINITION’s documentation in CONTEXT.
More specifically:
- open a @deffn environment, possibly merging a WRITER method,
- anchor and index DEFINITION,
- render DEFINITION’s docstring,
- open a @table environment,
- render DEFINITION’s source file.
When INLINE, the method definition is documented within its owner’s
documentation. In such a case, the package reference is not rendered (as it is
the same as the owner’s), and the source file is only referenced if different
from that of the owner’s.
short-combination-definition) context &key) ¶Render short method combination DEFINITION’s documentation in CONTEXT.
combination-definition) context &key) ¶Render method combination DEFINITION’s client references in CONTEXT.
generic-writer-definition) context &key) ¶Prevent generic writer DEFINITION from being documented when merging.
generic-reader-definition) context &rest args &key) ¶Check for potential writer merging with generic reader DEFINITION.
generic-function-definition) context &key merged-methods) ¶Close generic function DEFINITION’s documentation.
More specifically:
- render DEFINITION’s method references, possibly merging readers and writers,
- close the @table environment,
- close the @deffn environment.
generic-function-definition) context &key) ¶Render generic function DEFINITION’s combination reference in CONTEXT.
ordinary-writer-definition) context &key) ¶Prevent ordinary writer DEFINITION from being documented when merging.
ordinary-reader-definition) context &rest args &key) ¶Check for potential writer merging with ordinary reader DEFINITION.
short-expander-definition) context &key) ¶Render short expander DEFINITION’s standalone writer reference in CONTEXT.
expander-definition) context &key) ¶Render setf expander DEFINITION’s standalone reader reference in CONTEXT.
long-expander-definition) context &key) ¶Prevent long expander DEFINITION from being documented when merging.
type-definition) context &key) ¶Close type DEFINITION’s documentation environment in CONTEXT.
More specifically:
- close the @table environment,
- close the @deftp environment.
type-definition) context &key) ¶Open type DEFINITION’s documentation environment in CONTEXT.
More specifically:
- open a @deftp environment,
- anchor and index DEFINITION,
- render DEFINITION’s docstring,
- open a @table environment,
- render DEFINITION’s core.
accessor-mixin) context &key) ¶Render accessor mixin DEFINITION’s target slot reference in CONTEXT.
setfable-funcoid-definition) context &key merge-expander) ¶Render setfable funcoid DEFINITION’s expanders information in CONTEXT.
More specifically:
- render a reference to a set expander for DEFINITION, unless the definitions
are merged,
- render references to all setf expanders expanding to DEFINITION.
setfable-funcoid-definition) context &key merge-expander writer) ¶Open setfable funcoid DEFINITION’s documentation environment in CONTEXT.
More specifically:
- open a @deffn environment, possibly merging a related setf expander or
writer,
- anchor and index DEFINITION,
- render DEFINITION’s docstring,
- open a @table environment,
- render DEFINITION’s core documentation.
setfable-funcoid-definition) context &rest args &key) ¶Check for potential expander merging of setfable funcoid DEFINITION.
funcoid-definition) context &key) ¶Close funcoid DEFINITION’s documentation environment in CONTEXT.
More specifically:
- close the @table environment,
- close the @deffn environment.
funcoid-definition) context &key) ¶Open funcoid DEFINITION’s documentation environment in CONTEXT.
More specifically:
- open a @deffn environment,
- anchor and index DEFINITION,
- render DEFINITION’s docstring,
- open a @table environment,
- render DEFINITION’s core documentation.
This is the default method.
varoid-definition) context &key) ¶Close varoid DEFINITION’s documentation environment in CONTEXT.
More specifically:
- close the @table environment,
- close the @defvr environment.
varoid-definition) context &key) ¶Render varoid DEFINITION’s documentation in CONTEXT.
More specifically, render DEFINITION’s package and source file references.
As a special exception, slots don’t reference their package, unless it differs
from the slot’s owner package, and never reference their source file, which is
the same as their owner.
varoid-definition) context &key) ¶Open varoid DEFINITIONS’s documentation environment in CONTEXT.
More specifically:
- open a @defvr environment,
- anchor and index DEFINITION,
- render DEFINITION’s docstring,
- open a @table environment.
Check whether to render foreign DEFINITIONs.
package-definition)) ¶package-definition)) ¶The list of corresponding external symbols.
Return DEFINITION’s index command name.
system-definition)) ¶Return "systemindex"
module-definition)) ¶Return "moduleindex"
file-definition)) ¶Return "fileindex"
package-definition)) ¶Return "packageindex".
alias-definition)) ¶Return the index command name of alias DEFINITION’s referee.
slot-definition)) ¶Return "slotsubindex".
class-definition)) ¶Return "classsubindex".
condition-definition)) ¶Return "conditionsubindex".
structure-definition)) ¶Return "structuresubindex".
method-definition)) ¶Return "methodsubindex".
combination-definition)) ¶Return "combinationsubindex".
generic-function-definition)) ¶Return "genericsubindex".
ordinary-function-definition)) ¶Return "functionsubindex".
expander-definition)) ¶Return "expandersubindex".
type-definition)) ¶Return "typesubindex".
compiler-macro-definition)) ¶Return "compilermacrosubindex".
macro-definition)) ¶Return "macrosubindex".
symbol-macro-definition)) ¶Return "symbolmacrosubindex".
special-definition)) ¶Return "specialsubindex".
constant-definition)) ¶Return "constantsubindex".
package-definition)) ¶package-definition)) ¶The list of corresponding internal symbols.
Return DEFINITION’s safe name, possibly QUALIFIED.
Safe names have blank characters replaced with visible Unicode symbols.
See ‘reveal’ for more information.
file-definition) &optional qualify) ¶Append DEFINITION’s file extension at the end, when applicable.
component-definition) &optional qualified) ¶Reveal component DEFINITION’s name, possibly QUALIFIED.
A QUALIFIED component’s name is of the form "path/to/component", each
element being the name of a component’s parent.
slot-definition) &optional qualified) ¶When QUALIFIED, prepend slot DEFINITION’s classoid safe name.
method-definition) &optional qualified) ¶When QUALIFIED, append method DEFINITION’s qualifiers and specializers.
symbol-definition) &optional qualified) ¶Reveal symbol DEFINITION’s name, possibly QUALIFIED.
A QUALIFIED name is of the form "package:[:]symbol", maybe in a setf list.
Uninterned symbols are denoted by the ∅ package.
definition) &optional qualified) ¶Reveal unqualifiable DEFINITION’s name. This is the default method.
Return DEFINITION’s source pathname.
component-definition)) ¶Return component DEFINITION’s source pathname.
This actually is the corresponding system’s source file.
alias-definition)) ¶Return NIL.
Aliases are defined dynamically so it’s impossible to locate the code
being executed.
slot-definition)) ¶Return slot DEFINITION’s owner source pathname.
combination-definition)) ¶Return method combination DEFINITION’s source pathname.
expander-definition)) ¶Return setf expander DEFINITION’s source pathname.
type-definition)) ¶Return type DEFINITION’s source pathname.
symbol-macro-definition)) ¶Return symbol macro DEFINITION’s source pathname.
special-definition)) ¶Return special DEFINITION’s source pathname.
constant-definition)) ¶Return constant DEFINITION’s source pathname.
Return DEFINITION’s object source pathname (this is the default method).
Stabilize DEFINITION in DEFINITIONS and domestic PACKAGES and PATHNAMES.
progn.
:most-specific-first
system-definition) definitions packages pathnames) ¶Compute system DEFINITION’s defsystem dependency definitions. Those definitions are guaranteed to be in the original system’s order.
module-definition) definitions packages pathnames) ¶Compute module DEFINITION’s child definitions.
Those definitions are guaranteed to be in the module’s original order.
lisp-file-definition) definitions packages pathnames) ¶Compute Lisp file DEFINITION’s definitions list.
component-definition) definitions packages pathnames) ¶Compute component DEFINITION’s parent and dependency definitions. Those definitions are guaranteed to be in the original component’s order.
package-definition) definitions packages pathnames) ¶Compute package DEFINITION’s use, used-by, and definitions lists. New foreign package definitions may be created and added at the end of DEFINITIONS in the process.
function-alias-definition) definitions packages pathnames) ¶Compute simple function alias DEFINITION’s referee.
compiler-macro-alias-definition) definitions packages pathnames) ¶Compute compiler macro alias DEFINITION’s referee.
macro-alias-definition) definitions packages pathnames) ¶Compute macro alias DEFINITION’s referee.
typed-structure-slot-definition) definitions packages pathnames) ¶Compute typed structure slot DEFINITION’s reader and writer definitions.
clos-slot-definition) definitions packages pathnames) ¶Compute CLOS slot DEFINITION’s reader and writer definitions.
clos-classoid-mixin) definitions packages pathnames) ¶Compute classoid DEFINITION’s super/sub classoids, and method definitions.
method-definition) definitions packages pathnames) ¶Compute method DEFINITION’s owner, and specializer references.
short-combination-definition) definitions packages pathnames) ¶Compute short combination DEFINITION’s standalone combinator definition.
combination-definition) definitions packages pathnames) ¶Compute method combination DEFINITION’s users.
generic-function-definition) definitions packages pathnames) ¶Compute generic function DEFINITION’s methods, and combination definition.
short-expander-definition) definitions packages pathnames) ¶Compute short setf expander DEFINITION’s standalone writer definition.
expander-definition) definitions packages pathnames) ¶Compute setf expander DEFINTIION’s standalone reader definition.
setfable-funcoid-definition) definitions packages pathnames) ¶Compute DEFINITION’s expander-for and expanders-to references.
symbol-definition) definitions packages pathnames) ¶Compute symbol DEFINITION’s home package definition.
New foreign package definitions may be created and added at the end of
DEFINITIONS in the process.
definition) definitions packages pathnames) ¶Compute DEFINITION’s source file definition.