The donuts Reference Manual

Table of Contents

The donuts Reference Manual

This is the donuts Reference Manual, version 0.3.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 10:09:28 2019 GMT+0.

1 Introduction

Last Updated : 2012/06/29 21:28:17 tkych

Version : 0.3.1 (beta)

Donuts: Graph Drawing DSL (or Graphviz Interface) for CL

Introduction

Donuts converts a graph represented by S-expression to the image. How to use donuts is simple. <> creates a node. -> puts an edge two nodes. && makes a graph by bundling some nodes, edges and graphs. $$ outputs an image of the graph.

For further details, please see index (Under Translation) or index-ja (Japanease) in doc directory.

The Goal of Donuts

Graphviz is a collection of library and utility for drawing a graph. Dot language is description language, used in Graphviz. Graphviz is very useful. However, I (as a lisp programmer) think there are some points to do kaizen.

1. Since dot language is not Turing-complete, when we draw a graph, we don't take full advantage of the pattern in the graph.

2. Because dot language is so-called compiled language, development cycle is inconvenient.

3. Plain Common Lisp does not have ability to draw graph.

The goal of donuts is to draw graph in lispic way of thought (REPL, macro, CLOS, multi-paradigm style, and so on).

Dependencies

• Graphviz by AT&T Labs

• CL-PPCRE by Dr. Edmund Weitz

• Trivial-Shell by Gary Warren King

Installation & Start

1. CL-REPL> (ql:quickload :donuts)
2. CL-REPL> (in-package :donuts)
3. DONUTS> (dot-output (&& (-> 1 2))) ;output dot code in standard-output
4. DONUTS> ($$ (&& (-> 1 2))) ;output graph image to viewer

Usage

• Node-Constructor, <> makes node from node's identity. (<> label) => node
• Edge-Constructor, -> makes edge between nodes. (-> node1 node2) => edge
• Graph-Constructor, &&, &, [&] makes graph with nodes, edges, graphs. (&& . nodes-edges-graphs) => graph
• Shell-Interface, $$, $ outputs graph to viewer. ($$ graph) => NIL ;output image to viewer
• DOT-OUTPUT outputs dot code in standart-output. (DOT-OUTPUT graph) => NIL ;output dot code

