Package org.antlr.v4.codegen.model

Class RuleFunction

java.lang.Object

org.antlr.v4.codegen.model.OutputModelObject

org.antlr.v4.codegen.model.RuleFunction

Direct Known Subclasses:

LeftFactoredRuleFunction, LeftRecursiveRuleFunction, LeftUnfactoredRuleFunction

public class RuleFunction
extends OutputModelObject

Field Summary

Fields

Modifier and Type	Field	Description
Map<String,AltLabelStructDecl>	altLabelCtxs
Collection<AttributeDecl>	args
List<SrcOp>	code
String	ctxType
List<ExceptionClause>	exceptions
Action	finallyAction
boolean	hasLookaheadBlock
int	index
OrderedHashSet<Decl>	locals
List<String>	modifiers
String	name
Map<String,Action>	namedActions
List<SrcOp>	postamble
Rule	rule
StructDecl	ruleCtx
Collection<String>	ruleLabels
ATNState	startState
Collection<String>	tokenLabels
String	variantOf

Fields inherited from class org.antlr.v4.codegen.model.OutputModelObject

ast, factory

Constructor Summary

Constructors

Constructor	Description
RuleFunction(OutputModelFactory factory, Rule r)

Method Summary

Modifier and Type	Method	Description
void	addContextDecl(String altLabel, Decl d)	Add decl to struct ctx for rule or alt if labeled
void	addContextGetters(OutputModelFactory factory, Collection<RuleAST> contextASTs)
void	addLocalDecl(Decl d)	Add local var decl
void	fillNamedActions(OutputModelFactory factory, Rule r)
List<Decl>	getDeclForAltElement(GrammarAST t, String refLabelName, boolean needList, boolean optional)
Set<Decl>	getDeclsForAllElements(List<AltAST> altASTs)	for all alts, find which ref X or r needs List Must see across alts.
Map<String,AltLabelStructDecl>	getEffectiveAltLabelContexts(OutputModelController controller)
StructDecl	getEffectiveRuleContext(OutputModelController controller)
protected Tuple2<FrequencySet<String>,FrequencySet<String>>	getElementFrequenciesForAlt(AltAST ast)	Given list of X and r refs in alt, compute how many of each there are
static String	getLabelName(Grammar g, GrammarAST t)
private List<GrammarAST>	getRuleTokens(List<GrammarAST> refs)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

name

public String name

modifiers

public List<String> modifiers

ctxType

public String ctxType

ruleLabels

public Collection<String> ruleLabels

tokenLabels

public Collection<String> tokenLabels

startState

public ATNState startState

index

public int index

rule

public Rule rule

hasLookaheadBlock

public boolean hasLookaheadBlock

variantOf

public String variantOf

code

public List<SrcOp> code

locals

public OrderedHashSet<Decl> locals

args

public Collection<AttributeDecl> args

ruleCtx

public StructDecl ruleCtx

altLabelCtxs

public Map<String,AltLabelStructDecl> altLabelCtxs

namedActions

public Map<String,Action> namedActions

finallyAction

public Action finallyAction

exceptions

public List<ExceptionClause> exceptions

postamble

public List<SrcOp> postamble

Constructor Details

RuleFunction

public RuleFunction(OutputModelFactory factory,
 Rule r)

Method Details

getEffectiveRuleContext

public StructDecl getEffectiveRuleContext(OutputModelController controller)

getEffectiveAltLabelContexts

public Map<String,AltLabelStructDecl> getEffectiveAltLabelContexts(OutputModelController controller)

addContextGetters

public void addContextGetters(OutputModelFactory factory,
 Collection<RuleAST> contextASTs)

fillNamedActions

public void fillNamedActions(OutputModelFactory factory,
 Rule r)

getDeclsForAllElements

public Set<Decl> getDeclsForAllElements(List<AltAST> altASTs)

for all alts, find which ref X or r needs List Must see across alts. If any alt needs X or r as list, then define as list.

getRuleTokens

private List<GrammarAST> getRuleTokens(List<GrammarAST> refs)

getLabelName

public static String getLabelName(Grammar g,
 GrammarAST t)

getElementFrequenciesForAlt

protected Tuple2<FrequencySet<String>,FrequencySet<String>> getElementFrequenciesForAlt(AltAST ast)

Given list of X and r refs in alt, compute how many of each there are

getDeclForAltElement

public List<Decl> getDeclForAltElement(GrammarAST t,
 String refLabelName,
 boolean needList,
 boolean optional)

addLocalDecl

public void addLocalDecl(Decl d)

Add local var decl

addContextDecl

public void addContextDecl(String altLabel,
 Decl d)

Add decl to struct ctx for rule or alt if labeled