org.antlr.v4.codegen

Class CodeGenerator

java.lang.Object

org.antlr.v4.codegen.CodeGenerator

public class CodeGenerator
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
Grammar	g
int	lineWidth
Target	target
static String	TEMPLATE_ROOT
org.stringtemplate.v4.STGroup	templates
Tool	tool
static String	VOCAB_FILE_EXTENSION
static String	vocabFilePattern

Constructor Summary

Constructors

Constructor and Description
CodeGenerator(Grammar g)
CodeGenerator(Tool tool, Grammar g, String language)

Method Summary

Methods

Modifier and Type	Method and Description
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()
String	getBaseListenerFileName() A given grammar T, return a blank listener implementation such as TBaseListener.java, if we're using the Java target.
String	getBaseVisitorFileName() A given grammar T, return a blank listener implementation such as TBaseListener.java, if we're using the Java target.
String	getHeaderFileName()
String	getListenerFileName() A given grammar T, return the listener name such as TListener.java, if we're using the Java target.
String	getRecognizerFileName() Generate TParser.java and TLexer.java from T.g4 if combined, else just use T.java as output regardless of type.
String	getVisitorFileName() A given grammar T, return the visitor name such as TVisitor.java, if we're using the Java target.
String	getVocabFileName() What is the name of the vocab file generated for this grammar? Returns null if no .tokens file should be generated.
void	loadTemplates(String language)
void	write(org.stringtemplate.v4.ST code, 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 String TEMPLATE_ROOT

See Also:

Constant Field Values

VOCAB_FILE_EXTENSION

public static final String VOCAB_FILE_EXTENSION

See Also:

Constant Field Values

vocabFilePattern

public static final String vocabFilePattern

See Also:

Constant Field Values

g

@NotNull
public final Grammar g

tool

@NotNull
public final Tool tool

target

public Target target

templates

public org.stringtemplate.v4.STGroup templates

lineWidth

public int lineWidth

Constructor Detail

CodeGenerator

public CodeGenerator(@NotNull
             Grammar g)

CodeGenerator

public CodeGenerator(@NotNull
             Tool tool,
             @NotNull
             Grammar g,
             String language)

Method Detail

loadTemplates

public void loadTemplates(String language)

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()

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,
         String fileName)

getRecognizerFileName

public 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 String getListenerFileName()

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

getVisitorFileName

public String getVisitorFileName()

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

getBaseListenerFileName

public String getBaseListenerFileName()

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

getBaseVisitorFileName

public String getBaseVisitorFileName()

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

getVocabFileName

public 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 String getHeaderFileName()