org.antlr.v4.codegen

Class CodeGenerator

java.lang.Object

org.antlr.v4.codegen.CodeGenerator

public class CodeGenerator
extends java.lang.Object

General controller for code gen. Can instantiate sub generator(s).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_LANGUAGE
Grammar	g
java.lang.String	language
int	lineWidth
private Target	target
static java.lang.String	TEMPLATE_ROOT
Tool	tool
static java.lang.String	VOCAB_FILE_EXTENSION
static java.lang.String	vocabFilePattern

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
private OutputModelController	createController()
org.stringtemplate.v4.ST	generateBaseListener()
org.stringtemplate.v4.ST	generateBaseVisitor()
org.stringtemplate.v4.ST	generateLexer()
org.stringtemplate.v4.ST	generateListener()
org.stringtemplate.v4.ST	generateParser()
org.stringtemplate.v4.ST	generateVisitor()
java.lang.String	getBaseListenerFileName() A given grammar T, return a blank listener implementation such as TBaseListener.java, if we're using the Java target.
java.lang.String	getBaseVisitorFileName() A given grammar T, return a blank listener implementation such as TBaseListener.java, if we're using the Java target.
java.lang.String	getHeaderFileName()
java.lang.String	getListenerFileName() A given grammar T, return the listener name such as TListener.java, if we're using the Java target.
java.lang.String	getRecognizerFileName() Generate TParser.java and TLexer.java from T.g4 if combined, else just use T.java as output regardless of type.
Target	getTarget()
org.stringtemplate.v4.STGroup	getTemplates()
(package private) org.stringtemplate.v4.ST	getTokenVocabOutput() Generate a token vocab file with all the token names/types.
java.lang.String	getVisitorFileName() A given grammar T, return the visitor name such as TVisitor.java, if we're using the Java target.
java.lang.String	getVocabFileName() What is the name of the vocab file generated for this grammar? Returns null if no .tokens file should be generated.
protected void	loadLanguageTarget(java.lang.String language)
static boolean	targetExists(java.lang.String language)
private org.stringtemplate.v4.ST	walk(OutputModelObject outputModel)
void	write(org.stringtemplate.v4.ST code, java.lang.String fileName)
void	writeBaseListener(org.stringtemplate.v4.ST outputFileST)
void	writeBaseVisitor(org.stringtemplate.v4.ST outputFileST)
void	writeHeaderFile()
void	writeListener(org.stringtemplate.v4.ST outputFileST)
void	writeRecognizer(org.stringtemplate.v4.ST outputFileST)
void	writeVisitor(org.stringtemplate.v4.ST outputFileST)
void	writeVocabFile()

Methods inherited from class java.lang.Object

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

Field Detail

TEMPLATE_ROOT

public static final java.lang.String TEMPLATE_ROOT

See Also:

Constant Field Values

VOCAB_FILE_EXTENSION

public static final java.lang.String VOCAB_FILE_EXTENSION

See Also:

Constant Field Values

DEFAULT_LANGUAGE

public static final java.lang.String DEFAULT_LANGUAGE

See Also:

Constant Field Values

vocabFilePattern

public static final java.lang.String vocabFilePattern

See Also:

Constant Field Values

g

public final Grammar g

tool

public final Tool tool

language

public final java.lang.String language

target

private Target target

lineWidth

public int lineWidth

Constructor Detail

CodeGenerator

private CodeGenerator(java.lang.String language)

CodeGenerator

public CodeGenerator(Grammar g)

CodeGenerator

public CodeGenerator(Tool tool,
                     Grammar g,
                     java.lang.String language)

Method Detail

targetExists

public static boolean targetExists(java.lang.String language)

getTarget

public Target getTarget()

getTemplates

public org.stringtemplate.v4.STGroup getTemplates()

loadLanguageTarget

protected void loadLanguageTarget(java.lang.String language)

createController

private OutputModelController createController()

walk

private org.stringtemplate.v4.ST walk(OutputModelObject outputModel)

generateLexer

public org.stringtemplate.v4.ST generateLexer()

generateParser

public org.stringtemplate.v4.ST generateParser()

generateListener

public org.stringtemplate.v4.ST generateListener()

generateBaseListener

public org.stringtemplate.v4.ST generateBaseListener()

generateVisitor

public org.stringtemplate.v4.ST generateVisitor()

generateBaseVisitor

public org.stringtemplate.v4.ST generateBaseVisitor()

getTokenVocabOutput

org.stringtemplate.v4.ST getTokenVocabOutput()

Generate a token vocab file with all the token names/types. For example: ID=7 FOR=8 'for'=8 This is independent of the target language; used by antlr internally

writeRecognizer

public void writeRecognizer(org.stringtemplate.v4.ST outputFileST)

writeListener

public void writeListener(org.stringtemplate.v4.ST outputFileST)

writeBaseListener

public void writeBaseListener(org.stringtemplate.v4.ST outputFileST)

writeVisitor

public void writeVisitor(org.stringtemplate.v4.ST outputFileST)

writeBaseVisitor

public void writeBaseVisitor(org.stringtemplate.v4.ST outputFileST)

writeHeaderFile

public void writeHeaderFile()

writeVocabFile

public void writeVocabFile()

write

public void write(org.stringtemplate.v4.ST code,
                  java.lang.String fileName)

getRecognizerFileName

public java.lang.String getRecognizerFileName()

Generate TParser.java and TLexer.java from T.g4 if combined, else just use T.java as output regardless of type.

getListenerFileName

public java.lang.String getListenerFileName()

A given grammar T, return the listener name such as TListener.java, if we're using the Java target.

getVisitorFileName

public java.lang.String getVisitorFileName()

A given grammar T, return the visitor name such as TVisitor.java, if we're using the Java target.

getBaseListenerFileName

public java.lang.String getBaseListenerFileName()

A given grammar T, return a blank listener implementation such as TBaseListener.java, if we're using the Java target.

getBaseVisitorFileName

public java.lang.String getBaseVisitorFileName()

A given grammar T, return a blank listener implementation such as TBaseListener.java, if we're using the Java target.

getVocabFileName

public java.lang.String getVocabFileName()

What is the name of the vocab file generated for this grammar? Returns null if no .tokens file should be generated.

getHeaderFileName

public java.lang.String getHeaderFileName()