From 14a2896ea0776687f1b57d80b27d0880ef0a8516 Mon Sep 17 00:00:00 2001
From: Javier Burroni <javier.burroni@gmail.com>
Date: Tue, 27 Feb 2018 00:08:26 -0500
Subject: [PATCH 1/3] initial version of `to_dot`

---
 src/util/to_dot.jl | 48 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 src/util/to_dot.jl

diff --git a/src/util/to_dot.jl b/src/util/to_dot.jl
new file mode 100644
index 0000000..157e74e
--- /dev/null
+++ b/src/util/to_dot.jl
@@ -0,0 +1,48 @@
+## to_dot(TestArrows.triple_add(), "triple_add.gv")
+## dot -Tpdf triple_add.gv -o triple_add.pdf && open triple_add.pdf
+
+"""create a simple `dot` file named `filename`
+from a given `CompArrow."""
+function to_dot(carr::CompArrow, filename)
+  open(filename, "w") do f
+    write(f, carr |> to_dot)
+  end
+end
+
+"creates a dot file from the `CompArrow`"
+function to_dot(carr::CompArrow)
+  dot = ""
+  for (id, sarr) in enumerate(sub_arrows(carr))
+    dot *= "\tsubgraph cluster_$id {\n"
+    dot *= to_dot(sarr)
+    dot *= "\t}\n"
+  end
+  for (left, right) ∈ Arrows.links(carr)
+    dot *= "$(name(left)) -> $(name(right));\n"
+  end
+  dot = "digraph {\n" * dot * "}"
+  replace(dot, "#", "x")
+end
+
+"""For a given `SubArrow`, list all of its `SubPorts`
+and connect all the `▹` to the computation and it to
+the  `◃`."""
+function to_dot(sarr::SubArrow)
+  moniker = name(sarr)
+  moniker_arr = sarr |> deref |> name
+  dot = "\tlabel = \"Subgraph $moniker "
+  dot *= "($moniker_arr)\";\n"
+  dot *= "\t" * string(["$n; " for n in 
+            name.(⬨(sarr))]...,
+          "\n")
+  for sport in ▹(sarr)
+    dot *= "\t$(name(sport)) -> $moniker;\n"
+  end
+  for sport in ◃(sarr)
+    dot *= "\t$moniker -> $(name(sport));\n"
+  end
+  dot
+end
+
+
+

From 043c3130d80936ea70cb3b80b9451febb324a20d Mon Sep 17 00:00:00 2001
From: Javier Burroni <javier.burroni@gmail.com>
Date: Wed, 28 Feb 2018 23:08:44 -0500
Subject: [PATCH 2/3] `to_dot` dumps recursively the inner arrows

---
 src/util/to_dot.jl | 82 +++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 74 insertions(+), 8 deletions(-)

diff --git a/src/util/to_dot.jl b/src/util/to_dot.jl
index 157e74e..3a0e694 100644
--- a/src/util/to_dot.jl
+++ b/src/util/to_dot.jl
@@ -1,5 +1,6 @@
 ## to_dot(TestArrows.triple_add(), "triple_add.gv")
 ## dot -Tpdf triple_add.gv -o triple_add.pdf && open triple_add.pdf
+using NamedTuples
 
 """create a simple `dot` file named `filename`
 from a given `CompArrow."""
@@ -11,27 +12,86 @@ end
 
 "creates a dot file from the `CompArrow`"
 function to_dot(carr::CompArrow)
+  seen = Set{Symbol}()
+  to_process = Set{CompArrow}([carr])
+  id = 0
   dot = ""
