Top Description Fields Constructors Methods

org.antlr.tool

public Class DOTGenerator

Class Inheritance

extends Object

java.lang.Object
org.antlr.tool.DOTGenerator

Imports

org.antlr.Tool, org.antlr.analysis.*, org.antlr.grammar.v3.ANTLRParser, org.antlr.misc.Utils, org.stringtemplate.v4.ST, .STGroup, .STGroupFile, java.util.*

The DOT (part of graphviz) generation aspect.

Field Summary

Modifier and Type	Field and Description
protected String	arrowhead
protected Grammar	grammar
protected Set<Object>	markedStates To prevent infinite recursion when walking state machines, record which states we've visited.
protected String	rankdir
public static STGroup	stlib Library of output templates; use `<attrname>` format
public static final boolean	STRIP_NONREDUCED_STATES

Constructor Summary

Access	Constructor and Description
public	DOTGenerator(Grammar grammar) This aspect is associated with a grammar

Method Summary

Modifier and Type	Method and Description
public String	getArrowheadType()
public String	getDOT(State startState) Return a String containing a DOT description that, when displayed, will show the incoming state machine visually.
protected String	getEdgeLabel(Transition edge) Fix edge strings so they print out in DOT properly; generate any gated predicates on edge too.
public String	getRankdir()
protected String	getStateLabel(State s)
public void	setArrowheadType(String arrowhead)
public void	setRankdir(String rankdir)
protected void	walkCreatingDFADOT(ST dot, DFAState s) Do a depth-first walk of the state machine graph and fill a DOT description template.
protected void	walkRuleNFACreatingDOT(ST dot, State s) Do a depth-first walk of the state machine graph and fill a DOT description template.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

arrowhead	back to summary
protected String arrowhead

grammar	back to summary
protected Grammar grammar

markedStates	back to summary
protected Set<Object> markedStates To prevent infinite recursion when walking state machines, record which states we've visited. Make a new set every time you start walking in case you reuse this object.

rankdir	back to summary
protected String rankdir

stlib	back to summary
public static STGroup stlib Library of output templates; use `<attrname>` format

STRIP_NONREDUCED_STATES	back to summary
public static final boolean STRIP_NONREDUCED_STATES

Constructor Detail

DOTGenerator	back to summary
public DOTGenerator(Grammar grammar) This aspect is associated with a grammar

Method Detail

getArrowheadType	back to summary
public String getArrowheadType()

getDOT	back to summary
public String getDOT(State startState) Return a String containing a DOT description that, when displayed, will show the incoming state machine visually. All nodes reachable from startState will be included.

getEdgeLabel	back to summary
protected String getEdgeLabel(Transition edge) Fix edge strings so they print out in DOT properly; generate any gated predicates on edge too.

getRankdir	back to summary
public String getRankdir()

getStateLabel	back to summary
protected String getStateLabel(State s)

setArrowheadType	back to summary
public void setArrowheadType(String arrowhead)

setRankdir	back to summary
public void setRankdir(String rankdir)

walkCreatingDFADOT	back to summary
protected void walkCreatingDFADOT(ST dot, DFAState s) Do a depth-first walk of the state machine graph and fill a DOT description template. Keep filling the states and edges attributes.

walkRuleNFACreatingDOT	back to summary
protected void walkRuleNFACreatingDOT(ST dot, State s) Do a depth-first walk of the state machine graph and fill a DOT description template. Keep filling the states and edges attributes. We know this is an NFA for a rule so don't traverse edges to other rules and don't go past rule end state.