Uses of Class
org.antlr.v4.tool.Grammar

Packages that use Grammar

Package	Description
org.antlr.mojo.antlr4
org.antlr.v4
org.antlr.v4.analysis
org.antlr.v4.automata
org.antlr.v4.codegen
org.antlr.v4.codegen.model
org.antlr.v4.codegen.target
org.antlr.v4.parse
org.antlr.v4.semantics
org.antlr.v4.tool
org.antlr.v4.tool.ast

Uses of Grammar in org.antlr.mojo.antlr4

Methods in org.antlr.mojo.antlr4 with parameters of type Grammar

Modifier and Type	Method and Description
java.io.Writer	Antlr4Mojo.CustomTool.getOutputFileWriter(Grammar g, java.lang.String fileName)
void	Antlr4Mojo.CustomTool.process(Grammar g, boolean gencode)

Uses of Grammar in org.antlr.v4

Fields in org.antlr.v4 with type parameters of type Grammar

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,Grammar>	Tool.importedGrammars

Methods in org.antlr.v4 that return Grammar

Modifier and Type	Method and Description
Grammar	Tool.createGrammar(GrammarRootAST ast) Given the raw AST of a grammar, create a grammar object associated with the AST.
Grammar	Tool.loadGrammar(java.lang.String fileName) Convenience method to load and process an ANTLR grammar.
Grammar	Tool.loadImportedGrammar(Grammar g, GrammarAST nameNode) Try current dir then dir of g then lib dir

Methods in org.antlr.v4 with parameters of type Grammar

Modifier and Type	Method and Description
boolean	Tool.checkForRuleIssues(Grammar g) Important enough to avoid multiple definitions that we do very early, right after AST construction.
void	Tool.generateATNs(Grammar g)
private void	Tool.generateInterpreterData(Grammar g)
java.io.File	Tool.getImportedGrammarFile(Grammar g, java.lang.String fileName)
java.io.Writer	Tool.getOutputFileWriter(Grammar g, java.lang.String fileName) This method is used by all code generators to create new output files.
Grammar	Tool.loadImportedGrammar(Grammar g, GrammarAST nameNode) Try current dir then dir of g then lib dir
void	Tool.process(Grammar g, boolean gencode) To process a grammar, we load all of its imported grammars into subordinate grammar objects.
void	Tool.processNonCombinedGrammar(Grammar g, boolean gencode)
protected void	Tool.writeDOTFile(Grammar g, Rule r, java.lang.String dot)
protected void	Tool.writeDOTFile(Grammar g, java.lang.String name, java.lang.String dot)

Uses of Grammar in org.antlr.v4.analysis

Fields in org.antlr.v4.analysis declared as Grammar

Modifier and Type	Field and Description
Grammar	LeftRecursiveRuleTransformer.g
Grammar	AnalysisPipeline.g
(package private) Grammar	LeftRecursionDetector.g

Methods in org.antlr.v4.analysis with parameters of type Grammar

Modifier and Type	Method and Description
RuleAST	LeftRecursiveRuleTransformer.parseArtificialRule(Grammar g, java.lang.String ruleText)

Constructors in org.antlr.v4.analysis with parameters of type Grammar

Constructor and Description
AnalysisPipeline(Grammar g)
LeftRecursionDetector(Grammar g, ATN atn)
LeftRecursiveRuleTransformer(GrammarRootAST ast, java.util.Collection<Rule> rules, Grammar g)

Uses of Grammar in org.antlr.v4.automata

Fields in org.antlr.v4.automata declared as Grammar

Modifier and Type	Field and Description
(package private) Grammar	ATNPrinter.g
Grammar	ParserATNFactory.g

Methods in org.antlr.v4.automata with parameters of type Grammar

Modifier and Type	Method and Description
static void	ATNOptimizer.optimize(Grammar g, ATN atn)
private static void	ATNOptimizer.optimizeSets(Grammar g, ATN atn)

Constructors in org.antlr.v4.automata with parameters of type Grammar

