org.antlr.runtime.tree.DOTTreeGenerator Class Reference
Public Member Functions | |
| StringTemplate | toDOT (Object tree, TreeAdaptor adaptor, StringTemplate _treeST, StringTemplate _edgeST) |
| StringTemplate | toDOT (Object tree, TreeAdaptor adaptor) |
| StringTemplate | toDOT (Tree tree) |
Static Public Attributes | |
| static StringTemplate | _treeST |
| static StringTemplate | _nodeST |
| static StringTemplate | _edgeST |
Protected Member Functions | |
| void | toDOTDefineNodes (Object tree, TreeAdaptor adaptor, StringTemplate treeST) |
| void | toDOTDefineEdges (Object tree, TreeAdaptor adaptor, StringTemplate treeST) |
| StringTemplate | getNodeST (TreeAdaptor adaptor, Object t) |
| int | getNodeNumber (Object t) |
Package Attributes | |
| HashMap | nodeToNumberMap = new HashMap() |
| int | nodeNumber = 0 |
Detailed Description
A utility class to generate DOT diagrams (graphviz) from arbitrary trees. You can pass in your own templates and can pass in any kind of tree or use Tree interface method. I wanted this separator so that you don't have to include ST just to use the org.antlr.runtime.tree.* package. This is a set of non-static methods so you can subclass to override. For example, here is an invocation:CharStream input = new ANTLRInputStream(System.in); TLexer lex = new TLexer(input); CommonTokenStream tokens = new CommonTokenStream(lex); TParser parser = new TParser(tokens); TParser.e_return r = parser.e(); Tree t = (Tree)r.tree; System.out.println(t.toStringTree()); DOTTreeGenerator gen = new DOTTreeGenerator(); StringTemplate st = gen.toDOT(t); System.out.println(st);
Definition at line 53 of file DOTTreeGenerator.java.
Member Function Documentation
| StringTemplate org.antlr.runtime.tree.DOTTreeGenerator.toDOT | ( | Object | tree, | |
| TreeAdaptor | adaptor, | |||
| StringTemplate | _treeST, | |||
| StringTemplate | _edgeST | |||
| ) |
Definition at line 79 of file DOTTreeGenerator.java.
| StringTemplate org.antlr.runtime.tree.DOTTreeGenerator.toDOT | ( | Object | tree, | |
| TreeAdaptor | adaptor | |||
| ) |
Definition at line 98 of file DOTTreeGenerator.java.
| StringTemplate org.antlr.runtime.tree.DOTTreeGenerator.toDOT | ( | Tree | tree | ) |
Generate DOT (graphviz) for a whole tree not just a node. For example, 3+4*5 should generate:
digraph { node [shape=plaintext, fixedsize=true, fontsize=11, fontname="Courier", width=.4, height=.2]; edge [arrowsize=.7] "+"->3 "+"->"*" "*"->4 "*"->5 }
Return the ST not a string in case people want to alter.
Takes a Tree interface object.
Definition at line 121 of file DOTTreeGenerator.java.
| void org.antlr.runtime.tree.DOTTreeGenerator.toDOTDefineNodes | ( | Object | tree, | |
| TreeAdaptor | adaptor, | |||
| StringTemplate | treeST | |||
| ) | [protected] |
Definition at line 125 of file DOTTreeGenerator.java.
| void org.antlr.runtime.tree.DOTTreeGenerator.toDOTDefineEdges | ( | Object | tree, | |
| TreeAdaptor | adaptor, | |||
| StringTemplate | treeST | |||
| ) | [protected] |
Definition at line 152 of file DOTTreeGenerator.java.
| StringTemplate org.antlr.runtime.tree.DOTTreeGenerator.getNodeST | ( | TreeAdaptor | adaptor, | |
| Object | t | |||
| ) | [protected] |
Definition at line 184 of file DOTTreeGenerator.java.
| int org.antlr.runtime.tree.DOTTreeGenerator.getNodeNumber | ( | Object | t | ) | [protected] |
Definition at line 194 of file DOTTreeGenerator.java.
Member Data Documentation
StringTemplate org.antlr.runtime.tree.DOTTreeGenerator._treeST [static] |
Initial value:
new StringTemplate(
"digraph {\n" +
" ordering=out;\n" +
" ranksep=.4;\n" +
" node [shape=plaintext, fixedsize=true, fontsize=11, fontname=\"Courier\",\n" +
" width=.25, height=.25];\n" +
" edge [arrowsize=.5]\n" +
" $nodes$\n" +
" $edges$\n" +
"}\n")
Definition at line 55 of file DOTTreeGenerator.java.
StringTemplate org.antlr.runtime.tree.DOTTreeGenerator._nodeST [static] |
Initial value:
new StringTemplate("$name$ [label=\"$text$\"];\n")
Definition at line 67 of file DOTTreeGenerator.java.
StringTemplate org.antlr.runtime.tree.DOTTreeGenerator._edgeST [static] |
Initial value:
new StringTemplate("$parent$ -> $child$ // \"$parentText$\" -> \"$childText$\"\n")
Definition at line 70 of file DOTTreeGenerator.java.
HashMap org.antlr.runtime.tree.DOTTreeGenerator.nodeToNumberMap = new HashMap() [package] |
Track node to number mapping so we can get proper node name back
Definition at line 74 of file DOTTreeGenerator.java.
int org.antlr.runtime.tree.DOTTreeGenerator.nodeNumber = 0 [package] |
Track node number so we can get unique node names
Definition at line 77 of file DOTTreeGenerator.java.
The documentation for this class was generated from the following file:
- /Users/parrt/antlr/code/antlr/main/runtime/Java/src/org/antlr/runtime/tree/DOTTreeGenerator.java