Examples

  DONUTS> (dot-output
            (& (:label "example")
              (-> (<> "a" :shape :box) "b" :color :red)))

  digraph graph_ID_41 {
    label="example";
    node_ID_39 [label="a",shape=box];
    node_ID_39 -> "b" [color=red];
  }
  NIL

  DONUTS> ;; Example from http://graphviz.org/content/cluster
          ($ (:outfile "cluster.pdf")
             (&& ([&] (:label "process #1" :style :filled :color :lightgrey)
                   (with-node (:style :filled :color :white)
                     (--> "a0" "a1" "a2" "a3")))
                 ([&] (:label "process #2" :color :blue)
                   (with-node (:style :filled)
                     (--> "b0" "b1" "b2" "b3")))
                 (->> (<> "start" :shape :Mdiamond) "a0" "b0")
                 (==> "a3" "b3" (<> "end" :shape :Msquare))
                 (->  "a1" "b3")
                 (->  "a3" "a0")
                 (->  "b2" "a3")))

   ; Create cluster.pdf & Output image to viewer
   NIL

   DONUTS> 
   ;; Example from http://www.linuxjournal.com/article/7275
   ;; num-day: total number of days in month
   ;; starting-day: 0 as Sun, 1 as Mon, ... , 6 as Sat
   (defun generate-monthly-calendar (month year num-days starting-day)
     (let ((month     (generate-month-nodes month year))
           (luminary7 (generate-luminary7-nodes))
           (days      (generate-day-nodes num-days starting-day)))
       (apply #'&& (loop :for week :in (cons luminary7 (group days 7)) 
                         :collect (apply #'--> month week)))))

   (defun generate-month-nodes (month year)
     (<> (format nil "~@(~A~)\\n~D" month year) :shape :Msquare))

   (defun generate-luminary7-nodes ()
     (loop :for day :in '("Sun" "Mon" "Tue" "Wed" "Thu" "Fri" "Sat")
           :collect (<> day :shape :egg :style :filled :color :lightgray)))

   (defun generate-day-nodes (num-days starting-day)
     (loop :for day :in (nconc (loop :repeat starting-day :collect "")
                               (loop :for d :from 1 :to num-days :collect d)
                               (loop :repeat (- (* 7 (if (and (= 28 num-days) (= 0 starting-day))
                                                         4 5)) ;for Feb starting Sun in common year
                                                     starting-day num-days)
                                     :collect ""))
           :collect (<> day :shape :box)))

   ;; from On Lisp, e.g. (group '(1 2 3 4) 2) => ((1 2) (3 4))
   (defun group (lst n)
     (if (zerop n) (error "zero length"))
     (labels ((rec (lst acc)
                (let ((rest (nthcdr n lst)))
                  (if (consp rest)
                      (rec rest (cons (subseq lst 0 n)
                                      acc))
                      (nreverse (cons lst acc))))))
       (if lst (rec lst nil) nil)))

   ($$ (& (:size "8,6":rankdir :LR)
         (generate-monthly-calendar 'may 2012 31 2)))

   ; Output Calendar to Viewer
   NIL

   DONUTS> 
   ;; Example from http://www.graphviz.org/doc/info/html2.gv
   ($$ (& (:rankdir :LR)
     (with-node (:shape :plaintext)
       (let ((a (<> (html (table :border 0 :cellborder 1 :cellspacing 0
                                 (tr (td :rowspan 3 :bgcolor :yellow "class"))
                                 (tr (td :port "here" :bgcolor :lightblue "qualfier"))))))
             (b (<> (html (table :bgcolor :bisque
                                 (tr (td :colspan 3 "elephant")
                                     (td :rowspan 2 :bgcolor :chartreuse
                                         :valign :bottom :align :right "two"))
                                 (tr (td :colspan 2 :rowspan 2
                                         (table :bgcolor :grey
                                                (tr (td "corn"))
                                                (tr (td :bgcolor :yellow "c"))
                                                (tr (td "f"))))
                                     (td :bgcolor :white "penguin"))
                                 (tr (td :colspan 2 :border 4 :align :right :port "there" "4"))))
                     :shape :ellipse :style :filled))
             (c (<> (html "long line 1" (br) "line 2" (br :align :left) "line 3" (br :align :right))))
             (d (<> "d" :shape :triangle)))
         (&&
           (~ b c)
           (-> (@ a :here) (@ b :there) :dir :both :arrowtail :diamond)
           (-> c b)
           (-> d c :label (html (table (tr (td :bgcolor :red :width 10)
                                           (td "Edge labels" (br) "also")
                                           (td :bgcolor :blue :width 10))))))))))

   ; Output example to Viewer
   NIL

Grammar

  <donuts-code> ::= '('<output-op> <graph>')'|<node>|<edge>|<graph>|<html-like-label>|<tag>|<common-lisp-code>
  <output-op> ::= 'dot-output'|'dot-pprint'|'$$'|'$' <attr-list>

  <attr-list> ::= '('{<attr>}')'
  <attr> ::= <attr-keyword> <attr-value>

  <graph> ::= '(&&' <graph-elts>')'|'(&' <attr-list> <graph-elts>')'|<cluster>
  <graph-elts> ::= nil|<pre-node>|<node>|<edge>|<graph>|<cluster>|<rank>|<with>|<graph-elts>{ <graph-elts>}
  <cluster> ::= '([&]' <attr-list> <graph-elts>')'

  <pre-node> ::= <number>|<string>
  <node> ::= <pre-node>|'(<>' (<pre-node>|<html-like-label>){ <attr>}')'|<record>|'(@'<node> <port>[ <port>]')'

  <record> ::= '([] "'<record-label>'"'{ <attr>}')'
  <record-label> ::= <field>{'|'<field>}
  <field> ::= [<filed-port> ]{char}|'{'<record-label>'}'
  <filed-port> ::= <keyword>

  <port> ::= <compass-port>|<filed-port>
  <compass-port> ::= :n|:ne|:e|:se|:s|:sw|:w|:nw|:c|:_

  <edge> ::= '('<edge-cons> <node> <node>{ <attr>}')'|'('<multi-edge-cons>{ <node>}')'|'(?' <node>{ <attr>}')'
  <edge-cons> ::= '->'|'--'
  <multi-edge-cons> ::= '-->'|'->>'|'---'|'-<'|'O'

  <rank> ::= '(rank' <rank-keyword>{ <node>}')'|'(~'{ <node>}')'
  <rank-keyword> ::= :same|:min|:max|:source|:sink

  <with> ::= '('<with-op> <attr-list> <graph-elts> ')'
  <with-op> ::= 'with-node'|'with-edge'

  <html-like-label> ::= '(html'{ <tag>| <txt>}')'
  <txt> ::= <string>|<number>
  <tag> ::= '('<tag-cons> <tag-body>')'
  <tag-cons> ::= 'table'|'font'|'i'|'b'|'u'|'sub'|'sup'|'br'|'hr'|'tr'|'vr'|'td'|'img'
  <tag-body> ::= <tag>|<attr>|<txt>|<tag-body>{ <tag-body>}

Author, License, Copyright

• Takaya OCHIAI tkych.repl@gmail.com

• MIT License

• Copyright (C) 2012 Takaya OCHIAI

2 Systems

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

2.1 donuts

Author

Takaya OCHIAI <tkych.repl@gmail.com>

License

MIT licence

Description

Graph DSL for common lisp

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
• trivial-shell

Source

donuts.asd (file)

Components

• in-package.lisp (file)
• cl-utils.lisp (file)
• src (module)
• api-package.lisp (file)

3 Modules

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

3.1 donuts/src

Dependency

cl-utils.lisp (file)

Parent

donuts (system)

Location

src/

Components

• node.lisp (file)
• edge.lisp (file)
• graph.lisp (file)
• dot-output.lisp (file)
• shell.lisp (file)
• html-like-labels.lisp (file)
• donuts-utils.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 donuts.asd

Location

donuts.asd

Systems

donuts (system)

Packages

donuts-asd

4.1.2 donuts/in-package.lisp

Parent

donuts (system)

Location

in-package.lisp

Packages

in-donuts

4.1.3 donuts/cl-utils.lisp

Dependency

in-package.lisp (file)

Parent

donuts (system)

Location

cl-utils.lisp

Internal Definitions

• ^ (macro)
• aif (macro)
• another-name (macro)
• another-names (macro)
• awhen (macro)
• conc1 (function)
• file-to-string (function)
• last1 (function)
• make-sesame (function)
• open-sesame (function)
• sesame (class)
• sesame? (function)
• str (function)
• str->key (function)
• unwind-delfile (macro)
• with-gensyms (macro)

4.1.4 donuts/src/node.lisp

Parent

src (module)

Location

src/node.lisp

Exported Definitions

• <> (function)
• @ (function)
• [] (function)
• rank (function)
• with-node (macro)

Internal Definitions

• *compass* (special variable)
• *rank-pos* (special variable)
• *with-node-context* (special variable)
• compass-port? (function)
• escape-port (function)
• find-port (function)
• name-of (function)
• node (class)
• node? (function)
• port-exist? (function)
• port-proc1 (function)
• port-proc2 (function)
• pre-node? (function)
• rank-pos? (function)
• record (class)
• record? (function)

4.1.5 donuts/src/edge.lisp

Parent

src (module)

Location

src/edge.lisp

Exported Definitions

• -- (function)
• --- (function)
• --> (function)
• -< (function)
• -> (function)
• ->> (function)
• ==> (function)
• with-edge (macro)

Internal Definitions

• *directed?* (special variable)
• *with-edge-context* (special variable)
• converge-edge (class)
• converge-edge? (function)
• edge (class)
• edge? (function)
• normal-edge (class)
• normal-path (class)
• path (class)
• path? (function)
• penetrate-edge (class)
• penetrate-edge? (function)
• penetrate-path (class)
• penetrate-path? (function)
• radiate-edge (class)
• radiate-edge? (function)
• radiate-path (class)
• radiate-path? (function)

4.1.6 donuts/src/graph.lisp

Parent

src (module)

Location

src/graph.lisp

Exported Definitions

• & (macro)
• && (function)
• [&] (macro)

Internal Definitions

• cluster (class)
• cluster? (function)
• graph (class)
• graph? (function)
• make-cluster (function)
• make-graph (function)

4.1.7 donuts/src/dot-output.lisp

Parent

src (module)

Location

src/dot-output.lisp

Exported Definitions

dot-output (function)

Internal Definitions

• *capital-vals* (special variable)
• *declared* (special variable)
• *upper-vals* (special variable)
• *url-attrs* (special variable)
• capital-val? (function)
• declare-node (function)
• declared? (function)
• escape-attrs (function)
• escape-url-attr (function)
• output-buff (function)
• output-edge (generic function)
• output-edge (method)
• output-edge (method)
• output-edge (method)
• output-edge (method)
• output-edge (method)
• output-node (function)
• output-sesame (function)
• output-subgraph (generic function)
• output-subgraph (method)
• output-subgraph (method)
• upper-val? (function)
• url-attr? (function)

4.1.8 donuts/src/shell.lisp

Parent

src (module)

Location

src/shell.lisp

Exported Definitions

• $ (macro)
• dot-pprint (function)

Internal Definitions

• *viewer* (special variable)
• make-dot-file (function)
• make-image (function)
• output-pprint (function)
• show-image (function)

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

Parent

src (module)

Location

src/html-like-labels.lisp

Exported Definitions

• b (function)
• br (function)
• font (function)
• hr (function)
• html (macro)
• i (function)
• img (function)
• sub (function)
• sup (function)
• table (function)
• td (function)
• tr (function)
• u (function)
• vr (function)

Internal Definitions

• def-tag (macro)
• def-tags (macro)
• make-tag (function)
• print-body (function)
• print-tag (function)
• scan-body (function)
• tag (class)
• tag? (function)

4.1.10 donuts/src/donuts-utils.lisp

Parent

src (module)

Location

src/donuts-utils.lisp

Exported Definitions

• $$ (macro)
• ? (function)
• o (function)
• ~ (function)

4.1.11 donuts/api-package.lisp

Dependency

src (module)

Parent

donuts (system)

Location

api-package.lisp

Packages

donuts

5 Packages

Packages are listed by definition order.

5.1 donuts-asd

Source

donuts.asd

Use List

• asdf/interface
• common-lisp

5.2 in-donuts

Source

in-package.lisp (file)

Use List

common-lisp

Exported Definitions

• $ (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)

Internal Definitions

• *capital-vals* (special variable)
• *compass* (special variable)
• *declared* (special variable)
• *directed?* (special variable)
• *rank-pos* (special variable)
• *upper-vals* (special variable)
• *url-attrs* (special variable)
• *viewer* (special variable)
• *with-edge-context* (special variable)
• *with-node-context* (special variable)
• 1st (function)
• 2nd (function)
• ^ (macro)
• aif (macro)
• another-name (macro)
• another-names (macro)
• awhen (macro)
• capital-val? (function)
• cluster (class)
• cluster? (function)
• compass-port? (function)
• conc1 (function)
• converge-edge (class)
• converge-edge? (function)
• declare-node (function)
• declared? (function)
• def-tag (macro)
• def-tags (macro)
• edge (class)
• edge? (function)
• escape-attrs (function)
• escape-port (function)
• escape-url-attr (function)
• file-to-string (function)
• find-port (function)
• graph (class)
• graph? (function)
• last1 (function)
• make-cluster (function)
• make-dot-file (function)
• make-graph (function)
• make-image (function)
• make-inst (generic function)
• make-inst (method)
• make-inst (method)
• make-sesame (function)
• make-tag (function)
• mvbind (macro)
• name-of (function)
• node (class)
• node? (function)
• normal-edge (class)
• normal-path (class)
• open-sesame (function)
• output-buff (function)
• output-edge (generic function)
• output-edge (method)
• output-edge (method)
• output-edge (method)
• output-edge (method)
• output-edge (method)
• output-node (function)
• output-pprint (function)
• output-sesame (function)
• output-subgraph (generic function)
• output-subgraph (method)
• output-subgraph (method)
• path (class)
• path? (function)
• penetrate-edge (class)
• penetrate-edge? (function)
• penetrate-path (class)
• penetrate-path? (function)
• port-exist? (function)
• port-proc1 (function)
• port-proc2 (function)
• pre-node? (function)
• print-body (function)
• print-tag (function)
• radiate-edge (class)
• radiate-edge? (function)
• radiate-path (class)
• radiate-path? (function)
• rank-pos? (function)
• record (class)
• record? (function)
• scan-body (function)
• sesame (class)
• sesame? (function)
• show-image (function)
• str (function)
• str->key (function)
• tag (class)
• tag? (function)
• unwind-delfile (macro)
• upper-val? (function)
• url-attr? (function)
• with-gensyms (macro)
• ~& (function)

5.3 donuts

Source

api-package.lisp (file)

Use List

common-lisp

6 Definitions

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

6.1 Exported definitions

6.1.1 Macros

Macro: $ (&key OUTFILE LAYOUT SHOW) GRAPH

Package

in-donuts

Source

shell.lisp (file)

Macro: $$ GRAPH

Package

in-donuts

Source

donuts-utils.lisp (file)

Macro: & (&rest GRAPH-ATTRS) &body NODES-EDGES-GRAPHS

Package

in-donuts

Source

graph.lisp (file)

Macro: [&] (&rest GRAPH-ATTRS) &body NODES-EDGES-GRAPHS

Package

in-donuts

Source

graph.lisp (file)

Macro: html &rest BODY

Package

in-donuts

Source

html-like-labels.lisp (file)

Macro: with-edge (&rest EDGE-ATTRS) &body BODY

Package

in-donuts

Source

edge.lisp (file)

Macro: with-node (&rest NODE-ATTRS) &body BODY

Package

in-donuts

Source

node.lisp (file)

6.1.2 Functions

Function: && &rest NODES-EDGES-GRAPHS

Package

in-donuts

Source

graph.lisp (file)

Function: -- NODE1 NODE2 &rest PATH-ATTRS

Package

in-donuts

Source

edge.lisp (file)

Function: --- &rest NODES

Package

in-donuts

Source

edge.lisp (file)

Function: --> &rest NODES

Package

in-donuts

Source

edge.lisp (file)

Function: -< ORIGIN-NODE &rest NODES

Package

in-donuts

Source

edge.lisp (file)

Function: -> NODE1 NODE2 &rest EDGE-ATTRS

Package

in-donuts

Source

edge.lisp (file)

Function: ->> ORIGIN-NODE &rest NODES

Package

in-donuts

Source

edge.lisp (file)

Function: <> LABEL &rest NODE-ATTRS

Package

in-donuts

Source

node.lisp (file)

Function: ==> &rest NODES

Package

in-donuts

Source

edge.lisp (file)

Function: ? NODE &rest EDGE-ATTRS

Package

in-donuts

Source

donuts-utils.lisp (file)

Function: @ NODE &rest PORTS

Package

in-donuts

Source

node.lisp (file)

Function: [] LABEL &rest RECORD-ATTRS

Package

in-donuts

Source

node.lisp (file)

Function: b &rest attrs-tag-body-26

Package

in-donuts

Source

html-like-labels.lisp (file)

Function: br &rest attrs-tag-body-0

Package

in-donuts

Source

html-like-labels.lisp (file)

Function: dot-output GRAPH

Package

in-donuts

Source

dot-output.lisp (file)

Function: dot-pprint GRAPH

Package

in-donuts

Source

shell.lisp (file)

Function: font &rest attrs-tag-body-0

Package

in-donuts

Source

html-like-labels.lisp (file)

Function: hr &rest attrs-tag-body-13

Package

in-donuts

Source

html-like-labels.lisp (file)

Function: i &rest attrs-tag-body-13

Package

in-donuts

Source

html-like-labels.lisp (file)

Function: img &rest attrs-tag-body-39

Package

in-donuts

Source

html-like-labels.lisp (file)

Function: o &rest NODES

Package

in-donuts

Source

donuts-utils.lisp (file)

Function: rank POS &rest NODES

Package

in-donuts

Source

node.lisp (file)

Function: sub &rest attrs-tag-body-52

Package

in-donuts

Source

html-like-labels.lisp (file)

Function: sup &rest attrs-tag-body-65

Package

in-donuts

Source

html-like-labels.lisp (file)

Function: table &rest attrs-tag-body-78

Package

in-donuts

Source

html-like-labels.lisp (file)

Function: td &rest attrs-tag-body-104

Package

in-donuts

Source

html-like-labels.lisp (file)

Function: tr &rest attrs-tag-body-91

Package

in-donuts

Source

html-like-labels.lisp (file)

Function: u &rest attrs-tag-body-39

Package

in-donuts

Source

html-like-labels.lisp (file)

Function: vr &rest attrs-tag-body-26

Package

in-donuts

Source

html-like-labels.lisp (file)

Function: ~ &rest NODES

Package

in-donuts

Source

donuts-utils.lisp (file)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *capital-vals*

Package

in-donuts

Source

dot-output.lisp (file)

Special Variable: *compass*

Package

in-donuts

Source

node.lisp (file)

Special Variable: *declared*

Package

in-donuts

Source

dot-output.lisp (file)

Special Variable: *directed?*

Package

in-donuts

Source

edge.lisp (file)

Special Variable: *rank-pos*

Package

in-donuts

Source

node.lisp (file)

Special Variable: *upper-vals*

Package

in-donuts

Source

dot-output.lisp (file)

Special Variable: *url-attrs*

Package

in-donuts

Source

dot-output.lisp (file)

Special Variable: *viewer*

Package

in-donuts

Source

shell.lisp (file)

Special Variable: *with-edge-context*

Package

in-donuts

Source

edge.lisp (file)

Special Variable: *with-node-context*

Package

in-donuts

Source

node.lisp (file)

6.2.2 Macros

Macro: ^ LAMBDALIST &rest BODY

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

Package

in-donuts

Source

cl-utils.lisp (file)

Macro: aif TEST THEN &optional ELSE

Package

in-donuts

Source

cl-utils.lisp (file)

Macro: another-name ALIAS NAME

Package

in-donuts

Source

cl-utils.lisp (file)

Macro: another-names &rest NAMES

Package

in-donuts

Source

cl-utils.lisp (file)

Macro: awhen TEST &body BODY

Package

in-donuts

Source

cl-utils.lisp (file)

Macro: def-tag TAG-NAME &optional PAIR?

Package

in-donuts

Source

html-like-labels.lisp (file)

Macro: def-tags PAIR? NAMES

Package

in-donuts

Source

html-like-labels.lisp (file)

Macro: mvbind VARS VALUE-FORM &body BODY

Package

in-donuts

Source

SYS:SRC;CODE;DEFBOOT.LISP (not found)

Macro: unwind-delfile (FILE) &body BODY

Package

in-donuts

Source

cl-utils.lisp (file)

Macro: with-gensyms SYMS &body BODY

Package

in-donuts

Source

cl-utils.lisp (file)

6.2.3 Functions

Function: 1st LIST

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

Package

in-donuts

Source

SYS:SRC;CODE;LIST.LISP (not found)

Function: 2nd LIST

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

Package

in-donuts

Source

SYS:SRC;CODE;LIST.LISP (not found)

Function: capital-val? X

Package

in-donuts

Source

dot-output.lisp (file)

Function: cluster? X

Package

in-donuts

Source

graph.lisp (file)

Function: compass-port? X

Package

in-donuts

Source

node.lisp (file)

Function: conc1 LST ELT

Package

in-donuts

Source

cl-utils.lisp (file)

Function: converge-edge? X

Package

in-donuts

Source

edge.lisp (file)

Function: declare-node NODE

Package

in-donuts

Source

dot-output.lisp (file)

Function: declared? NODE

Package

in-donuts

Source

dot-output.lisp (file)

Function: edge? X

Package

in-donuts

Source

edge.lisp (file)

Function: escape-attrs ALST

Package

in-donuts

Source

dot-output.lisp (file)

Function: escape-port LABEL

Package

in-donuts

Source

node.lisp (file)

Function: escape-url-attr URL-ATTR

Package

in-donuts

Source

dot-output.lisp (file)

Function: file-to-string FILE

Package

in-donuts

Source

cl-utils.lisp (file)

Function: find-port LABEL

Package

in-donuts

Source

node.lisp (file)

Function: graph? X

Package

in-donuts

Source

graph.lisp (file)

Function: last1 LST

Package

in-donuts

Source

cl-utils.lisp (file)

Function: make-cluster CLUSTER-ATTRS &rest NODES-EDGES-GRAPHS

Package

in-donuts

Source

graph.lisp (file)

Function: make-dot-file GRAPH &optional FILE-NAME PPRINT?

Package

in-donuts

Source

shell.lisp (file)

Function: make-graph GRAPH-ATTRS &rest NODES-EDGES-GRAPHS

Package

in-donuts

Source

graph.lisp (file)

Function: make-image DOT-FILE LAYOUT IMAGE-FILE

Package

in-donuts

Source

shell.lisp (file)

Function: make-sesame TAG TREASURE

Package

in-donuts

Source

cl-utils.lisp (file)

Function: make-tag NAME PAIR? &rest BODY

Package

in-donuts

Source

html-like-labels.lisp (file)

Function: name-of NODE

Package

in-donuts

Source

node.lisp (file)

Function: node? X

Package

in-donuts

Source

node.lisp (file)

Function: open-sesame SESAME

Package

in-donuts

Source

cl-utils.lisp (file)

Function: output-buff BUFF

Package

in-donuts

Source

dot-output.lisp (file)

Function: output-node NODE

Package

in-donuts

Source

dot-output.lisp (file)

Function: output-pprint DOT-FILE

Package

in-donuts

Source

shell.lisp (file)

Function: output-sesame SESAME

Package

in-donuts

Source

dot-output.lisp (file)

Function: path? X

Package

in-donuts

Source

edge.lisp (file)

Function: penetrate-edge? X

Package

in-donuts

Source

edge.lisp (file)

Function: penetrate-path? X

Package

in-donuts

Source

edge.lisp (file)

Function: port-exist? NODE PORT

Package

in-donuts

Source

node.lisp (file)

Function: port-proc1 NODE PORTS

Package

in-donuts

Source

node.lisp (file)

Function: port-proc2 NODE PORTS

Package

in-donuts

Source

node.lisp (file)

Function: pre-node? X

Package

in-donuts

Source

node.lisp (file)

Function: print-body BODY

Package

in-donuts

Source

html-like-labels.lisp (file)

Function: print-tag TAG

Package

in-donuts

Source

html-like-labels.lisp (file)

Function: radiate-edge? X

Package

in-donuts

Source

edge.lisp (file)

Function: radiate-path? X

Package

in-donuts

Source

edge.lisp (file)

Function: rank-pos? X

Package

in-donuts

Source

node.lisp (file)

Function: record? X

Package

in-donuts

Source

node.lisp (file)

Function: scan-body BODY

Package

in-donuts

Source

html-like-labels.lisp (file)

Function: sesame? X

Package

in-donuts

Source

cl-utils.lisp (file)

Function: show-image IMAGE-FILE

Package

in-donuts

Source

shell.lisp (file)

Function: str &rest STRINGS

Package

in-donuts

Source

cl-utils.lisp (file)

Function: str->key STRING

Package

in-donuts

Source

cl-utils.lisp (file)

Function: tag? X

Package

in-donuts

Source

html-like-labels.lisp (file)

Function: upper-val? X

Package

in-donuts

Source

dot-output.lisp (file)

Function: url-attr? X

Package

in-donuts

Source

dot-output.lisp (file)

Function: ~& &optional STREAM

Package

in-donuts

Source

SYS:SRC;CODE;STREAM.LISP (not found)

6.2.4 Generic functions

Generic Function: make-inst CLASS &rest INITARGS &key &allow-other-keys

Package

in-donuts

Source

SYS:SRC;PCL;GENERIC-FUNCTIONS.LISP (not found)

Methods

Method: make-inst (CLASS symbol) &rest INITARGS

Source

SYS:SRC;PCL;INIT.LISP (not found)

Method: make-inst (CLASS class) &rest INITARGS

Source

SYS:SRC;PCL;INIT.LISP (not found)

Generic Function: output-edge EDGE

Package

in-donuts

Source

dot-output.lisp (file)

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 (EDGE edge) around

Generic Function: output-subgraph GRAPH

Package

in-donuts

Source

dot-output.lisp (file)

Methods

Method: output-subgraph (CLUSTER cluster)

Method: output-subgraph (GRAPH graph)

6.2.5 Classes

Class: cluster ()

Package

in-donuts

Source

graph.lisp (file)

Direct superclasses

graph (class)

Direct methods

• output-subgraph (method)
• print-object (method)

Class: converge-edge ()

Package

in-donuts

Source

edge.lisp (file)

Direct superclasses

edge (class)

Direct methods

• output-edge (method)
• print-object (method)
• converge-node (method)
• converge-node (method)
• nodes (method)
• nodes (method)

Direct slots

Slot: nodes

Initargs

:nodes

Readers

nodes (generic function)

Writers

(setf nodes) (generic function)

Slot: converge-node

Initargs

:converge-node

Readers

converge-node (generic function)

Writers

(setf converge-node) (generic function)

Class: edge ()

Package

in-donuts

Source

edge.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• normal-edge (class)
• penetrate-edge (class)
• radiate-edge (class)
• converge-edge (class)
• path (class)

Direct methods

• output-edge (method)
• context (method)
• context (method)
• name (method)
• name (method)

Direct slots

Slot: name

Initargs

:name

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: context

Initargs

:context

Readers

context (generic function)

Writers

(setf context) (generic function)

Class: graph ()

Package

in-donuts

Source

graph.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

cluster (class)

Direct methods

• output-subgraph (method)
• print-object (method)
• strict (method)
• strict (method)
• dir (method)
• dir (method)
• cache (method)
• cache (method)
• buff (method)
• buff (method)
• attrs (method)
• attrs (method)
• name (method)
• name (method)

Direct slots

Slot: name

Initargs

:name

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: attrs

Initargs

:attrs

Readers

attrs (generic function)

Writers

(setf attrs) (generic function)

Slot: buff

Initargs

:buff

Readers

buff (generic function)

Writers

(setf buff) (generic function)

Slot: cache

Initargs

:cache

Readers

cache (generic function)

Writers

(setf cache) (generic function)

Slot: dir

Initargs

:dir

Initform

t

Readers

dir (generic function)

Writers

(setf dir) (generic function)

Slot: strict

Initargs

:strict

Readers

strict (generic function)

Writers

(setf strict) (generic function)

Class: node ()

Package

in-donuts

Source

node.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

record (class)

Direct methods

• print-object (method)
• ports (method)
• ports (method)
• attrs (method)
• attrs (method)
• name (method)
• name (method)

Direct slots

Slot: name

Initargs

:name

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: attrs

Initargs

:attrs

Readers

attrs (generic function)

Writers

(setf attrs) (generic function)

Slot: ports

Initargs

:ports

Readers

ports (generic function)

Writers

(setf ports) (generic function)

Class: normal-edge ()

Package

in-donuts

Source

edge.lisp (file)

Direct superclasses

edge (class)

Direct subclasses

normal-path (class)

Direct methods

• output-edge (method)
• print-object (method)
• attrs (method)
• attrs (method)
• node2 (method)
• node2 (method)
• node1 (method)
• node1 (method)

Direct slots

Slot: node1

Initargs

:node1

Readers

node1 (generic function)

Writers

(setf node1) (generic function)

Slot: node2

Initargs

:node2

Readers

node2 (generic function)

Writers

(setf node2) (generic function)

Slot: attrs

Initargs

:attrs

Readers

attrs (generic function)

Writers

(setf attrs) (generic function)

Class: normal-path ()

Package

in-donuts

Source

edge.lisp (file)

Direct superclasses

• path (class)
• normal-edge (class)

Direct methods

print-object (method)

Class: path ()

Package

in-donuts

Source

edge.lisp (file)

Direct superclasses

edge (class)

Direct subclasses

• normal-path (class)
• penetrate-path (class)
• radiate-path (class)

Class: penetrate-edge ()

Package

in-donuts

Source

edge.lisp (file)

Direct superclasses

edge (class)

Direct subclasses

penetrate-path (class)

Direct methods

• output-edge (method)
• print-object (method)
• nodes (method)
• nodes (method)

Direct slots

Slot: nodes

Initargs

:nodes

Readers

nodes (generic function)

Writers

(setf nodes) (generic function)

Class: penetrate-path ()

Package

in-donuts

Source

edge.lisp (file)

Direct superclasses

• path (class)
• penetrate-edge (class)

Direct methods

print-object (method)

Class: radiate-edge ()

Package

in-donuts

Source

edge.lisp (file)

Direct superclasses

edge (class)

Direct subclasses

radiate-path (class)

Direct methods

• output-edge (method)
• print-object (method)
• nodes (method)
• nodes (method)
• origin-node (method)
• origin-node (method)

Direct slots

Slot: origin-node

Initargs

:origin-node

Readers

origin-node (generic function)

Writers

(setf origin-node) (generic function)

Slot: nodes

Initargs

:nodes

Readers

nodes (generic function)

Writers

(setf nodes) (generic function)

Class: radiate-path ()

Package

in-donuts

Source

edge.lisp (file)

Direct superclasses

• path (class)
• radiate-edge (class)

Direct methods

print-object (method)

Class: record ()

Package

in-donuts

Source

node.lisp (file)

Direct superclasses

node (class)

Direct methods

• ports (method)
• ports (method)

Direct slots

Slot: ports

Initargs

:ports

Readers

ports (generic function)

Writers

(setf ports) (generic function)

Class: sesame ()

Package

in-donuts

Source

cl-utils.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• treasure (method)
• treasure (method)
• tag (method)
• tag (method)

Direct slots

Slot: tag

Initargs

:tag

Readers

tag (generic function)

Writers

(setf tag) (generic function)

Slot: treasure

Initargs

:treasure

Readers

treasure (generic function)

Writers

(setf treasure) (generic function)

Class: tag ()

Package

in-donuts

Source

html-like-labels.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• body (method)
• body (method)
• attrs (method)
• attrs (method)
• pair? (method)
• pair? (method)
• name (method)
• name (method)

Direct slots

Slot: name

Initargs

:name

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: pair?

Initargs

:pair?

Initform

t

Readers

pair? (generic function)

Writers

(setf pair?) (generic function)

Slot: attrs

Initargs

:attrs

Readers

attrs (generic function)

Writers

(setf attrs) (generic function)

Slot: body

Initargs

:body

Readers

body (generic function)

Writers

(setf body) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions