This is the utilities.print-items Reference Manual, version 0.3.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon May 15 06:44:50 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
utilities.print-itemsA protocol for flexible and composable printing.
Jan Moringen <jmoringe@techfak.uni-bielefeld.de>
Jan Moringen <jmoringe@techfak.uni-bielefeld.de>
LGPLv3
0.3.0
alexandria (system).
code (module).
readme.org (file).
Modules are listed depth-first from the system components tree.
utilities.print-items/codeutilities.print-items (system).
package.lisp (file).
util.lisp (file).
protocol.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
utilities.print-items/utilities.print-items.asdutilities.print-items/code/package.lisputilities.print-items/code/util.lisputilities.print-items/code/protocol.lisputilities.print-items/utilities.print-items.asdutilities.print-items (system).
utilities.print-items/code/util.lisppackage.lisp (file).
code (module).
cycle-error (condition).
cycle-error-path (reader method).
destructure-item (macro).
item-< (function).
make-node (function).
maybe-convert-legacy-item (function).
node (structure).
node-edges (reader).
(setf node-edges) (writer).
node-object (reader).
node-state (reader).
(setf node-state) (writer).
parse-item (function).
sort-with-partial-order (function).
topological-sort (function).
utilities.print-items/code/protocol.lisputil.lisp (file).
code (module).
effective-print-items (generic function).
format-item (function).
format-items (function).
format-print-items (function).
print-items (generic function).
print-items-mixin (class).
print-object (method).
Packages are listed by definition order.
utilities.print-itemsUtilities for composable printing.
The interface consists of
* ‘print-items’ [generic function]
Methods extend the printed representation of an object in a
composable manner.
* ‘print-items-mixin’ [class]
Can be used to make subclasses the print items mechanism when
passed to ‘print-object’.
* ‘format-items’ [function]
Utility function for formatting print items onto a stream.
print-items
alexandria.
common-lisp.
effective-print-items (generic function).
format-item (function).
format-items (function).
format-print-items (function).
print-items (generic function).
print-items-mixin (class).
cycle-error (condition).
cycle-error-path (generic reader).
destructure-item (macro).
item-< (function).
make-node (function).
maybe-convert-legacy-item (function).
node (structure).
node-edges (reader).
(setf node-edges) (writer).
node-object (reader).
node-state (reader).
(setf node-state) (writer).
parse-item (function).
sort-with-partial-order (function).
topological-sort (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Print ITEMS onto STREAM.
ITEMS is a list of items of the form
(KEY-AND-OPTIONS FORMAT-CONTROL ARGUMENT*)
where
KEY-AND-OPTIONS ::= KEY
| (KEY OPTION*)
KEY ::= any Lisp object
OPTION ::= CONSTRAINT
CONSTRAINT ::= ((:before | :after) KEY)
FORMAT-CONTROL ::= ‘nil’
| a format control string or a formatter function
ARGUMENT ::= any Lisp object
Alias for ‘format-items’.
Return a list of items like ‘print-items’, but filtered and sorted.
Filtering removes all but the first occurrence of multiple items
using the same key.
Sorting arranges the filtered items according to their specified constraints.
Return a list of items that should appear in the printed
representation of OBJECT.
Each method should return a list of items of the form
ITEM ::= (KEY-AND-OPTIONS FORMAT-CONTROL ARGUMENT*)
KEY-AND-OPTIONS ::= KEY
| (KEY OPTION*)
KEY ::= any Lisp object
OPTION ::= CONSTRAINT
CONSTRAINT ::= ((:before | :after) KEY)
FORMAT-CONTROL ::= ‘nil’
| a format control string or a formatter function
ARGUMENT ::= any Lisp object
When multiple items have ‘eql’ KEYs, items appearing closer to the
beginning of the item list take precedence. This mechanism can be
used by subclasses to replace print items produced by
superclasses.
When FORMAT-CONTROL is ‘nil’ the whole item is ignored. This
mechanism can be used by subclasses to disable print items
produced by superclasses.
append.
:most-specific-first
This mixin class adds printing via ‘print-items’ to classes.
Return non-nil if the left item should be placed before the right.
cycle-error)) ¶error.
| Initarg | Value |
|---|---|
:path | (error missing required initarg for class ~s: ~s (quote cycle-error) path) |
:path
This slot is read-only.
| Jump to: | (
C D E F G I M N P S T |
|---|
| Jump to: | (
C D E F G I M N P S T |
|---|
| Jump to: | %
E O S |
|---|
| Jump to: | %
E O S |
|---|
| Jump to: | C F M N P R S U |
|---|
| Jump to: | C F M N P R S U |
|---|