Add graphviz type hierarchy with built svg/png

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>

1 files changed, 52 insertions, 0 deletions

diff --git a/doc/images/type_hierarchy.dot b/doc/images/type_hierarchy.dot
new file mode 100644
index 00000000..d3bf6eb4
--- /dev/null
+++ b/doc/images/type_hierarchy.dot
@@ -0,0 +1,52 @@
+digraph TypeHierarchy {
+  graph [rankdir=BT bgcolor="transparent"]
+  { node [style=filled,shape=box]
+    { node [fillcolor="#f7fbff"]
+      Data
+      Element
+      Bits Num
+      Aggregate
+      VecLike
+      "Chisel Internal"
+    }
+    { node [fillcolor="#e5f5e0"]
+      Bool UInt SInt FixedPoint
+      Reset
+      AsyncReset
+      Record
+      Bundle
+      Vec
+      "Chisel Types"
+    }
+    { node [fillcolor="#fcbba1"]
+      "User Types"
+      Ellipsis [label="..."]
+    }
+
+    subgraph cluster_data_hierarchy {
+      color=transparent
+      Element
+      Bits Num
+      Reset
+      Bool UInt SInt FixedPoint
+      color=transparent
+      Aggregate
+      VecLike
+      Record
+      Bundle
+      Vec
+
+      {Aggregate Element} -> Data
+      {Bits Reset} -> Element
+      {FixedPoint SInt UInt} -> {Bits Num}
+      Bool -> {UInt Reset}
+      Ellipsis -> Bundle -> Record -> Aggregate
+      Vec -> {Aggregate VecLike}
+      AsyncReset -> {Element Reset}
+    }
+    subgraph cluster_legend {
+      label=Legend
+      "User Types" -> "Chisel Types" -> "Chisel Internal"
+    }
+  }
+}