-  for (id, sarr) in enumerate(sub_arrows(carr))
-    dot *= "\tsubgraph cluster_$id {\n"
+  while !isempty(to_process)
+    next = pop!(to_process)
+    push!(seen, next |> name)
+    answer = to_dot_inner(next, id)
+    dot *= answer.dot
+    id = answer.id
+    union!(to_process, filter(answer.to_process) do c
+                        name(c) ∉ seen
+    end)
+  end
+  "digraph {\n" * dot * "}\n"
+end
+
+function to_dot_inner(carr::CompArrow, base_id)
+  to_process = Set{CompArrow}()
+  append(c::CompArrow) = push!(to_process, c)
+  append(c) = c
+  dot = ""
+  sarrs = sub_arrows(carr)
+  for (id, sarr) in enumerate(sarrs)
+    dot *= "\tsubgraph cluster_$(base_id + id) {\n"
     dot *= to_dot(sarr)
     dot *= "\t}\n"
+    append(sarr |> deref)
   end
   for (left, right) ∈ Arrows.links(carr)
     dot *= "$(name(left)) -> $(name(right));\n"
   end
-  dot = "digraph {\n" * dot * "}"
-  replace(dot, "#", "x")
+  dot = "subgraph cluster_$base_id{\n" * dot_subgraph_name(carr) * dot * "}\n"
+  @NT(id = base_id + length(sarrs) + 1,
+      dot = replace(dot, "##", "xx"),
+      to_process = to_process)
+end
+
+function dot_subgraph_name(arr)
+  "\tlabel = \"Subgraph " * dot_name(arr) * "\";\n"
+end
+function dot_name(arr)::String
+  moniker = name(arr)
+  "$moniker"
+end
+
+function dot_name(sarr::SubArrow)::String
+  arr = sarr |> deref
+  moniker_arr = arr |> name
+  dot_name(arr) * "($moniker_arr)"
+end
+
+as_dot_node(sarr::SubArrow) = as_dot_node(sarr, sarr |> deref)
+function as_dot_node(sarr::SubArrow, carr::CompArrow)
+  "\"$(name(carr))\""
+end
+
+function as_dot_node(sarr::SubArrow, arr::PrimArrow)
+  moniker = sarr |> name
+  moniker_arr = arr |> name
+  "\"$moniker($moniker_arr)\""
+end
+
+dot_attributes(moniker, sarr::SubArrow) = dot_attributes(moniker, sarr, sarr |> deref)
+function dot_attributes(moniker, sarr::SubArrow, ::CompArrow)
+  "$moniker [fillcolor=\"#beaed4\", shape=box, style=filled];\n"
+end
+
+function dot_attributes(moniker, sarr::SubArrow, ::PrimArrow)
+  #"$moniker [fillcolor=\"#fdc086\", shape=diamond, style=filled];\n"
+  "$moniker [fillcolor=yellow, shape=diamond, style=filled];\n"
 end
 
 """For a given `SubArrow`, list all of its `SubPorts`
 and connect all the `▹` to the computation and it to
 the  `◃`."""
 function to_dot(sarr::SubArrow)
-  moniker = name(sarr)
-  moniker_arr = sarr |> deref |> name
-  dot = "\tlabel = \"Subgraph $moniker "
-  dot *= "($moniker_arr)\";\n"
+  moniker = as_dot_node(sarr)
+  dot = dot_subgraph_name(sarr)
+  dot *= dot_attributes(moniker, sarr)
   dot *= "\t" * string(["$n; " for n in 
             name.(⬨(sarr))]...,
           "\n")
@@ -46,3 +106,9 @@ end
 
 
 
+function test_solve_triple_add()
+  carr = TestArrows.triple_add()
+  inv_carr = carr |> Arrows.invert
+  wired, wirer = Arrows.solve_scalar(inv_carr)
+  wired
+end
\ No newline at end of file

From df445c784adba5371cb8e27e869867969bdc6666 Mon Sep 17 00:00:00 2001
From: Javier Burroni <javier.burroni@gmail.com>
Date: Wed, 28 Feb 2018 23:36:59 -0500
Subject: [PATCH 3/3] add documentation added to `Arrows` and exported

---
 src/Arrows.jl      |  5 +++++
 src/util/to_dot.jl | 24 +++++++++++-------------
 2 files changed, 16 insertions(+), 13 deletions(-)