Constructor and Description
ATNPrinter(Grammar g, ATNState start)
ParserATNFactory(Grammar g)

Uses of Grammar in org.antlr.v4.codegen

Fields in org.antlr.v4.codegen declared as Grammar

Modifier and Type	Field and Description
Grammar	DefaultOutputModelFactory.g
Grammar	CodeGenerator.g
(package private) Grammar	CodeGenPipeline.g

Methods in org.antlr.v4.codegen that return Grammar

Modifier and Type	Method and Description
Grammar	OutputModelController.getGrammar()
Grammar	DefaultOutputModelFactory.getGrammar()
Grammar	OutputModelFactory.getGrammar()

Methods in org.antlr.v4.codegen with parameters of type Grammar

Modifier and Type	Method and Description
protected void	Target.genFile(Grammar g, org.stringtemplate.v4.ST outputFileST, java.lang.String fileName)
java.lang.String	Target.getTokenTypeAsTargetLabel(Grammar g, int ttype) Get a meaningful name for a token type useful during code generation.
java.lang.String[]	Target.getTokenTypesAsTargetLabels(Grammar g, int[] ttypes)

Constructors in org.antlr.v4.codegen with parameters of type Grammar

Constructor and Description
CodeGenerator(Grammar g)
CodeGenerator(Tool tool, Grammar g, java.lang.String language)
CodeGenPipeline(Grammar g)

Uses of Grammar in org.antlr.v4.codegen.model

Methods in org.antlr.v4.codegen.model with parameters of type Grammar

Modifier and Type	Method and Description
java.util.Map<java.lang.String,Action>	OutputFile.buildNamedActions(Grammar g)

Uses of Grammar in org.antlr.v4.codegen.target

Methods in org.antlr.v4.codegen.target with parameters of type Grammar

Modifier and Type	Method and Description
protected void	SwiftTarget.genFile(Grammar g, org.stringtemplate.v4.ST outputFileST, java.lang.String fileName)
protected void	GoTarget.genFile(Grammar g, org.stringtemplate.v4.ST outputFileST, java.lang.String fileName)
private java.lang.String	SwiftTarget.getLexerOrParserATNJson(Grammar g, java.lang.String fileName)
private void	SwiftTarget.writeFile(java.lang.String content, Grammar g, java.lang.String fileName)

Uses of Grammar in org.antlr.v4.parse

Fields in org.antlr.v4.parse declared as Grammar

Modifier and Type	Field and Description
protected Grammar	TokenVocabParser.g
Grammar	GrammarToken.g
Grammar	BlockSetTransformer.g

Methods in org.antlr.v4.parse with parameters of type Grammar

Modifier and Type	Method and Description
static Pair<java.lang.Integer,java.lang.Integer>	ScopeParser._parsePostfixDecl(Attribute attr, java.lang.String decl, ActionAST a, Grammar g)
static Pair<java.lang.Integer,java.lang.Integer>	ScopeParser._parsePrefixDecl(Attribute attr, java.lang.String decl, ActionAST a, Grammar g)
static AttributeDict	ScopeParser.parse(ActionAST action, java.lang.String s, char separator, Grammar g)
static Attribute	ScopeParser.parseAttributeDef(ActionAST action, Pair<java.lang.String,java.lang.Integer> decl, Grammar g) For decls like "String foo" or "char *foo32[]" compute the ID and type declarations.
static AttributeDict	ScopeParser.parseTypedArgList(ActionAST action, java.lang.String s, Grammar g) Given an arg or retval scope definition list like

Constructors in org.antlr.v4.parse with parameters of type Grammar

Constructor and Description
BlockSetTransformer(org.antlr.runtime.tree.TreeNodeStream input, Grammar g)
GrammarToken(Grammar g, org.antlr.runtime.Token oldToken)
TokenVocabParser(Grammar g)

Uses of Grammar in org.antlr.v4.semantics

Fields in org.antlr.v4.semantics declared as Grammar

