This is the cl-dot Reference Manual, version 0.9.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:09:20 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-dotGenerate Dot Output from Arbitrary Lisp Data
Michael Weber <michaelw@foldr.org>
Juho Snellman <jsnell@iki.fi>
0.9.0
uiop (system).
package.lisp (file).
config-graphviz.lisp (file).
attribute.lisp (file).
raw-attributes.lisp (file).
attributes.lisp (file).
cl-dot.lisp (file).
deprecated.lisp (file).
readme.md (file).
copying (file).
changelog (file).
examples (module).
Modules are listed depth-first from the system components tree.
cl-dot/exampleschangelog (file).
cl-dot (system).
class-example (file).
list-example (file).
list-example-old (file).
sb-c-example (file).
subgraph-example (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-dot/cl-dot.asdcl-dot/package.lispcl-dot/config-graphviz.lispcl-dot/attribute.lispcl-dot/raw-attributes.lispcl-dot/attributes.lispcl-dot/cl-dot.lispcl-dot/deprecated.lispcl-dot/config-graphviz.lisppackage.lisp (file).
cl-dot (system).
check-in-path (function).
find-dot (function).
find-neato (function).
cl-dot/attribute.lispconfig-graphviz.lisp (file).
cl-dot (system).
attribute (structure).
attribute-allowed-in (reader).
attribute-foreign-name (reader).
attribute-name (reader).
attribute-type (reader).
context (type).
context-list-p (function).
context-set (type).
foreign-name->lisp-name (function).
make-attribute (function).
cl-dot/raw-attributes.lispattribute.lisp (file).
cl-dot (system).
*attributes* (special variable).
*cluster-styles* (special variable).
*edge-styles* (special variable).
*node-shapes* (special variable).
*node-styles* (special variable).
*predefined-arrow-shapes* (special variable).
cl-dot/attributes.lispraw-attributes.lisp (file).
cl-dot (system).
*cluster-attributes* (special variable).
*edge-attributes* (special variable).
*graph-attributes* (special variable).
*node-attributes* (special variable).
find-attribute (function).
cl-dot/cl-dot.lispattributes.lisp (file).
cl-dot (system).
*dot-path* (special variable).
*neato-path* (special variable).
attributed (class).
attributes-of (reader method).
(setf attributes-of) (writer method).
cluster (class).
dot-graph (function).
edge (class).
edges-of (reader method).
(setf edges-of) (writer method).
generate-graph-from-roots (generic function).
graph (class).
graph-object-cluster (generic function).
graph-object-edges (generic function).
graph-object-knows-of (generic function).
graph-object-node (generic function).
graph-object-pointed-to-by (generic function).
graph-object-points-to (generic function).
id-of (reader method).
(setf id-of) (writer method).
node (class).
nodes-of (reader method).
(setf nodes-of) (writer method).
print-graph (function).
print-object (method).
source-of (reader method).
(setf source-of) (writer method).
target-of (reader method).
(setf target-of) (writer method).
*id* (special variable).
attributes-mixin (class).
cluster-nodes-of (reader method).
(setf cluster-nodes-of) (writer method).
construct-graph (function).
generate-dot (function).
htmlify (function).
id-mixin (class).
object-of (reader method).
(setf object-of) (writer method).
port-mixin (class).
print-attributes (function).
print-defaults (function).
print-key-value (function).
source-port-of (reader method).
(setf source-port-of) (writer method).
target-port-of (reader method).
(setf target-port-of) (writer method).
textify (function).
cl-dot/deprecated.lispcl-dot.lisp (file).
cl-dot (system).
generate-graph (generic function).
object-knows-of (generic function).
object-node (generic function).
object-pointed-to-by (generic function).
object-points-to (generic function).
cl-dot/README.mdcl-dot/COPYINGcl-dot/ChangeLogcl-dot/examples/class-examplecl-dot/examples/list-examplecl-dot/examples/list-example-oldcl-dot/examples/sb-c-examplecl-dot/examples/subgraph-examplePackages are listed by definition order.
cl-dotcommon-lisp.
*dot-path* (special variable).
*neato-path* (special variable).
attributed (class).
attributes-of (generic reader).
(setf attributes-of) (generic writer).
cluster (class).
dot-graph (function).
edge (class).
edges-of (generic reader).
(setf edges-of) (generic writer).
generate-graph (generic function).
generate-graph-from-roots (generic function).
graph (class).
graph-object-cluster (generic function).
graph-object-edges (generic function).
graph-object-knows-of (generic function).
graph-object-node (generic function).
graph-object-pointed-to-by (generic function).
graph-object-points-to (generic function).
id-of (generic reader).
(setf id-of) (generic writer).
node (class).
nodes-of (generic reader).
(setf nodes-of) (generic writer).
object-knows-of (generic function).
object-node (generic function).
object-pointed-to-by (generic function).
object-points-to (generic function).
print-graph (function).
source-of (generic reader).
(setf source-of) (generic writer).
target-of (generic reader).
(setf target-of) (generic writer).
*attributes* (special variable).
*cluster-attributes* (special variable).
*cluster-styles* (special variable).
*edge-attributes* (special variable).
*edge-styles* (special variable).
*graph-attributes* (special variable).
*id* (special variable).
*node-attributes* (special variable).
*node-shapes* (special variable).
*node-styles* (special variable).
*predefined-arrow-shapes* (special variable).
attribute (structure).
attribute-allowed-in (reader).
attribute-foreign-name (reader).
attribute-name (reader).
attribute-type (reader).
attributes-mixin (class).
check-in-path (function).
cluster-nodes-of (generic reader).
(setf cluster-nodes-of) (generic writer).
construct-graph (function).
context (type).
context-list-p (function).
context-set (type).
find-attribute (function).
find-dot (function).
find-neato (function).
foreign-name->lisp-name (function).
generate-dot (function).
htmlify (function).
id-mixin (class).
make-attribute (function).
object-of (generic reader).
(setf object-of) (generic writer).
port-mixin (class).
print-attributes (function).
print-defaults (function).
print-key-value (function).
source-port-of (generic reader).
(setf source-port-of) (generic writer).
target-port-of (generic reader).
(setf target-port-of) (generic writer).
textify (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Path to the dot command
Path to the neato command
Renders GRAPH to OUTFILE by running the program in *DOT-PATH* or *NEATO-PATH* depending on the value of the DIRECTED keyword argument. The default is a directed graph. The default FORMAT is Postscript.
Prints a dot-format representation GRAPH to STREAM.
attributes-mixin)) ¶automatically generated reader method
attributes-mixin)) ¶automatically generated writer method
Construct a GRAPH with ATTRIBUTES starting from OBJECT, using the GRAPH-OBJECT- protocol.
Constructs a GRAPH with ATTRIBUTES starting from OBJECTS, using the GRAPH-OBJECT- protocol.
Returns a CLUSTER instance for this object, or NIL.
The nodes nodes of objects for which this function returns the same cluster are grouped together as a subgraph. This function will only be called once for each object during the generation of a graph.
Returns a sequence of edge specifications.
An edge specification is a list (FROM TO [ATTRIBUTES]), where FROM and TO are objects of the graph and optional ATTRIBUTES is a plist of edge attributes.
Returns a sequence of objects that this object knows should be part of the graph, but which it has no direct connections to.
Returns a NODE instance for this object, or NIL.
In the latter case the object will not be included in the graph, but it can still have an indirect effect via other protocol functions (e.g. GRAPH-OBJECT-KNOWS-OF). This function will only be called once for each object during the generation of a graph.
(eql cl-dot::default)) object) ¶Returns a sequence of objects to which the NODE of this object
should be connected.
The edges will be directed from the other objects to this one. To assign dot attributes to the generated edges, each object can optionally be wrapped in a instance of ATTRIBUTED.
Returns a sequence of objects to which the NODE of this object
should be connected.
The edges will be directed from this object to the others. To assign dot attributes to the generated edges, each object can optionally be wrapped in a instance of ATTRIBUTED.
Return a list of objects that this object knows should be part of the graph, but which it has no direct connections to.
Return a NODE instance for this object, or NIL. In the latter case the object will not be included in the graph, but it can still have an indirect effect via other protocol functions (e.g. OBJECT-KNOWS-OF). This function will only be called once for each object during the generation of a graph.
Return a list of objects to which the NODE of this object should be connected. The edges will be directed from the other objects to this one. To assign dot attributes to the generated edges, each object can optionally be wrapped in a instance of ATTRIBUTED.
Return a list of objects to which the NODE of this object should be connected. The edges will be directed from this object to the others. To assign dot attributes to the generated edges, each object can optionally be wrapped in a instance of ATTRIBUTED.
Wraps an object (initarg :OBJECT) with ‘dot‘ attribute information (a plist, initarg :ATTRIBUTES)
:object
A cluster with ‘dot‘ attributes (a plist, initarg :ATTRIBUTES) and an optional ‘dot‘ id (initarg :ID, autogenerated by default).
A graph node with ‘dot‘ attributes (a plist, initarg :ATTRIBUTES) and an optional ‘dot‘ id (initarg :ID, autogenerated by default).
Find the DOT program using either the environment variable CL_DOT_DOT, search in the user’s path, or search of likely installation locations.
Find the NEATO program using either the environment variable CL_DOT_NEATO, search in the user’s path, or search of likely installation locations.
Return an idiomatic Lisp name derived from the GraphViz name NAME.
attributed)) ¶automatically generated reader method
attributed)) ¶automatically generated writer method
port-mixin)) ¶automatically generated reader method
port-mixin)) ¶automatically generated writer method
port-mixin)) ¶automatically generated reader method
port-mixin)) ¶automatically generated writer method
Description of a GraphViz attribute.
structure-object.
symbol
This slot is read-only.
string
This slot is read-only.
cl-dot::context-set
This slot is read-only.
common-lisp.
(or symbol cons)
This slot is read-only.
(incf cl-dot::*id*)
:id
| Jump to: | (
A C D E F G H I M N O P S T |
|---|
| Jump to: | (
A C D E F G H I M N O P S T |
|---|
| Jump to: | *
A C E F I N O S T |
|---|
| Jump to: | *
A C E F I N O S T |
|---|
| Jump to: | A C D E F G I L M N P R S T |
|---|
| Jump to: | A C D E F G I L M N P R S T |
|---|