diff --git a/src/Arrows.jl b/src/Arrows.jl
index f030d1d..c9f4cfc 100644
--- a/src/Arrows.jl
+++ b/src/Arrows.jl
@@ -251,6 +251,8 @@ export
   onehot,
   invonehot,
 
+  to_dot,
+
   accumapply,
   trace_value,
   psl,
@@ -377,6 +379,9 @@ include("sym/convenience.jl")
 include("sym/scalar_solver.jl")
 include("sym/graph_solver.jl")
 
+# Utils that requires Arrows
+include("util/to_dot.jl")           # render Arrows using the "dot" file format
+
 # Integration of arrow with julia #
 include("host/overload.jl")
 include("host/filter.jl")
diff --git a/src/util/to_dot.jl b/src/util/to_dot.jl
index 3a0e694..785e84e 100644
--- a/src/util/to_dot.jl
+++ b/src/util/to_dot.jl
@@ -29,7 +29,8 @@ function to_dot(carr::CompArrow)
   "digraph {\n" * dot * "}\n"
 end
 
-function to_dot_inner(carr::CompArrow, base_id)
+"unexpossed function to render a single `CompArrow`"
+function to_dot_inner(carr::CompArrow, base_id::Number)
   to_process = Set{CompArrow}()
   append(c::CompArrow) = push!(to_process, c)
   append(c) = c
@@ -50,20 +51,25 @@ function to_dot_inner(carr::CompArrow, base_id)
       to_process = to_process)
 end
 
+"label of the subgraph"
 function dot_subgraph_name(arr)
   "\tlabel = \"Subgraph " * dot_name(arr) * "\";\n"
 end
+
+"name of the subgraph generated by the `Arrow`"
 function dot_name(arr)::String
   moniker = name(arr)
   "$moniker"
 end
 
+"name of the subgraph generated by the `Arrow`"
 function dot_name(sarr::SubArrow)::String
   arr = sarr |> deref
   moniker_arr = arr |> name
   dot_name(arr) * "($moniker_arr)"
 end
 
+"name of the `Arrow` when tranform into a `dot` node"
 as_dot_node(sarr::SubArrow) = as_dot_node(sarr, sarr |> deref)
 function as_dot_node(sarr::SubArrow, carr::CompArrow)
   "\"$(name(carr))\""
@@ -75,21 +81,22 @@ function as_dot_node(sarr::SubArrow, arr::PrimArrow)
   "\"$moniker($moniker_arr)\""
 end
 
+"Special attributes for the node (color and shape)"
 dot_attributes(moniker, sarr::SubArrow) = dot_attributes(moniker, sarr, sarr |> deref)
 function dot_attributes(moniker, sarr::SubArrow, ::CompArrow)
   "$moniker [fillcolor=\"#beaed4\", shape=box, style=filled];\n"
 end
 
+"Special attributes for the node (color and shape)"
 function dot_attributes(moniker, sarr::SubArrow, ::PrimArrow)
-  #"$moniker [fillcolor=\"#fdc086\", shape=diamond, style=filled];\n"
-  "$moniker [fillcolor=yellow, shape=diamond, style=filled];\n"
+  "$moniker [fillcolor=\"#fdc086\", shape=diamond, style=filled];\n"
 end
 
 """For a given `SubArrow`, list all of its `SubPorts`
 and connect all the `▹` to the computation and it to
 the  `◃`."""
 function to_dot(sarr::SubArrow)
-  moniker = as_dot_node(sarr)
+  moniker = dot_name(sarr)
   dot = dot_subgraph_name(sarr)
   dot *= dot_attributes(moniker, sarr)
   dot *= "\t" * string(["$n; " for n in 
@@ -102,13 +109,4 @@ function to_dot(sarr::SubArrow)
     dot *= "\t$moniker -> $(name(sport));\n"
   end
   dot
-end
-
-
-
-function test_solve_triple_add()
-  carr = TestArrows.triple_add()
-  inv_carr = carr |> Arrows.invert
-  wired, wirer = Arrows.solve_scalar(inv_carr)
-  wired
 end
\ No newline at end of file