change package name from s-dot to s-graphviz

jingtaozf · jingtaozf · commit a9587f0cabe2 · 2020-02-13T20:57:24.000+08:00
diff --git a/README.org b/README.org
@@ -8,7 +8,7 @@
 #+PROPERTY: literate-load no
 * Table of Contents                                            :noexport:TOC:
 - [[#introduction][Introduction]]
-- [[#the-s-dot-language][The S-DOT Language]]
+- [[#the-s-graphviz-language][The S-Graphviz Language]]
 - [[#exported-functions][Exported Functions]]
   - [[#format-graph][format-graph]]
   - [[#render-graph][render-graph]]
@@ -23,7 +23,7 @@ This is a S-expression presentation of [[http://www.graphviz.org/][AT&T GraphViz
 The original idea is from http://www.martin-loetzsch.de/S-DOT, but with a full compatiblity of original
 DOT syntax by following its [[https://www.graphviz.org/doc/info/lang.html][lang definition]].
 
-* The S-DOT Language
+* The S-Graphviz Language
 We have a similar presentation with the original [[https://graphviz.gitlab.io/_pages/doc/info/lang.html][DOT Language]], but in a single list.
 #+begin_src lisp :load no
 (graph-type graph-id . graph-statement-list)
@@ -57,16 +57,16 @@ generated DOT file.
 
 * Exported Functions
 This library created a new package named as ~:dot~, and it exports the following functions to
-convert the S-DOT expression to a file can be read as the DOT Language.
+convert the S-Graphviz expression to a file can be read as the DOT Language.
 ** format-graph
 This function accepts a S-expression and a keyword ~:stream~.
-- The S-expression has the syntax of the S-DOT Language.
+- The S-expression has the syntax of the S-Graphviz Language.
 - The stream is nil by default which means it will return a string which can be read as the DOT Language.
   if the stream is not nil, then the target string will be written into this stream directly.
 
   For example, the following lisp expression
 #+BEGIN_SRC lisp :load no
-(dot:format-graph '(:digraph nil
+(graphviz:format-graph '(:digraph nil
                     (node1
                      (:label "nice node")
                      (:shape :box)
@@ -80,16 +80,16 @@ digraph {
 }
 #+end_src
 ** render-graph
-This function is used to render a S-DOT expression to a image type,it accepts the following arguments.
+This function is used to render a S-Graphviz expression to a image type,it accepts the following arguments.
 - a ~file-name~ for the target image,it can be a string or a pathname.
 - a ~S-expression~ for the graph
 - a keyword ~format~ to indicate the image type, it is the file type of ~file-name~ by default.
 - a keyword ~dot-exe~ for the target dot application, it is ~dot~ by default.
 - a keyword ~dot-arguments~ for the additional dot arguments, it is null by default.
 
-For example to render a S-DOT expression to a image file, we can run the following lisp expression.
+For example to render a S-Graphviz expression to a image file, we can run the following lisp expression.
 #+BEGIN_SRC lisp :load no
-(dot:render-graph "/tmp/test1.png"
+(graphviz:render-graph "/tmp/test1.png"
                   '(:digraph ()
                     (= :rankdir "LR")
                     (:-> nil a b c)
@@ -101,18 +101,18 @@ For example to render a S-DOT expression to a image file, we can run the followi
 ** Preparation
 We will store all images in this section in the subdirectory ~images~
 #+BEGIN_SRC lisp :load demo
-(defun render-dot-demo (name s-expression)
-  (dot:render-graph
+(defun render-graphviz-demo (name s-expression)
+  (graphviz:render-graph
    (merge-pathnames
     (format nil "images/~a.png" name)
-    (asdf:component-pathname (asdf:find-system :dot)))
+    (asdf:component-pathname (asdf:find-system :s-graphviz)))
    s-expression))
 #+END_SRC
 
 ** a finite state machine
 The original example is [[https://graphviz.gitlab.io/_pages/Gallery/directed/fsm.html][here]].
 #+BEGIN_SRC lisp :load demo
-(render-dot-demo
+(render-graphviz-demo
  "fsm"
  '(:digraph nil
    (= :rankdir "LR")
@@ -139,7 +139,7 @@ The original example is [[https://graphviz.gitlab.io/_pages/Gallery/directed/fsm
 ** a cluster
 The original example is [[https://graphviz.gitlab.io/_pages/Gallery/directed/cluster.html][here]].
 #+BEGIN_SRC lisp :load demo
-(render-dot-demo
+(render-graphviz-demo
  "cluster2"
  '(:digraph nil
    (:subgraph :cluster_0
@@ -167,7 +167,7 @@ The original example is [[https://graphviz.gitlab.io/_pages/Gallery/directed/clu
 ** add compass point value in a node id
 You can add a compass point value in any node id as you can in the original DOT Language, for example:
 #+BEGIN_SRC lisp :load demo
-(render-dot-demo
+(render-graphviz-demo
  "port"
  '(:digraph nil
    (:-> nil (node1 :e) (node2 :s))))
diff --git a/images/attr.dot b/images/attr.dot
@@ -1,4 +1,4 @@
-// This file is generated automatically by s-dot.
+// This file is generated automatically by S-GRAPHVIZ.
 
 digraph {
   compound = true;
diff --git a/images/cluster1.dot b/images/cluster1.dot
@@ -1,4 +1,4 @@
-// This file is generated automatically by s-dot.
+// This file is generated automatically by S-GRAPHVIZ.
 
 digraph {
   subgraph cluster_1{
diff --git a/images/cluster2.dot b/images/cluster2.dot
@@ -1,4 +1,4 @@
-// This file is generated automatically by s-dot.
+// This file is generated automatically by S-GRAPHVIZ.
 
 digraph {
   subgraph cluster_0{
diff --git a/images/edge1.dot b/images/edge1.dot
@@ -1,4 +1,4 @@
-// This file is generated automatically by s-dot.
+// This file is generated automatically by S-GRAPHVIZ.
 
 digraph {
   node1 -> node2 -> node3 [arrowhead = diamond, color = "#FF0000", headlabel = "head\nlabel", label = "red edge", labelfontname = "Arial", fontname = "courier", arrowsize = 2];
diff --git a/images/fsm.dot b/images/fsm.dot
@@ -1,4 +1,4 @@
-// This file is generated automatically by s-dot.
+// This file is generated automatically by S-GRAPHVIZ.
 
 digraph {
   rankdir = "LR";
diff --git a/images/node1.dot b/images/node1.dot
@@ -1,4 +1,4 @@
-// This file is generated automatically by s-dot.
+// This file is generated automatically by S-GRAPHVIZ.
 
 digraph {
   node1 [label = "nice node", shape = box, fontname = "Arial", fontcolor = "#AA0000"];
diff --git a/images/node2.dot b/images/node2.dot
@@ -1,4 +1,4 @@
-// This file is generated automatically by s-dot.
+// This file is generated automatically by S-GRAPHVIZ.
 
 digraph {
   node [fillcolor = "#AAFFAA", shape = circle, color = "#0000AA", style = filled, fontsize = 16];
diff --git a/images/port.dot b/images/port.dot
@@ -1,4 +1,4 @@
-// This file is generated automatically by S-DOT.
+// This file is generated automatically by S-GRAPHVIZ.
 
 digraph {
   node1 : e -> node2 : s;
diff --git a/images/statements.dot b/images/statements.dot
@@ -1,4 +1,4 @@
-// This file is generated automatically by s-dot.
+// This file is generated automatically by S-GRAPHVIZ.
 
 digraph {
   rankdir = "LR";
diff --git a/s-graphviz.asd b/s-graphviz.asd
@@ -2,13 +2,13 @@
 (in-package :asdf)
 
 (eval-when (:compile-toplevel :load-toplevel :execute)
-  (unless (find-package :dot.system)
-    (defpackage :dot.system
+  (unless (find-package :s-graphviz.system)
+    (defpackage :s-graphviz.system
       (:use :cl :asdf))))
 
-(in-package :dot.system)
+(in-package :s-graphviz.system)
 
-(asdf:defsystem dot
+(asdf:defsystem s-graphviz
   :author "Xu Jingtao <jingtaozf@gmail.com>"
   :version "2.0"
   :licence "MIT"
@@ -17,4 +17,4 @@
   :defsystem-depends-on ("literate-lisp")
   :depends-on ((:version :iterate "1.5"))
   :components ((:module :demo :pathname "./"
-                        :components ((:org "dot")))))
+                        :components ((:org "s-graphviz")))))
diff --git a/s-graphviz.org b/s-graphviz.org
@@ -14,7 +14,7 @@
     - [[#the-encode-stream][the encode stream]]
     - [[#the-indent-level][the indent level]]
     - [[#the-default-size-for-indent-tab][the default size for indent tab]]
-  - [[#how-to-render-a-dot-s-expression][how to render a DOT S-expression]]
+  - [[#how-to-render-a-s-graphviz-s-expression][how to render a S-GRAPHVIZ S-expression]]
   - [[#graph][graph]]
   - [[#stmt-list][stmt-list]]
   - [[#stmt][stmt]]
@@ -32,17 +32,18 @@
   - [[#node-statement-1][node statement]]
 
 * Introduction
-S-Dot is an S-Expression syntax for the input language of the 'Dot' graph drawing tool from the [[http://www.graphviz.org/][AT&T GraphViz]] suite.
-With S-Dot, you can render 'Dot' graphs from within Common Lisp.
+S-Graphviz is an S-Expression syntax for the input language of the 'Dot' graph drawing tool from the [[http://www.graphviz.org/][AT&T GraphViz]] suite.
+With S-Graphviz, you can render 'Dot' graphs from within Common Lisp.
 The idea of this package is from [[http://martin-loetzsch.de/S-DOT/][S-DOT]].
 
 * Preparation
 Let's create an individual package for this module.
 #+BEGIN_SRC lisp
-(defpackage :dot
+(defpackage :s-graphviz
+  (:nicknames :graphviz)
   (:use :common-lisp :iter)
   (:export :render-graph :format-graph))
-(in-package :dot)
+(in-package :s-graphviz)
 #+END_SRC
 * Language presentation
 We will use a lisp style to present the [[https://www.graphviz.org/doc/info/lang.html][DOT language]].
@@ -81,8 +82,8 @@ How many whitespaces will be written before printing current DOT expression.
 #+BEGIN_SRC lisp
 (defvar *indent-tab-size* 2)
 #+END_SRC
-** how to render a DOT S-expression
-Renders a s-DOT graph into a graphic file.
+** how to render a S-GRAPHVIZ S-expression
+Renders a s-graphviz graph into a graphic file.
 ~file-name~ should be a pathname.
 If the file-name is ~/foo/bar.png~ , the DOT file ~/foo/bar.dot~ is created
 and then rendered.
@@ -98,17 +99,17 @@ for example svg,  ps, gif, png, or jpg.
                                       :name (pathname-name file-name) :type "dot")))
     (with-open-file (stream dot-file-name :direction :output :if-exists :supersede
                             :if-does-not-exist :create)
-      (format stream "// This file is generated automatically by S-DOT.~%~%")
+      (format stream "// This file is generated automatically by S-GRAPHVIZ.~%~%")
       (format-graph s-expression :stream stream))
     (uiop:run-program (format nil "~a -o ~a ~a~a ~a ~a"
                               dot-exe file-name dot-output-format-switch
                               format dot-options dot-file-name)
                       :ignore-error-status t)))
 #+END_SRC
 
-We will provide a helpful routine to render a DOT S-expression and open it in Emacs.
+We will provide a helpful routine to render a S-GRAPHVIZ S-expression and open it in Emacs.
 #+BEGIN_SRC lisp :load dev
-(defmacro render-and-open-s-dot (file-name &rest left-args)
+(defmacro render-and-open-s-graphviz (file-name &rest left-args)
   (let ((real-file-name (gensym "file-name")))
     `(let ((,real-file-name (namestring ,file-name)))
        (render-graph ,real-file-name ,@left-args)
@@ -154,10 +155,10 @@ We will provide a helpful routine to render a DOT S-expression and open it in Em
 a graph is established by a stmt_list.
 We can also apply some global configuration in a ~stmt_list~ to limit their affection scope,for example:
 #+BEGIN_SRC lisp :load no
-(render-and-open-s-dot
+(render-and-open-s-graphviz
  (merge-pathnames
   #p"images/statements.png"
-  (asdf:component-pathname (asdf:find-system :dot)))
+  (asdf:component-pathname (asdf:find-system :s-graphviz)))
  '(:digraph nil
    (= :rankdir "LR")
    (:-> nil a b c)
@@ -206,10 +207,10 @@ There are many different kinds of statements,let's recognize them one by one.
 
 If a statement starts without a known keyword, then it's a node statement,for example
 #+BEGIN_SRC lisp :load no
-(render-and-open-s-dot
+(render-and-open-s-graphviz
  (merge-pathnames
   #p"images/node1.png"
-  (asdf:component-pathname (asdf:find-system :dot)))
+  (asdf:component-pathname (asdf:find-system :s-graphviz)))
  '(:digraph nil
    (node1 (:label "nice node") (:shape :box) (:fontname "Arial") (:fontcolor "#AA0000"))))
 #+END_SRC
@@ -245,10 +246,10 @@ edgeRHS	:	edgeop (node_id | subgraph) [ edgeRHS ]
 In a S-expression, it's a list that starts with an ~edgeop~ and an ~attr_list~ and
 the rest are a list of ~node id~, for example
 #+BEGIN_SRC lisp :load no
-(render-and-open-s-dot
+(render-and-open-s-graphviz
  (merge-pathnames
   #p"images/edge1.png"
-  (asdf:component-pathname (asdf:find-system :dot)))
+  (asdf:component-pathname (asdf:find-system :s-graphviz)))
  '(:digraph nil
    (:-> ((arrowhead :diamond)
          (color "#FF0000")
@@ -278,13 +279,13 @@ the rest are a list of ~node id~, for example
 #+begin_src bnf
 attr_stmt	:	(graph | node | edge) attr_list
 #+end_src
-In a DOT S-expression, it starts with keyword ~:graph~, ~:node~, ~:edge~ , and the rest items
+In a S-GRAPHVIZ S-expression, it starts with keyword ~:graph~, ~:node~, ~:edge~ , and the rest items
 in the list is the ~attr_list~(ref:attr-list),for example:
 #+begin_src lisp :load no
-(render-and-open-s-dot
+(render-and-open-s-graphviz
  (merge-pathnames
   #p"images/node2.png"
-  (asdf:component-pathname (asdf:find-system :dot)))
+  (asdf:component-pathname (asdf:find-system :s-graphviz)))
  '(:digraph nil
    (:node
     (:fillcolor "#AAFFAA")
@@ -303,12 +304,12 @@ in the list is the ~attr_list~(ref:attr-list),for example:
 #+END_SRC
 ** attribute
 a single attribute can be applied to global environment in a statement,
-in a DOT S-expression, it looks like this:
+in a S-GRAPHVIZ S-expression, it looks like this:
 #+BEGIN_SRC lisp :load no
-(render-and-open-s-dot
+(render-and-open-s-graphviz
  (merge-pathnames
   #p"images/attr.png"
-  (asdf:component-pathname (asdf:find-system :dot)))
+  (asdf:component-pathname (asdf:find-system :s-graphviz)))
  '(:digraph nil
    (= :compound t)
    (node1 (:id :test)(:label :test))))
@@ -325,12 +326,12 @@ in a DOT S-expression, it looks like this:
 #+END_SRC
 ** subgraph
 It a subgraph's name starts with "cluster", then it has a special meaning.
-in a DOT S-expression, it looks like this:
+in a S-GRAPHVIZ S-expression, it looks like this:
 #+BEGIN_SRC lisp :load no
-(render-and-open-s-dot
+(render-and-open-s-graphviz
  (merge-pathnames
   #p"images/cluster1.png"
-  (asdf:component-pathname (asdf:find-system :dot)))
+  (asdf:component-pathname (asdf:find-system :s-graphviz)))
  '(:digraph nil
    (:subgraph cluster_1
     (node1 (:id :test)(:label :test))
@@ -371,12 +372,12 @@ port	:	':' ID [ ':' compass_pt ]
        |	':' compass_pt
 compass_pt	:	(n | ne | e | se | s | sw | w | nw | c | _)
 #+end_src
-In a DOT S-expression, it looks like this:
+In a S-GRAPHVIZ S-expression, it looks like this:
 #+BEGIN_SRC lisp :load no
-(render-and-open-s-dot
+(render-and-open-s-graphviz
  (merge-pathnames
   #p"images/port.png"
-  (asdf:component-pathname (asdf:find-system :dot)))
+  (asdf:component-pathname (asdf:find-system :s-graphviz)))
  '(:digraph nil
    (:-> nil (node1 :e) (node2 :s))))
 #+END_SRC
@@ -430,8 +431,8 @@ The [[https://common-lisp.net/project/fiveam/][FiveAM]] library is used to test.
   (unless (find-package :fiveam)
     #+quicklisp (ql:quickload :fiveam)
     #-quicklisp (asdf:load-system :fiveam)))
-(5am:def-suite dot-suite :description "The test suite of DOT.")
-(5am:in-suite dot-suite)
+(5am:def-suite s-graphviz-suite :description "The test suite of S-GRAPHVIZ.")
+(5am:in-suite s-graphviz-suite)
 #+END_SRC
 ** node statement
 label:test-of-node-statement

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// This file is generated automatically by s-dot.`
	`1`	`+// This file is generated automatically by S-GRAPHVIZ.`
`2`	`2`
`3`	`3`	`digraph {`
`4`	`4`	`compound = true;`