Package 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	Description
final Grammar	g
final String	language
int	lineWidth
static final String	TEMPLATE_ROOT
final Tool	tool
static final String	VOCAB_FILE_EXTENSION
static final String	vocabFilePattern

Method Summary

Modifier and Type	Method	Description
static CodeGenerator	create(Grammar g)
static CodeGenerator	create(Tool tool, Grammar g, String language)
org.stringtemplate.v4.ST	generateBaseListener()
org.stringtemplate.v4.ST	generateBaseListener(boolean header)
org.stringtemplate.v4.ST	generateBaseVisitor()
org.stringtemplate.v4.ST	generateBaseVisitor(boolean header)
org.stringtemplate.v4.ST	generateLexer()
org.stringtemplate.v4.ST	generateLexer(boolean header)
org.stringtemplate.v4.ST	generateListener()
org.stringtemplate.v4.ST	generateListener(boolean header)
org.stringtemplate.v4.ST	generateParser()
org.stringtemplate.v4.ST	generateParser(boolean header)
org.stringtemplate.v4.ST	generateVisitor()
org.stringtemplate.v4.ST	generateVisitor(boolean header)
String	getBaseListenerFileName()
String	getBaseListenerFileName(boolean header)
String	getBaseVisitorFileName()
String	getBaseVisitorFileName(boolean header)
String	getHeaderFileName()
String	getListenerFileName()
String	getListenerFileName(boolean header)
String	getRecognizerFileName()
String	getRecognizerFileName(boolean header)
Target	getTarget()
org.stringtemplate.v4.STGroup	getTemplates()
String	getVisitorFileName()
String	getVisitorFileName(boolean header)
String	getVocabFileName()	What is the name of the vocab file generated for this grammar?
void	write(org.stringtemplate.v4.ST code, String fileName)
void	writeBaseListener(org.stringtemplate.v4.ST outputFileST, boolean header)
void	writeBaseVisitor(org.stringtemplate.v4.ST outputFileST, boolean header)
void	writeListener(org.stringtemplate.v4.ST outputFileST, boolean header)
void	writeRecognizer(org.stringtemplate.v4.ST outputFileST, boolean header)
void	writeVisitor(org.stringtemplate.v4.ST outputFileST, boolean header)
void	writeVocabFile()

Methods inherited from class java.lang.Object

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

Field Details

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

public final Grammar g

tool

public final Tool tool

language

public final String language

lineWidth

public int lineWidth

Method Details

create

public static CodeGenerator create(Grammar g)

create

public static CodeGenerator create(Tool tool,
 Grammar g,
 String language)

getTarget

public Target getTarget()

getTemplates

public org.stringtemplate.v4.STGroup getTemplates()

generateLexer

public org.stringtemplate.v4.ST generateLexer()

generateLexer

public org.stringtemplate.v4.ST generateLexer(boolean header)

generateParser

public org.stringtemplate.v4.ST generateParser()

generateParser

public org.stringtemplate.v4.ST generateParser(boolean header)

generateListener

public org.stringtemplate.v4.ST generateListener()

generateListener

public org.stringtemplate.v4.ST generateListener(boolean header)

generateBaseListener

public org.stringtemplate.v4.ST generateBaseListener()

generateBaseListener

public org.stringtemplate.v4.ST generateBaseListener(boolean header)

generateVisitor

public org.stringtemplate.v4.ST generateVisitor()

generateVisitor

public org.stringtemplate.v4.ST generateVisitor(boolean header)

generateBaseVisitor

public org.stringtemplate.v4.ST generateBaseVisitor()

generateBaseVisitor

public org.stringtemplate.v4.ST generateBaseVisitor(boolean header)

writeRecognizer

public void writeRecognizer(org.stringtemplate.v4.ST outputFileST,
 boolean header)

writeListener

public void writeListener(org.stringtemplate.v4.ST outputFileST,
 boolean header)

writeBaseListener

public void writeBaseListener(org.stringtemplate.v4.ST outputFileST,
 boolean header)

writeVisitor

public void writeVisitor(org.stringtemplate.v4.ST outputFileST,
 boolean header)

writeBaseVisitor

public void writeBaseVisitor(org.stringtemplate.v4.ST outputFileST,
 boolean header)

writeVocabFile

public void writeVocabFile()

write

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

getRecognizerFileName

public String getRecognizerFileName()

getListenerFileName

public String getListenerFileName()

getVisitorFileName

public String getVisitorFileName()

getBaseListenerFileName

public String getBaseListenerFileName()

getBaseVisitorFileName

public String getBaseVisitorFileName()

getRecognizerFileName

public String getRecognizerFileName(boolean header)

getListenerFileName

public String getListenerFileName(boolean header)

getVisitorFileName

public String getVisitorFileName(boolean header)

getBaseListenerFileName

public String getBaseListenerFileName(boolean header)

getBaseVisitorFileName

public String getBaseVisitorFileName(boolean header)

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