Modifier and Type	Field and Description
Grammar	RuleCollector.g which grammar are we checking
Grammar	AttributeChecks.g
Grammar	ActionSniffer.g
Grammar	SymbolCollector.g which grammar are we checking
Grammar	BasicSemanticChecks.g
(package private) Grammar	SymbolChecks.g
Grammar	SemanticPipeline.g

Methods in org.antlr.v4.semantics with parameters of type Grammar

Modifier and Type	Method and Description
(package private) void	SemanticPipeline.assignChannelTypes(Grammar g, java.util.List<GrammarAST> channelDefs) Assign constant values to custom channels defined in a grammar.
(package private) void	SemanticPipeline.assignLexerTokenTypes(Grammar g, java.util.List<GrammarAST> tokensDefs)
(package private) void	SemanticPipeline.assignTokenTypes(Grammar g, java.util.List<GrammarAST> tokensDefs, java.util.List<GrammarAST> tokenIDs, java.util.List<GrammarAST> terminals)
static void	AttributeChecks.checkAllAttributeExpressions(Grammar g)
void	SymbolChecks.checkForModeConflicts(Grammar g)
private void	SymbolChecks.checkForOverlap(Grammar g, Rule rule1, Rule rule2, java.util.List<java.lang.String> firstTokenStringValues, java.util.List<java.lang.String> secondTokenStringValues) For same rule compare values from next index: TOKEN_WITH_SAME_VALUES: 'asdf' | 'asdf'; For different rules compare from start value: TOKEN1: 'asdf'; TOKEN2: 'asdf';
void	SymbolChecks.checkForQualifiedRuleIssues(Grammar g, java.util.List<GrammarAST> qualifiedRuleRefs)
void	SymbolChecks.checkForUnreachableTokens(Grammar g) Algorithm steps: 1.
void	SymbolChecks.checkRuleArgs(Grammar g, java.util.List<GrammarAST> rulerefs)
static java.util.Map<Rule,java.util.Set<Rule>>	UseDefAnalyzer.getRuleDependencies(Grammar g) Find all rules reachable from r directly or indirectly for all r in g
static java.util.Map<Rule,java.util.Set<Rule>>	UseDefAnalyzer.getRuleDependencies(Grammar g, java.util.Collection<Rule> rules)
static void	UseDefAnalyzer.trackTokenRuleRefsInActions(Grammar g)

Constructors in org.antlr.v4.semantics with parameters of type Grammar

Constructor and Description
ActionSniffer(Grammar g, Rule r, Alternative alt, ActionAST node, org.antlr.runtime.Token actionToken)
AttributeChecks(Grammar g, Rule r, Alternative alt, ActionAST node, org.antlr.runtime.Token actionToken)
BasicSemanticChecks(Grammar g, RuleCollector ruleCollector)
RuleCollector(Grammar g)
SemanticPipeline(Grammar g)
SymbolChecks(Grammar g, SymbolCollector collector)
SymbolCollector(Grammar g)

Uses of Grammar in org.antlr.v4.tool

Subclasses of Grammar in org.antlr.v4.tool

Modifier and Type	Class and Description
class	LexerGrammar

Fields in org.antlr.v4.tool declared as Grammar

Modifier and Type	Field and Description
protected Grammar	GrammarParserInterpreter.g The grammar associated with this interpreter.
Grammar	Rule.g In which grammar does this rule live?
protected Grammar	BuildDependencyGenerator.g
Grammar	GrammarTransformPipeline.g
Grammar	ANTLRMessage.g
protected Grammar	DOTGenerator.grammar
Grammar	LexerGrammar.implicitLexerOwner The grammar from which this lexer grammar was derived (if implicit)
Grammar	Grammar.originalGrammar If this is an extracted/implicit lexer, we point at original grammar
Grammar	Grammar.parent If we're imported, who imported us? If null, implies grammar is root

Fields in org.antlr.v4.tool with type parameters of type Grammar

