Skip to content

Commit

Permalink
Add graphviz type hierarchy with built svg/png
Browse files Browse the repository at this point in the history
Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
  • Loading branch information
seldridge committed Sep 25, 2019
1 parent 9ea198e commit 8efe7c9
Show file tree
Hide file tree
Showing 4 changed files with 323 additions and 776 deletions.
12 changes: 12 additions & 0 deletions doc/images/Makefile
@@ -0,0 +1,12 @@
.PHONY: all

sources = \
type_hierarchy.dot

all: $(sources:%.dot=%.svg) $(sources:%.dot=%.png)

%.svg: %.dot
dot -Tsvg $< -o $@

%.png: %.dot
dot -Tpng $< -o $@
52 changes: 52 additions & 0 deletions 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"
}
}
}
Binary file modified doc/images/type_hierarchy.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8efe7c9

Please sign in to comment.