This is the utilities.print-tree Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri Sep 15 06:55:46 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
utilities.print-treeThis system provides simple facilities for printing tree structures.
Jan Moringen <jmoringe@techfak.uni-bielefeld.de>
Jan Moringen <jmoringe@techfak.uni-bielefeld.de>
LLGPLv3
0.1.0
alexandria (system).
src (module).
readme.org (file).
examples (module).
Modules are listed depth-first from the system components tree.
utilities.print-tree/srcutilities.print-tree (system).
package.lisp (file).
print-tree.lisp (file).
utilities.print-tree/examplesutilities.print-tree (system).
minimal.lisp (file).
asdf.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
utilities.print-tree/utilities.print-tree.asdutilities.print-tree/src/package.lisputilities.print-tree/src/print-tree.lisputilities.print-tree/utilities.print-tree.asdutilities.print-tree (system).
utilities.print-tree/src/print-tree.lisppackage.lisp (file).
src (module).
*use-unicode?* (special variable).
make-folding-node-printer (function).
make-node-printer (function).
print-node-contents (function).
print-subtree (function).
print-tree (function).
+tree-child/final+ (constant).
+tree-child/final/ascii+ (constant).
+tree-child/inner+ (constant).
+tree-child/inner/ascii+ (constant).
+tree-prefix/final+ (constant).
+tree-prefix/final/ascii+ (constant).
+tree-prefix/inner+ (constant).
+tree-prefix/inner/ascii+ (constant).
print-nodes (function).
tree-child (function).
tree-child/ascii (function).
tree-child/unicode (function).
tree-prefix (function).
tree-prefix/ascii (function).
tree-prefix/unicode (function).
utilities.print-tree/README.orgutilities.print-tree/examples/minimal.lisputilities.print-tree/examples/asdf.lispPackages are listed by definition order.
utilities.print-treeThis package provides functions for printing tree structures.
The main entry point is the ‘print-tree’ function. It accepts a
stream, a tree object and a printer function.
In common cases, tree printer functions can be creating using ‘make-node-printer’ or ‘make-folding-node-printer’.
alexandria.
common-lisp.
*use-unicode?* (special variable).
make-folding-node-printer (function).
make-node-printer (function).
print-node-contents (function).
print-subtree (function).
print-tree (function).
+tree-child/final+ (constant).
+tree-child/final/ascii+ (constant).
+tree-child/inner+ (constant).
+tree-child/inner/ascii+ (constant).
+tree-prefix/final+ (constant).
+tree-prefix/final/ascii+ (constant).
+tree-prefix/inner+ (constant).
+tree-prefix/inner/ascii+ (constant).
print-nodes (function).
tree-child (function).
tree-child/ascii (function).
tree-child/unicode (function).
tree-prefix (function).
tree-prefix/ascii (function).
tree-prefix/unicode (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Like ‘make-node-printer’, return a node printer function that used
FIRST-LINE-PRINTER, REST-PRINTER and CHILDREN.
PREDICATE is called to determine whether and to what extend nodes
should be printed. When called with the depth of a node and node as
its arguments, PREDICATE must return a list of "bits" of the node
that should be printed. The following bits are recognized:
:first
Print first line of the node by calling FIRST-LINE-PRINTER?
:content
Print more details for the node by calling REST-PRINTER?
:children
Print children of the node?
:children-ellipsis
Print ellipsis of the form "…", if the node has children
butlast the :children bit has not been specified?
When PREDICATE returns T, all bits are printed.
Return a node printer function that used FIRST-LINE-PRINTER,
REST-PRINTER and CHILDREN.
FIRST-LINE-PRINTER is called with the destination stream, the depth of the node and the node and should print a one-line representation of the node to the stream. The function should return true if REST-PRINTER should be called to print more details for the node.
REST-PRINTER is also called with the destination stream, the depth
of the node and node. It is not restricted to only producing a
single line, however.
CHILDREN is called with a node and must return a (possibly empty) list of children of the node.
Print the tree ROOT to STREAM using PRINTER.
PRINTER is called with four arguments, STREAM, ROOT, the
keyword :root and the integer 0, indicating depth zero. PRINTER
will usually call ‘print-node’, ‘print-subree’ and
‘print-node-contents’ to do the actual work.
Functions suitable for use as PRINTER can, for many common cases, be constructed via ‘make-node-printer’ and ‘make-folding-node-printer’.
| Jump to: | F M P T |
|---|
| Jump to: | F M P T |
|---|
| Jump to: | *
+
C S |
|---|
| Jump to: | *
+
C S |
|---|
| Jump to: | A E F M P R S U |
|---|
| Jump to: | A E F M P R S U |
|---|