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:

LeftRecursiveRuleFunction

public class RuleFunction
extends OutputModelObject

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RuleFunction.ElementFrequenciesVisitor

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,AltLabelStructDecl>	altLabelCtxs
AltLabelStructDecl[]	altToContext
Collection<Attribute>	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

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

ast, factory

Constructor Summary

Constructors

Constructor and Description
RuleFunction(OutputModelFactory factory, Rule r)

Method Summary

Methods

Modifier and Type	Method and Description
void	addContextDecl(String altLabel, Decl d) Add decl to struct ctx for rule or alt if labeled
void	addContextGetters(OutputModelFactory factory, Rule r)
void	addLocalDecl(Decl d) Add local var decl
void	fillNamedActions(OutputModelFactory factory, Rule r)
List<Decl>	getDeclForAltElement(GrammarAST t, String refLabelName, boolean needList)
Set<Decl>	getDeclsForAllElements(List<AltAST> altASTs) for all alts, find which ref X or r needs List Must see across alts.
Set<Decl>	getDeclsForAltElements(AltAST altAST) Get list of decls for token/rule refs.
protected FrequencySet<String>	getElementFrequenciesForAlt(AltAST ast) Given list of X and r refs in alt, compute how many of each there are

Methods inherited from class java.lang.Object

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

Field Detail

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

args

public Collection<Attribute> args

rule

public Rule rule

altToContext

public AltLabelStructDecl[] altToContext

hasLookaheadBlock

public boolean hasLookaheadBlock

code

public List<SrcOp> code

locals

public OrderedHashSet<Decl> locals

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 Detail

RuleFunction

public RuleFunction(OutputModelFactory factory,
            Rule r)

Method Detail

addContextGetters

public void addContextGetters(OutputModelFactory factory,
                     Rule r)

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.

getElementFrequenciesForAlt

protected FrequencySet<String> getElementFrequenciesForAlt(AltAST ast)

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

getDeclsForAltElements

public Set<Decl> getDeclsForAltElements(AltAST altAST)

Get list of decls for token/rule refs. Single ref X becomes X() getter Multiple refs to X becomes List X() method, X(int i) method. Ref X in a loop then we get List X(), X(int i) Does not gen labels for literals like '+', 'begin', ';', ...

getDeclForAltElement

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

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