The donuts Reference Manual

This is the donuts Reference Manual, version 0.3.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 08 17:57:57 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 donuts

Graph DSL for common lisp

Author

Takaya OCHIAI <>

License

MIT licence

Long Description

Donuts is Graphviz interface for common lisp.
It requires the Graphviz system (http://www.graphviz.org/).

Version

0.3.1

Dependencies
  • cl-ppcre (system).
  • trivial-shell (system).
Source

donuts.asd.

Child Components

3 Modules

Modules are listed depth-first from the system components tree.


3.1 donuts/src

Dependency

cl-utils.lisp (file).

Source

donuts.asd.

Parent Component

donuts (system).

Child Components

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


4.1 Lisp


4.1.1 donuts/donuts.asd

Source

donuts.asd.

Parent Component

donuts (system).

ASDF Systems

donuts.

Packages

donuts-asd.


4.1.2 donuts/in-package.lisp

Source

donuts.asd.

Parent Component

donuts (system).

Packages

in-donuts.


4.1.3 donuts/cl-utils.lisp

Dependency

in-package.lisp (file).

Source

donuts.asd.

Parent Component

donuts (system).

Public Interface
Internals

4.1.4 donuts/src/node.lisp

Source

donuts.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.5 donuts/src/edge.lisp

Source

donuts.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.6 donuts/src/graph.lisp

Source

donuts.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.7 donuts/src/dot-output.lisp

Source

donuts.asd.

Parent Component

src (module).

Public Interface

dot-output (function).

Internals

4.1.8 donuts/src/shell.lisp

Source

donuts.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.9 donuts/src/html-like-labels.lisp

Source

donuts.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.10 donuts/src/donuts-utils.lisp

Source

donuts.asd.

Parent Component

src (module).

Public Interface
  • $$ (macro).
  • ? (function).
  • o (function).
  • ~ (function).

4.1.11 donuts/api-package.lisp

Dependency

src (module).

Source

donuts.asd.

Parent Component

donuts (system).

Packages

donuts.


5 Packages

Packages are listed by definition order.


5.1 donuts

Source

api-package.lisp.

Use List

common-lisp.


5.2 donuts-asd

Source

donuts.asd.

Use List
  • asdf/interface.
  • common-lisp.

5.3 in-donuts

Source

in-package.lisp.

Use List

common-lisp.

Public Interface
  • $ (macro).
  • $$ (macro).
  • & (macro).
  • && (function).
  • -- (function).
  • --- (function).
  • --> (function).
  • -< (function).
  • -> (function).
  • ->> (function).
  • <> (function).
  • ==> (function).
  • ? (function).
  • @ (function).
  • [&] (macro).
  • [] (function).
  • b (function).
  • br (function).
  • dot-output (function).
  • dot-pprint (function).
  • font (function).
  • hr (function).
  • html (macro).
  • i (function).
  • img (function).
  • o (function).
  • rank (function).
  • sub (function).
  • sup (function).
  • table (function).
  • td (function).
  • tr (function).
  • u (function).
  • vr (function).
  • with-edge (macro).
  • with-node (macro).
  • ~ (function).
Internals

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


6.1 Public Interface


6.1.1 Macros

Macro: $ ((&key outfile layout show) graph)
Package

in-donuts.

Source

shell.lisp.

Macro: $$ (graph)
Package

in-donuts.

Source

donuts-utils.lisp.

Macro: & ((&rest graph-attrs) &body nodes-edges-graphs)
Package

in-donuts.

Source

graph.lisp.

Macro: [&] ((&rest graph-attrs) &body nodes-edges-graphs)
Package

in-donuts.

Source

graph.lisp.

Macro: html (&rest body)
Package

in-donuts.

Source

html-like-labels.lisp.

Macro: with-edge ((&rest edge-attrs) &body body)
Package

in-donuts.

Source

edge.lisp.

Macro: with-node ((&rest node-attrs) &body body)
Package

in-donuts.

Source

node.lisp.


6.1.2 Ordinary functions

Function: && (&rest nodes-edges-graphs)
Package

in-donuts.

Source

graph.lisp.

Function: -- (node1 node2 &rest path-attrs)
Package

in-donuts.

Source

edge.lisp.

Function: --- (&rest nodes)
Package

in-donuts.

Source

edge.lisp.

Function: --> (&rest nodes)
Package

in-donuts.

Source

edge.lisp.

Function: -< (origin-node &rest nodes)
Package

in-donuts.

Source

edge.lisp.

Function: -> (node1 node2 &rest edge-attrs)
Package

in-donuts.

Source

edge.lisp.

Function: ->> (origin-node &rest nodes)
Package

in-donuts.

Source

edge.lisp.

Function: <> (label &rest node-attrs)
Package

in-donuts.

Source

node.lisp.

Function: ==> (&rest nodes)
Package

in-donuts.

Source

edge.lisp.

Function: ? (node &rest edge-attrs)
Package

in-donuts.

Source

donuts-utils.lisp.

Function: @ (node &rest ports)
Package

in-donuts.

Source

node.lisp.

Function: [] (label &rest record-attrs)
Package

in-donuts.

Source

node.lisp.

Function: b (&rest attrs-tag-body-32)
Package

in-donuts.

Source

html-like-labels.lisp.

Function: br (&rest attrs-tag-body-0)
Package

in-donuts.

Source

html-like-labels.lisp.

Function: dot-output (graph)
Package

in-donuts.

Source

dot-output.lisp.

Function: dot-pprint (graph)
Package

in-donuts.

Source

shell.lisp.

Function: font (&rest attrs-tag-body-0)
Package

in-donuts.

Source

html-like-labels.lisp.

Function: hr (&rest attrs-tag-body-16)
Package

in-donuts.

Source

html-like-labels.lisp.

Function: i (&rest attrs-tag-body-16)
Package

in-donuts.

Source

html-like-labels.lisp.

Function: img (&rest attrs-tag-body-48)
Package

in-donuts.

Source

html-like-labels.lisp.

Function: o (&rest nodes)
Package

in-donuts.

Source

donuts-utils.lisp.

Function: rank (pos &rest nodes)
Package

in-donuts.

Source

node.lisp.

Function: sub (&rest attrs-tag-body-64)
Package

in-donuts.

Source

html-like-labels.lisp.

Function: sup (&rest attrs-tag-body-80)
Package

in-donuts.

Source

html-like-labels.lisp.

Function: table (&rest attrs-tag-body-96)
Package

in-donuts.

Source

html-like-labels.lisp.

Function: td (&rest attrs-tag-body-128)
Package

in-donuts.

Source

html-like-labels.lisp.

Function: tr (&rest attrs-tag-body-112)
Package

in-donuts.

Source

html-like-labels.lisp.

Function: u (&rest attrs-tag-body-48)
Package

in-donuts.

Source

html-like-labels.lisp.

Function: vr (&rest attrs-tag-body-32)
Package

in-donuts.

Source

html-like-labels.lisp.

Function: ~ (&rest nodes)
Package

in-donuts.

Source

donuts-utils.lisp.


6.1.3 Standalone methods

Writer Method: (setf attrs) ((graph graph))

automatically generated writer method

Package

keyword.

Source

graph.lisp.

Target Slot

attrs.

Reader Method: attrs ((graph graph))

automatically generated reader method

Package

keyword.

Source

graph.lisp.

Target Slot

attrs.

Writer Method: (setf attrs) ((node node))

automatically generated writer method

Package

keyword.

Source

node.lisp.

Target Slot

attrs.

Reader Method: attrs ((node node))

automatically generated reader method

Package

keyword.

Source

node.lisp.

Target Slot

attrs.

Writer Method: (setf attrs) ((tag tag))

automatically generated writer method

Package

keyword.

Source

html-like-labels.lisp.

Target Slot

attrs.

Reader Method: attrs ((tag tag))

automatically generated reader method

Package

keyword.

Source

html-like-labels.lisp.

Target Slot

attrs.

Writer Method: (setf attrs) ((normal-edge normal-edge))

automatically generated writer method

Package

keyword.

Source

edge.lisp.

Target Slot

attrs.

Reader Method: attrs ((normal-edge normal-edge))

automatically generated reader method

Package

keyword.

Source

edge.lisp.

Target Slot

attrs.

Writer Method: (setf body) ((tag tag))

automatically generated writer method

Package

keyword.

Source

html-like-labels.lisp.

Target Slot

body.

Reader Method: body ((tag tag))

automatically generated reader method

Package

keyword.

Source

html-like-labels.lisp.

Target Slot

body.

Writer Method: (setf buff) ((graph graph))

automatically generated writer method

Package

keyword.

Source

graph.lisp.

Target Slot

buff.

Reader Method: buff ((graph graph))

automatically generated reader method

Package

keyword.

Source

graph.lisp.

Target Slot

buff.

Writer Method: (setf cache) ((graph graph))

automatically generated writer method

Package

keyword.

Source

graph.lisp.

Target Slot

cache.

Reader Method: cache ((graph graph))

automatically generated reader method

Package

keyword.

Source

graph.lisp.

Target Slot

cache.

Writer Method: (setf context) ((edge edge))

automatically generated writer method

Package

keyword.

Source

edge.lisp.

Target Slot

context.

Reader Method: context ((edge edge))

automatically generated reader method

Package

keyword.

Source

edge.lisp.

Target Slot

context.

Writer Method: (setf converge-node) ((converge-edge converge-edge))

automatically generated writer method

Package

keyword.

Source

edge.lisp.

Target Slot

converge-node.

Reader Method: converge-node ((converge-edge converge-edge))

automatically generated reader method

Package

keyword.

Source

edge.lisp.

Target Slot

converge-node.

Writer Method: (setf dir) ((graph graph))

automatically generated writer method

Package

keyword.

Source

graph.lisp.

Target Slot

dir.

Reader Method: dir ((graph graph))

automatically generated reader method

Package

keyword.

Source

graph.lisp.

Target Slot

dir.

Writer Method: (setf name) ((edge edge))

automatically generated writer method

Package

keyword.

Source

edge.lisp.

Target Slot

name.

Reader Method: name ((edge edge))

automatically generated reader method

Package

keyword.

Source

edge.lisp.

Target Slot

name.

Writer Method: (setf name) ((graph graph))

automatically generated writer method

Package

keyword.

Source

graph.lisp.

Target Slot

name.

Reader Method: name ((graph graph))

automatically generated reader method

Package

keyword.

Source

graph.lisp.

Target Slot

name.

Writer Method: (setf name) ((node node))

automatically generated writer method

Package

keyword.

Source

node.lisp.

Target Slot

name.

Reader Method: name ((node node))

automatically generated reader method

Package

keyword.

Source

node.lisp.

Target Slot

name.

Writer Method: (setf name) ((tag tag))

automatically generated writer method

Package

keyword.

Source

html-like-labels.lisp.

Target Slot

name.

Reader Method: name ((tag tag))

automatically generated reader method

Package

keyword.

Source

html-like-labels.lisp.

Target Slot

name.

Writer Method: (setf node1) ((normal-edge normal-edge))

automatically generated writer method

Package

keyword.

Source

edge.lisp.

Target Slot

node1.

Reader Method: node1 ((normal-edge normal-edge))

automatically generated reader method

Package

keyword.

Source

edge.lisp.

Target Slot

node1.

Writer Method: (setf node2) ((normal-edge normal-edge))

automatically generated writer method

Package

keyword.

Source

edge.lisp.

Target Slot

node2.

Reader Method: node2 ((normal-edge normal-edge))

automatically generated reader method

Package

keyword.

Source

edge.lisp.

Target Slot

node2.

Writer Method: (setf nodes) ((converge-edge converge-edge))

automatically generated writer method

Package

keyword.

Source

edge.lisp.

Target Slot

nodes.

Reader Method: nodes ((converge-edge converge-edge))

automatically generated reader method

Package

keyword.

Source

edge.lisp.

Target Slot

nodes.

Writer Method: (setf nodes) ((radiate-edge radiate-edge))

automatically generated writer method

Package

keyword.

Source

edge.lisp.

Target Slot

nodes.

Reader Method: nodes ((radiate-edge radiate-edge))

automatically generated reader method

Package

keyword.

Source

edge.lisp.

Target Slot

nodes.

Writer Method: (setf nodes) ((penetrate-edge penetrate-edge))

automatically generated writer method

Package

keyword.

Source

edge.lisp.

Target Slot

nodes.

Reader Method: nodes ((penetrate-edge penetrate-edge))

automatically generated reader method

Package

keyword.

Source

edge.lisp.

Target Slot

nodes.

Writer Method: (setf origin-node) ((radiate-edge radiate-edge))

automatically generated writer method

Package

keyword.

Source

edge.lisp.

Target Slot

origin-node.

Reader Method: origin-node ((radiate-edge radiate-edge))

automatically generated reader method

Package

keyword.

Source

edge.lisp.

Target Slot

origin-node.

Writer Method: (setf pair?) ((tag tag))

automatically generated writer method

Package

keyword.

Source

html-like-labels.lisp.

Target Slot

pair?.

Reader Method: pair? ((tag tag))

automatically generated reader method

Package

keyword.

Source

html-like-labels.lisp.

Target Slot

pair?.

Writer Method: (setf ports) ((record record))

automatically generated writer method

Package

keyword.

Source

node.lisp.

Target Slot

ports.

Reader Method: ports ((record record))

automatically generated reader method

Package

keyword.

Source

node.lisp.

Target Slot

ports.

Writer Method: (setf ports) ((node node))

automatically generated writer method

Package

keyword.

Source

node.lisp.

Target Slot

ports.

Reader Method: ports ((node node))

automatically generated reader method

Package

keyword.

Source

node.lisp.

Target Slot

ports.

Method: print-object ((obj penetrate-path) stream)
Source

edge.lisp.

Method: print-object ((obj graph) stream)
Source

graph.lisp.

Method: print-object ((obj normal-path) stream)
Source

edge.lisp.

Method: print-object ((obj converge-edge) stream)
Source

edge.lisp.

Method: print-object ((obj radiate-edge) stream)
Source

edge.lisp.

Method: print-object ((obj node) stream)
Source

node.lisp.

Method: print-object ((obj radiate-path) stream)
Source

edge.lisp.

Method: print-object ((obj penetrate-edge) stream)
Source

edge.lisp.

Method: print-object ((obj normal-edge) stream)
Source

edge.lisp.

Method: print-object ((obj cluster) stream)
Source

graph.lisp.

Writer Method: (setf strict) ((graph graph))

automatically generated writer method

Package

keyword.

Source

graph.lisp.

Target Slot

strict.

Reader Method: strict ((graph graph))

automatically generated reader method

Package

keyword.

Source

graph.lisp.

Target Slot

strict.

Writer Method: (setf tag) ((sesame sesame))

automatically generated writer method

Package

keyword.

Source

cl-utils.lisp.

Target Slot

tag.

Reader Method: tag ((sesame sesame))

automatically generated reader method

Package

keyword.

Source

cl-utils.lisp.

Target Slot

tag.

Writer Method: (setf treasure) ((sesame sesame))

automatically generated writer method

Package

keyword.

Source

cl-utils.lisp.

Target Slot

treasure.

Reader Method: treasure ((sesame sesame))

automatically generated reader method

Package

keyword.

Source

cl-utils.lisp.

Target Slot

treasure.


6.2 Internals


6.2.1 Special variables

Special Variable: *capital-vals*
Package

in-donuts.

Source

dot-output.lisp.

Special Variable: *compass*
Package

in-donuts.

Source

node.lisp.

Special Variable: *declared*
Package

in-donuts.

Source

dot-output.lisp.

Special Variable: *directed?*
Package

in-donuts.

Source

edge.lisp.

Special Variable: *rank-pos*
Package

in-donuts.

Source

node.lisp.

Special Variable: *upper-vals*
Package

in-donuts.

Source

dot-output.lisp.

Special Variable: *url-attrs*
Package

in-donuts.

Source

dot-output.lisp.

Special Variable: *viewer*
Package

in-donuts.

Source

shell.lisp.

Special Variable: *with-edge-context*
Package

in-donuts.

Source

edge.lisp.

Special Variable: *with-node-context*
Package

in-donuts.

Source

node.lisp.


6.2.2 Macros

Macro: ^ (lambdalist &rest body)

Abbrev: (^ (x) body) <-> (lambda (x) body)

Package

in-donuts.

Source

cl-utils.lisp.

Macro: aif (test then &optional else)
Package

in-donuts.

Source

cl-utils.lisp.

Macro: another-name (alias name)
Package

in-donuts.

Source

cl-utils.lisp.

Macro: another-names (&rest names)
Package

in-donuts.

Source

cl-utils.lisp.

Macro: awhen (test &body body)
Package

in-donuts.

Source

cl-utils.lisp.

Macro: def-tag (tag-name &optional pair?)
Package

in-donuts.

Source

html-like-labels.lisp.

Macro: def-tags (pair? names)
Package

in-donuts.

Source

html-like-labels.lisp.

Macro: mvbind (vars value-form &body body)
Package

in-donuts.

Alias for

multiple-value-bind.

Macro: unwind-delfile ((file) &body body)
Package

in-donuts.

Source

cl-utils.lisp.

Macro: with-gensyms (syms &body body)
Package

in-donuts.

Source

cl-utils.lisp.


6.2.3 Ordinary functions

Function: 1st (list)

Return the 1st object in a list or NIL if the list is empty.

Package

in-donuts.

Alias for

first.

Function: 2nd (list)

Return the 2nd object in a list or NIL if there is no 2nd object.

Package

in-donuts.

Alias for

second.

Function: capital-val? (x)
Package

in-donuts.

Source

dot-output.lisp.

Function: cluster? (x)
Package

in-donuts.

Source

graph.lisp.

Function: compass-port? (x)
Package

in-donuts.

Source

node.lisp.

Function: conc1 (lst elt)
Package

in-donuts.

Source

cl-utils.lisp.

Function: converge-edge? (x)
Package

in-donuts.

Source

edge.lisp.

Function: declare-node (node)
Package

in-donuts.

Source

dot-output.lisp.

Function: declared? (node)
Package

in-donuts.

Source

dot-output.lisp.

Function: edge? (x)
Package

in-donuts.

Source

edge.lisp.

Function: escape-attrs (alst)
Package

in-donuts.

Source

dot-output.lisp.

Function: escape-port (label)
Package

in-donuts.

Source

node.lisp.

Function: escape-url-attr (url-attr)
Package

in-donuts.

Source

dot-output.lisp.

Function: file-to-string (file)
Package

in-donuts.

Source

cl-utils.lisp.

Function: find-port (label)
Package

in-donuts.

Source

node.lisp.

Function: graph? (x)
Package

in-donuts.

Source

graph.lisp.

Function: last1 (lst)
Package

in-donuts.

Source

cl-utils.lisp.

Function: make-cluster (cluster-attrs &rest nodes-edges-graphs)
Package

in-donuts.

Source

graph.lisp.

Function: make-dot-file (graph &optional file-name pprint?)
Package

in-donuts.

Source

shell.lisp.

Function: make-graph (graph-attrs &rest nodes-edges-graphs)
Package

in-donuts.

Source

graph.lisp.

Function: make-image (dot-file layout image-file)
Package

in-donuts.

Source

shell.lisp.

Function: make-sesame (tag treasure)
Package

in-donuts.

Source

cl-utils.lisp.

Function: make-tag (name pair? &rest body)
Package

in-donuts.

Source

html-like-labels.lisp.

Function: name-of (node)
Package

in-donuts.

Source

node.lisp.

Function: node? (x)
Package

in-donuts.

Source

node.lisp.

Function: open-sesame (sesame)
Package

in-donuts.

Source

cl-utils.lisp.

Function: output-buff (buff)
Package

in-donuts.

Source

dot-output.lisp.

Function: output-node (node)
Package

in-donuts.

Source

dot-output.lisp.

Function: output-pprint (dot-file)
Package

in-donuts.

Source

shell.lisp.

Function: output-sesame (sesame)
Package

in-donuts.

Source

dot-output.lisp.

Function: path? (x)
Package

in-donuts.

Source

edge.lisp.

Function: penetrate-edge? (x)
Package

in-donuts.

Source

edge.lisp.

Function: penetrate-path? (x)
Package

in-donuts.

Source

edge.lisp.

Function: port-exist? (node port)
Package

in-donuts.

Source

node.lisp.

Function: port-proc1 (node ports)
Package

in-donuts.

Source

node.lisp.

Function: port-proc2 (node ports)
Package

in-donuts.

Source

node.lisp.

Function: pre-node? (x)
Package

in-donuts.

Source

node.lisp.

Function: print-body (body)
Package

in-donuts.

Source

html-like-labels.lisp.

Function: print-tag (tag)
Package

in-donuts.

Source

html-like-labels.lisp.

Function: radiate-edge? (x)
Package

in-donuts.

Source

edge.lisp.

Function: radiate-path? (x)
Package

in-donuts.

Source

edge.lisp.

Function: rank-pos? (x)
Package

in-donuts.

Source

node.lisp.

Function: record? (x)
Package

in-donuts.

Source

node.lisp.

Function: scan-body (body)
Package

in-donuts.

Source

html-like-labels.lisp.

Function: sesame? (x)
Package

in-donuts.

Source

cl-utils.lisp.

Function: show-image (image-file)
Package

in-donuts.

Source

shell.lisp.

Function: str (&rest strings)
Package

in-donuts.

Source

cl-utils.lisp.

Function: str->key (string)
Package

in-donuts.

Source

cl-utils.lisp.

Function: tag? (x)
Package

in-donuts.

Source

html-like-labels.lisp.

Function: upper-val? (x)
Package

in-donuts.

Source

dot-output.lisp.

Function: url-attr? (x)
Package

in-donuts.

Source

dot-output.lisp.

Function: ~& (&optional stream)
Package

in-donuts.

Alias for

fresh-line.


6.2.4 Generic functions

Generic Function: make-inst (class &rest initargs &key &allow-other-keys)
Package

in-donuts.

Alias for

make-instance.

Generic Function: output-edge (edge)
Package

in-donuts.

Source

dot-output.lisp.

Methods
Method: output-edge ((edge converge-edge))
Method: output-edge ((edge radiate-edge))
Method: output-edge ((edge penetrate-edge))
Method: output-edge ((edge normal-edge))
Method: output-edge :around ((edge edge))
Generic Function: output-subgraph (graph)
Package

in-donuts.

Source

dot-output.lisp.

Methods
Method: output-subgraph ((cluster cluster))
Method: output-subgraph ((graph graph))

6.2.5 Classes

Class: cluster
Package

in-donuts.

Source

graph.lisp.

Direct superclasses

graph.

Direct methods
Class: converge-edge
Package

in-donuts.

Source

edge.lisp.

Direct superclasses

edge.

Direct methods
Direct slots
Slot: nodes
Initargs

:nodes

Readers

nodes.

Writers

(setf nodes).

Slot: converge-node
Initargs

:converge-node

Readers

converge-node.

Writers

(setf converge-node).

Class: edge
Package

in-donuts.

Source

edge.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name.

Writers

(setf name).

Slot: context
Initargs

:context

Readers

context.

Writers

(setf context).

Class: graph
Package

in-donuts.

Source

graph.lisp.

Direct subclasses

cluster.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name.

Writers

(setf name).

Slot: attrs
Initargs

:attrs

Readers

attrs.

Writers

(setf attrs).

Slot: buff
Initargs

:buff

Readers

buff.

Writers

(setf buff).

Slot: cache
Initargs

:cache

Readers

cache.

Writers

(setf cache).

Slot: dir
Initform

t

Initargs

:dir

Readers

dir.

Writers

(setf dir).

Slot: strict
Initargs

:strict

Readers

strict.

Writers

(setf strict).

Class: node
Package

in-donuts.

Source

node.lisp.

Direct subclasses

record.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name.

Writers

(setf name).

Slot: attrs
Initargs

:attrs

Readers

attrs.

Writers

(setf attrs).

Slot: ports
Initargs

:ports

Readers

ports.

Writers

(setf ports).

Class: normal-edge
Package

in-donuts.

Source

edge.lisp.

Direct superclasses

edge.

Direct subclasses

normal-path.

Direct methods
Direct slots
Slot: node1
Initargs

:node1

Readers

node1.

Writers

(setf node1).

Slot: node2
Initargs

:node2

Readers

node2.

Writers

(setf node2).

Slot: attrs
Initargs

:attrs

Readers

attrs.

Writers

(setf attrs).

Class: normal-path
Package

in-donuts.

Source

edge.lisp.

Direct superclasses
Direct methods

print-object.

Class: path
Package

in-donuts.

Source

edge.lisp.

Direct superclasses

edge.

Direct subclasses
Class: penetrate-edge
Package

in-donuts.

Source

edge.lisp.

Direct superclasses

edge.

Direct subclasses

penetrate-path.

Direct methods
Direct slots
Slot: nodes
Initargs

:nodes

Readers

nodes.

Writers

(setf nodes).

Class: penetrate-path
Package

in-donuts.

Source

edge.lisp.

Direct superclasses
Direct methods

print-object.

Class: radiate-edge
Package

in-donuts.

Source

edge.lisp.

Direct superclasses

edge.

Direct subclasses

radiate-path.

Direct methods
Direct slots
Slot: origin-node
Initargs

:origin-node

Readers

origin-node.

Writers

(setf origin-node).

Slot: nodes
Initargs

:nodes

Readers

nodes.

Writers

(setf nodes).

Class: radiate-path
Package

in-donuts.

Source

edge.lisp.

Direct superclasses
Direct methods

print-object.

Class: record
Package

in-donuts.

Source

node.lisp.

Direct superclasses

node.

Direct methods
Direct slots
Slot: ports
Initargs

:ports

Readers

ports.

Writers

(setf ports).

Class: sesame
Package

in-donuts.

Source

cl-utils.lisp.

Direct methods
Direct slots
Slot: tag
Initargs

:tag

Readers

tag.

Writers

(setf tag).

Slot: treasure
Initargs

:treasure

Readers

treasure.

Writers

(setf treasure).

Class: tag
Package

in-donuts.

Source

html-like-labels.lisp.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name.

Writers

(setf name).

Slot: pair?
Initform

t

Initargs

:pair?

Readers

pair?.

Writers

(setf pair?).

Slot: attrs
Initargs

:attrs

Readers

attrs.

Writers

(setf attrs).

Slot: body
Initargs

:body

Readers

body.

Writers

(setf body).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   $   &   (   -   1   2   <   =   ?   @   [   ^   ~  
A   B   C   D   E   F   G   H   I   L   M   N   O   P   R   S   T   U   V   W  
Index Entry  Section

$
$: Public macros
$$: Public macros

&
&: Public macros
&&: Public ordinary functions

(
(setf attrs): Public standalone methods
(setf attrs): Public standalone methods
(setf attrs): Public standalone methods
(setf attrs): Public standalone methods
(setf body): Public standalone methods
(setf buff): Public standalone methods
(setf cache): Public standalone methods
(setf context): Public standalone methods
(setf converge-node): Public standalone methods
(setf dir): Public standalone methods
(setf name): Public standalone methods
(setf name): Public standalone methods
(setf name): Public standalone methods
(setf name): Public standalone methods
(setf node1): Public standalone methods
(setf node2): Public standalone methods
(setf nodes): Public standalone methods
(setf nodes): Public standalone methods
(setf nodes): Public standalone methods
(setf origin-node): Public standalone methods
(setf pair?): Public standalone methods
(setf ports): Public standalone methods
(setf ports): Public standalone methods
(setf strict): Public standalone methods
(setf tag): Public standalone methods
(setf treasure): Public standalone methods

-
--: Public ordinary functions
---: Public ordinary functions
-->: Public ordinary functions
-<: Public ordinary functions
->: Public ordinary functions
->>: Public ordinary functions

1
1st: Private ordinary functions

2
2nd: Private ordinary functions

<
<>: Public ordinary functions

=
==>: Public ordinary functions

?
?: Public ordinary functions

@
@: Public ordinary functions

[
[&]: Public macros
[]: Public ordinary functions

^
^: Private macros

~
~: Public ordinary functions
~&: Private ordinary functions

A
aif: Private macros
another-name: Private macros
another-names: Private macros
attrs: Public standalone methods
attrs: Public standalone methods
attrs: Public standalone methods
attrs: Public standalone methods
awhen: Private macros

B
b: Public ordinary functions
body: Public standalone methods
br: Public ordinary functions
buff: Public standalone methods

C
cache: Public standalone methods
capital-val?: Private ordinary functions
cluster?: Private ordinary functions
compass-port?: Private ordinary functions
conc1: Private ordinary functions
context: Public standalone methods
converge-edge?: Private ordinary functions
converge-node: Public standalone methods

D
declare-node: Private ordinary functions
declared?: Private ordinary functions
def-tag: Private macros
def-tags: Private macros
dir: Public standalone methods
dot-output: Public ordinary functions
dot-pprint: Public ordinary functions

E
edge?: Private ordinary functions
escape-attrs: Private ordinary functions
escape-port: Private ordinary functions
escape-url-attr: Private ordinary functions

F
file-to-string: Private ordinary functions
find-port: Private ordinary functions
font: Public ordinary functions
Function, &&: Public ordinary functions
Function, --: Public ordinary functions
Function, ---: Public ordinary functions
Function, -->: Public ordinary functions
Function, -<: Public ordinary functions
Function, ->: Public ordinary functions
Function, ->>: Public ordinary functions
Function, 1st: Private ordinary functions
Function, 2nd: Private ordinary functions
Function, <>: Public ordinary functions
Function, ==>: Public ordinary functions
Function, ?: Public ordinary functions
Function, @: Public ordinary functions
Function, b: Public ordinary functions
Function, br: Public ordinary functions
Function, capital-val?: Private ordinary functions
Function, cluster?: Private ordinary functions
Function, compass-port?: Private ordinary functions
Function, conc1: Private ordinary functions
Function, converge-edge?: Private ordinary functions
Function, declare-node: Private ordinary functions
Function, declared?: Private ordinary functions
Function, dot-output: Public ordinary functions
Function, dot-pprint: Public ordinary functions
Function, edge?: Private ordinary functions
Function, escape-attrs: Private ordinary functions
Function, escape-port: Private ordinary functions
Function, escape-url-attr: Private ordinary functions
Function, file-to-string: Private ordinary functions
Function, find-port: Private ordinary functions
Function, font: Public ordinary functions
Function, graph?: Private ordinary functions
Function, hr: Public ordinary functions
Function, i: Public ordinary functions
Function, img: Public ordinary functions
Function, last1: Private ordinary functions
Function, make-cluster: Private ordinary functions
Function, make-dot-file: Private ordinary functions
Function, make-graph: Private ordinary functions
Function, make-image: Private ordinary functions
Function, make-sesame: Private ordinary functions
Function, make-tag: Private ordinary functions
Function, name-of: Private ordinary functions
Function, node?: Private ordinary functions
Function, o: Public ordinary functions
Function, open-sesame: Private ordinary functions
Function, output-buff: Private ordinary functions
Function, output-node: Private ordinary functions
Function, output-pprint: Private ordinary functions
Function, output-sesame: Private ordinary functions
Function, path?: Private ordinary functions
Function, penetrate-edge?: Private ordinary functions
Function, penetrate-path?: Private ordinary functions
Function, port-exist?: Private ordinary functions
Function, port-proc1: Private ordinary functions
Function, port-proc2: Private ordinary functions
Function, pre-node?: Private ordinary functions
Function, print-body: Private ordinary functions
Function, print-tag: Private ordinary functions
Function, radiate-edge?: Private ordinary functions
Function, radiate-path?: Private ordinary functions
Function, rank: Public ordinary functions
Function, rank-pos?: Private ordinary functions
Function, record?: Private ordinary functions
Function, scan-body: Private ordinary functions
Function, sesame?: Private ordinary functions
Function, show-image: Private ordinary functions
Function, str: Private ordinary functions
Function, str->key: Private ordinary functions
Function, sub: Public ordinary functions
Function, sup: Public ordinary functions
Function, table: Public ordinary functions
Function, tag?: Private ordinary functions
Function, td: Public ordinary functions
Function, tr: Public ordinary functions
Function, u: Public ordinary functions
Function, upper-val?: Private ordinary functions
Function, url-attr?: Private ordinary functions
Function, vr: Public ordinary functions
Function, []: Public ordinary functions
Function, ~: Public ordinary functions
Function, ~&: Private ordinary functions

G
Generic Function, make-inst: Private generic functions
Generic Function, output-edge: Private generic functions
Generic Function, output-subgraph: Private generic functions
graph?: Private ordinary functions

H
hr: Public ordinary functions
html: Public macros

I
i: Public ordinary functions
img: Public ordinary functions

L
last1: Private ordinary functions

M
Macro, $: Public macros
Macro, $$: Public macros
Macro, &: Public macros
Macro, aif: Private macros
Macro, another-name: Private macros
Macro, another-names: Private macros
Macro, awhen: Private macros
Macro, def-tag: Private macros
Macro, def-tags: Private macros
Macro, html: Public macros
Macro, mvbind: Private macros
Macro, unwind-delfile: Private macros
Macro, with-edge: Public macros
Macro, with-gensyms: Private macros
Macro, with-node: Public macros
Macro, [&]: Public macros
Macro, ^: Private macros
make-cluster: Private ordinary functions
make-dot-file: Private ordinary functions
make-graph: Private ordinary functions
make-image: Private ordinary functions
make-inst: Private generic functions
make-sesame: Private ordinary functions
make-tag: Private ordinary functions
Method, (setf attrs): Public standalone methods
Method, (setf attrs): Public standalone methods
Method, (setf attrs): Public standalone methods
Method, (setf attrs): Public standalone methods
Method, (setf body): Public standalone methods
Method, (setf buff): Public standalone methods
Method, (setf cache): Public standalone methods
Method, (setf context): Public standalone methods
Method, (setf converge-node): Public standalone methods
Method, (setf dir): Public standalone methods
Method, (setf name): Public standalone methods
Method, (setf name): Public standalone methods
Method, (setf name): Public standalone methods
Method, (setf name): Public standalone methods
Method, (setf node1): Public standalone methods
Method, (setf node2): Public standalone methods
Method, (setf nodes): Public standalone methods
Method, (setf nodes): Public standalone methods
Method, (setf nodes): Public standalone methods
Method, (setf origin-node): Public standalone methods
Method, (setf pair?): Public standalone methods
Method, (setf ports): Public standalone methods
Method, (setf ports): Public standalone methods
Method, (setf strict): Public standalone methods
Method, (setf tag): Public standalone methods
Method, (setf treasure): Public standalone methods
Method, attrs: Public standalone methods
Method, attrs: Public standalone methods
Method, attrs: Public standalone methods
Method, attrs: Public standalone methods
Method, body: Public standalone methods
Method, buff: Public standalone methods
Method, cache: Public standalone methods
Method, context: Public standalone methods
Method, converge-node: Public standalone methods
Method, dir: Public standalone methods
Method, name: Public standalone methods
Method, name: Public standalone methods
Method, name: Public standalone methods
Method, name: Public standalone methods
Method, node1: Public standalone methods
Method, node2: Public standalone methods
Method, nodes: Public standalone methods
Method, nodes: Public standalone methods
Method, nodes: Public standalone methods
Method, origin-node: Public standalone methods
Method, output-edge: Private generic functions
Method, output-edge: Private generic functions
Method, output-edge: Private generic functions
Method, output-edge: Private generic functions
Method, output-edge: Private generic functions
Method, output-subgraph: Private generic functions
Method, output-subgraph: Private generic functions
Method, pair?: Public standalone methods
Method, ports: Public standalone methods
Method, ports: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, strict: Public standalone methods
Method, tag: Public standalone methods
Method, treasure: Public standalone methods
mvbind: Private macros

N
name: Public standalone methods
name: Public standalone methods
name: Public standalone methods
name: Public standalone methods
name-of: Private ordinary functions
node1: Public standalone methods
node2: Public standalone methods
node?: Private ordinary functions
nodes: Public standalone methods
nodes: Public standalone methods
nodes: Public standalone methods

O
o: Public ordinary functions
open-sesame: Private ordinary functions
origin-node: Public standalone methods
output-buff: Private ordinary functions
output-edge: Private generic functions
output-edge: Private generic functions
output-edge: Private generic functions
output-edge: Private generic functions
output-edge: Private generic functions
output-edge: Private generic functions
output-node: Private ordinary functions
output-pprint: Private ordinary functions
output-sesame: Private ordinary functions
output-subgraph: Private generic functions
output-subgraph: Private generic functions
output-subgraph: Private generic functions

P
pair?: Public standalone methods
path?: Private ordinary functions
penetrate-edge?: Private ordinary functions
penetrate-path?: Private ordinary functions
port-exist?: Private ordinary functions
port-proc1: Private ordinary functions
port-proc2: Private ordinary functions
ports: Public standalone methods
ports: Public standalone methods
pre-node?: Private ordinary functions
print-body: Private ordinary functions
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods
print-tag: Private ordinary functions

R
radiate-edge?: Private ordinary functions
radiate-path?: Private ordinary functions
rank: Public ordinary functions
rank-pos?: Private ordinary functions
record?: Private ordinary functions

S
scan-body: Private ordinary functions
sesame?: Private ordinary functions
show-image: Private ordinary functions
str: Private ordinary functions
str->key: Private ordinary functions
strict: Public standalone methods
sub: Public ordinary functions
sup: Public ordinary functions

T
table: Public ordinary functions
tag: Public standalone methods
tag?: Private ordinary functions
td: Public ordinary functions
tr: Public ordinary functions
treasure: Public standalone methods

U
u: Public ordinary functions
unwind-delfile: Private macros
upper-val?: Private ordinary functions
url-attr?: Private ordinary functions

V
vr: Public ordinary functions

W
with-edge: Public macros
with-gensyms: Private macros
with-node: Public macros


A.3 Variables

Jump to:   *  
A   B   C   D   N   O   P   S   T  
Index Entry  Section

*
*capital-vals*: Private special variables
*compass*: Private special variables
*declared*: Private special variables
*directed?*: Private special variables
*rank-pos*: Private special variables
*upper-vals*: Private special variables
*url-attrs*: Private special variables
*viewer*: Private special variables
*with-edge-context*: Private special variables
*with-node-context*: Private special variables

A
attrs: Private classes
attrs: Private classes
attrs: Private classes
attrs: Private classes

B
body: Private classes
buff: Private classes

C
cache: Private classes
context: Private classes
converge-node: Private classes

D
dir: Private classes

N
name: Private classes
name: Private classes
name: Private classes
name: Private classes
node1: Private classes
node2: Private classes
nodes: Private classes
nodes: Private classes
nodes: Private classes

O
origin-node: Private classes

P
pair?: Private classes
ports: Private classes
ports: Private classes

S
Slot, attrs: Private classes
Slot, attrs: Private classes
Slot, attrs: Private classes
Slot, attrs: Private classes
Slot, body: Private classes
Slot, buff: Private classes
Slot, cache: Private classes
Slot, context: Private classes
Slot, converge-node: Private classes
Slot, dir: Private classes
Slot, name: Private classes
Slot, name: Private classes
Slot, name: Private classes
Slot, name: Private classes
Slot, node1: Private classes
Slot, node2: Private classes
Slot, nodes: Private classes
Slot, nodes: Private classes
Slot, nodes: Private classes
Slot, origin-node: Private classes
Slot, pair?: Private classes
Slot, ports: Private classes
Slot, ports: Private classes
Slot, strict: Private classes
Slot, tag: Private classes
Slot, treasure: Private classes
Special Variable, *capital-vals*: Private special variables
Special Variable, *compass*: Private special variables
Special Variable, *declared*: Private special variables
Special Variable, *directed?*: Private special variables
Special Variable, *rank-pos*: Private special variables
Special Variable, *upper-vals*: Private special variables
Special Variable, *url-attrs*: Private special variables
Special Variable, *viewer*: Private special variables
Special Variable, *with-edge-context*: Private special variables
Special Variable, *with-node-context*: Private special variables
strict: Private classes

T
tag: Private classes
treasure: Private classes


A.4 Data types

Jump to:   A   C   D   E   F   G   H   I   M   N   P   R   S   T  
Index Entry  Section

A
api-package.lisp: The donuts/api-package․lisp file

C
cl-utils.lisp: The donuts/cl-utils․lisp file
Class, cluster: Private classes
Class, converge-edge: Private classes
Class, edge: Private classes
Class, graph: Private classes
Class, node: Private classes
Class, normal-edge: Private classes
Class, normal-path: Private classes
Class, path: Private classes
Class, penetrate-edge: Private classes
Class, penetrate-path: Private classes
Class, radiate-edge: Private classes
Class, radiate-path: Private classes
Class, record: Private classes
Class, sesame: Private classes
Class, tag: Private classes
cluster: Private classes
converge-edge: Private classes

D
donuts: The donuts system
donuts: The donuts package
donuts-asd: The donuts-asd package
donuts-utils.lisp: The donuts/src/donuts-utils․lisp file
donuts.asd: The donuts/donuts․asd file
dot-output.lisp: The donuts/src/dot-output․lisp file

E
edge: Private classes
edge.lisp: The donuts/src/edge․lisp file

F
File, api-package.lisp: The donuts/api-package․lisp file
File, cl-utils.lisp: The donuts/cl-utils․lisp file
File, donuts-utils.lisp: The donuts/src/donuts-utils․lisp file
File, donuts.asd: The donuts/donuts․asd file
File, dot-output.lisp: The donuts/src/dot-output․lisp file
File, edge.lisp: The donuts/src/edge․lisp file
File, graph.lisp: The donuts/src/graph․lisp file
File, html-like-labels.lisp: The donuts/src/html-like-labels․lisp file
File, in-package.lisp: The donuts/in-package․lisp file
File, node.lisp: The donuts/src/node․lisp file
File, shell.lisp: The donuts/src/shell․lisp file

G
graph: Private classes
graph.lisp: The donuts/src/graph․lisp file

H
html-like-labels.lisp: The donuts/src/html-like-labels․lisp file

I
in-donuts: The in-donuts package
in-package.lisp: The donuts/in-package․lisp file

M
Module, src: The donuts/src module

N
node: Private classes
node.lisp: The donuts/src/node․lisp file
normal-edge: Private classes
normal-path: Private classes

P
Package, donuts: The donuts package
Package, donuts-asd: The donuts-asd package
Package, in-donuts: The in-donuts package
path: Private classes
penetrate-edge: Private classes
penetrate-path: Private classes

R
radiate-edge: Private classes
radiate-path: Private classes
record: Private classes

S
sesame: Private classes
shell.lisp: The donuts/src/shell․lisp file
src: The donuts/src module
System, donuts: The donuts system

T
tag: Private classes