Modifier and Type	Field and Description
java.util.List<Grammar>	Grammar.importedGrammars

Methods in org.antlr.v4.tool that return Grammar

Modifier and Type	Method and Description
Grammar	Grammar.getImportedGrammar(java.lang.String name) Return grammar directly imported by this grammar
Grammar	Grammar.getOutermostGrammar() Return the grammar that imported us and our parents.
static Grammar	Grammar.load(java.lang.String fileName) convenience method for Tool.loadGrammar()

Methods in org.antlr.v4.tool that return types with arguments of type Grammar

Modifier and Type	Method and Description
java.util.List<Grammar>	Grammar.getAllImportedGrammars() Get list of all imports from all grammars in the delegate subtree of g.
java.util.List<Grammar>	Grammar.getGrammarAncestors() Return list of imported grammars from root down to our parent.
java.util.List<Grammar>	Grammar.getImportedGrammars()

Methods in org.antlr.v4.tool with parameters of type Grammar

Modifier and Type	Method and Description
static void	GrammarTransformPipeline.augmentTokensWithOriginalPosition(Grammar g, GrammarAST tree)
static ParserInterpreter	GrammarParserInterpreter.deriveTempParserInterpreter(Grammar g, Parser originalParser, TokenStream tokens) Derive a new parser from an old one that has knowledge of the grammar.
GrammarRootAST	GrammarTransformPipeline.extractImplicitLexer(Grammar combinedGrammar) Build lexer grammar from combined grammar that looks like: (COMBINED_GRAMMAR A (tokens { X (= Y 'y')) (OPTIONS (= x 'y')) (@ members {foo}) (@ lexer header {package jj;}) (RULES (RULE .+))) Move rules and actions to new tree, don't dup.
static java.util.List<ParserRuleContext>	GrammarParserInterpreter.getAllPossibleParseTrees(Grammar g, Parser originalParser, TokenStream tokens, int decision, java.util.BitSet alts, int startIndex, int stopIndex, int startRuleIndex) Given an ambiguous parse information, return the list of ambiguous parse trees.
static java.util.List<ParserRuleContext>	GrammarParserInterpreter.getLookaheadParseTrees(Grammar g, ParserInterpreter originalParser, TokenStream tokens, int startRuleIndex, int decision, int startIndex, int stopIndex) Return a list of parse trees, one for each alternative in a decision given the same input.
void	Grammar.importVocab(Grammar importG)
void	GrammarTransformPipeline.integrateImportedGrammars(Grammar rootGrammar) Merge all the rules, token definitions, and named actions from imported grammars into the root grammar tree.
static void	GrammarTransformPipeline.setGrammarPtr(Grammar g, GrammarAST tree) Utility visitor that sets grammar ptr in each node

Constructors in org.antlr.v4.tool with parameters of type Grammar

Constructor and Description
BuildDependencyGenerator(Tool tool, Grammar g)
DOTGenerator(Grammar grammar) This aspect is associated with a grammar
Grammar(java.lang.String fileName, java.lang.String grammarText, Grammar tokenVocabSource, ANTLRToolListener listener) For testing; builds trees, does sem anal
GrammarParserInterpreter(Grammar g, ATN atn, TokenStream input)
GrammarParserInterpreter(Grammar g, java.lang.String grammarFileName, Vocabulary vocabulary, java.util.Collection<java.lang.String> ruleNames, ATN atn, TokenStream input)
GrammarTransformPipeline(Grammar g, Tool tool)
LabelElementPair(Grammar g, GrammarAST label, GrammarAST element, int labelOp)
LeftRecursiveRule(Grammar g, java.lang.String name, RuleAST ast)
Rule(Grammar g, java.lang.String name, RuleAST ast, int numberOfAlts)

Uses of Grammar in org.antlr.v4.tool.ast

Fields in org.antlr.v4.tool.ast declared as Grammar

Modifier and Type	Field and Description
Grammar	GrammarAST.g For error msgs, nice to know which grammar this AST lives in