org.antlr.v4.codegen

Class Target

java.lang.Object

org.antlr.v4.codegen.Target

public class Target
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
Set<String>	badWords Avoid grammar symbols in this set to prevent conflicts in gen'd code.
CodeGenerator	gen
static String[]	javaKeywords
protected String[]	targetCharValueEscape For pure strings of Java 16-bit Unicode char, how can we display it in the target language as a literal.

Constructor Summary

Constructors

Constructor and Description
Target(CodeGenerator gen)

Method Summary

Methods

Modifier and Type	Method and Description
void	addBadWords()
String	encodeIntAsCharEscape(int v) Assume 16-bit char
protected void	genFile(Grammar g, org.stringtemplate.v4.ST outputFileST, String fileName)
protected void	genListenerFile(Grammar g, org.stringtemplate.v4.ST outputFileST)
protected void	genRecognizerHeaderFile(Grammar g, org.stringtemplate.v4.ST headerFileST, String extName)
String	getAltLabelContextStructName(String label)
String	getElementListName(String name)
String	getElementName(String name)
String	getImplicitRuleLabel(String ruleName)
String	getImplicitSetLabel(String id)
String	getImplicitTokenLabel(String tokenName)
String	getListLabel(String label)
String	getLoopCounter(GrammarAST ast)
String	getLoopLabel(GrammarAST ast)
String	getRuleFunctionContextStructName(Rule r)
String	getRuleFunctionContextStructName(RuleFunction function) If we know which actual function, we can provide the actual ctx type.
String	getTarget64BitStringFromValue(long word) Convert long to 0xNNNNNNNNNNNNNNNN by default for spitting out with bitsets.
String	getTargetCharLiteralCharValue(int c) Convert from an ANTLR char literal found in a grammar file to an equivalent char literal in the target language.
String	getTargetStringLiteralFromANTLRStringLiteral(CodeGenerator generator, String literal, boolean addQuotes) Convert from an ANTLR string literal found in a grammar file to an equivalent string literal in the target language.
String	getTargetStringLiteralFromString(String s)
String	getTargetStringLiteralFromString(String s, boolean quoted) Given a random string of Java unicode chars, return a new string with optionally appropriate quote characters for target language and possibly with some escaped characters.
String	getTokenTypeAsTargetLabel(Grammar g, int ttype) Get a meaningful name for a token type useful during code generation.
String[]	getTokenTypesAsTargetLabels(Grammar g, int[] ttypes)
boolean	grammarSymbolCausesIssueInGeneratedCode(GrammarAST idNode)

Methods inherited from class java.lang.Object

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

Field Detail

targetCharValueEscape

protected String[] targetCharValueEscape

For pure strings of Java 16-bit Unicode char, how can we display it in the target language as a literal. Useful for dumping predicates and such that may refer to chars that need to be escaped when represented as strings. Also, templates need to be escaped so that the target language can hold them as a string.

I have defined (via the constructor) the set of typical escapes, but your Target subclass is free to alter the translated chars or add more definitions. This is non-static so each target can have a different set in memory at same time.

gen

public CodeGenerator gen

badWords

public Set<String> badWords

Avoid grammar symbols in this set to prevent conflicts in gen'd code.

javaKeywords

public static String[] javaKeywords

Constructor Detail

Target

public Target(CodeGenerator gen)

Method Detail

addBadWords

public void addBadWords()

genFile

protected void genFile(Grammar g,
           org.stringtemplate.v4.ST outputFileST,
           String fileName)

genListenerFile

protected void genListenerFile(Grammar g,
                   org.stringtemplate.v4.ST outputFileST)

genRecognizerHeaderFile

protected void genRecognizerHeaderFile(Grammar g,
                           org.stringtemplate.v4.ST headerFileST,
                           String extName)

getTokenTypeAsTargetLabel

public String getTokenTypeAsTargetLabel(Grammar g,
                               int ttype)

Get a meaningful name for a token type useful during code generation. Literals without associated names are converted to the string equivalent of their integer values. Used to generate x==ID and x==34 type comparisons etc... Essentially we are looking for the most obvious way to refer to a token type in the generated code.

getTokenTypesAsTargetLabels

public String[] getTokenTypesAsTargetLabels(Grammar g,
                                   int[] ttypes)

getTargetCharLiteralCharValue

public String getTargetCharLiteralCharValue(int c)

Convert from an ANTLR char literal found in a grammar file to an equivalent char literal in the target language. For most languages, this means leaving 'x' as 'x'. Actually, we need to escape ' ' so that it doesn't get converted to \n by the compiler. Convert the literal to the char value and then to an appropriate target char literal. Expect single quotes around the incoming literal. TODO: unused and should call CharSupport.getANTLRCharLiteralForChar anyway

getTarget64BitStringFromValue

public String getTarget64BitStringFromValue(long word)

Convert long to 0xNNNNNNNNNNNNNNNN by default for spitting out with bitsets. I.e., convert bytes to hex string.

getTargetStringLiteralFromString

public String getTargetStringLiteralFromString(String s,
                                      boolean quoted)

Given a random string of Java unicode chars, return a new string with optionally appropriate quote characters for target language and possibly with some escaped characters. For example, if the incoming string has actual newline characters, the output of this method would convert them to the two char sequence \n for Java, C, C++, ... The new string has double-quotes around it as well. Example String in memory: a"[newlinechar]b'c[carriagereturnchar]d[tab]e\f would be converted to the valid Java s: "a\"\nb'c\rd\te\\f" or a\"\nb'c\rd\te\\f depending on the quoted arg.

getTargetStringLiteralFromString

public String getTargetStringLiteralFromString(String s)

getTargetStringLiteralFromANTLRStringLiteral

public String getTargetStringLiteralFromANTLRStringLiteral(CodeGenerator generator,
                                                  String literal,
                                                  boolean addQuotes)

Convert from an ANTLR string literal found in a grammar file to an equivalent string literal in the target language. For Java, this is the translation 'a\n"' → "a\n\"". Expect single quotes around the incoming literal. Just flip the quotes and replace double quotes with \".

Note that we have decided to allow people to use '\"' without penalty, so we must build the target string in a loop as Utils.replace(java.lang.String, java.lang.String, java.lang.String) cannot handle both \" and " without a lot of messing around.

encodeIntAsCharEscape

public String encodeIntAsCharEscape(int v)

Assume 16-bit char

getLoopLabel

public String getLoopLabel(GrammarAST ast)

getLoopCounter

public String getLoopCounter(GrammarAST ast)

getListLabel

public String getListLabel(String label)

getRuleFunctionContextStructName

public String getRuleFunctionContextStructName(Rule r)

getAltLabelContextStructName

public String getAltLabelContextStructName(String label)

getRuleFunctionContextStructName

public String getRuleFunctionContextStructName(RuleFunction function)

If we know which actual function, we can provide the actual ctx type. This will contain implicit labels etc... From outside, though, we see only ParserRuleContext unless there are externally visible stuff like args, locals, explicit labels, etc...

getImplicitTokenLabel

public String getImplicitTokenLabel(String tokenName)

getImplicitSetLabel

public String getImplicitSetLabel(String id)

getImplicitRuleLabel

public String getImplicitRuleLabel(String ruleName)

getElementListName

public String getElementListName(String name)

getElementName

public String getElementName(String name)

grammarSymbolCausesIssueInGeneratedCode

public boolean grammarSymbolCausesIssueInGeneratedCode(GrammarAST idNode)