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.

Constructor Detail

• Target

  protected Target(CodeGenerator gen,
                   String language)

Method Detail

• getCodeGenerator

  public CodeGenerator getCodeGenerator()

• getLanguage

  public String getLanguage()

• getVersion

  public abstract String getVersion()

  ANTLR tool should check output templates / target are compatible with tool code generation. For now, a simple string match used on x.y of x.y.z scheme. We use a method to avoid mismatches between a template called VERSION. This value is checked against Tool.VERSION during load of templates. This additional method forces all targets 4.3 and beyond to add this method.

  Since:

  4.3

• getTemplates

  public STGroup getTemplates()

• genFile

  protected void genFile(Grammar g,
                         ST outputFileST,
                         String fileName)

• genListenerFile

  protected void genListenerFile(Grammar g,
                                 ST outputFileST)

• genRecognizerHeaderFile

  protected void genRecognizerHeaderFile(Grammar g,
                                         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)

• 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 String.replace(char, char) 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)

• getSerializedATNSegmentLimit

  public int getSerializedATNSegmentLimit()

  Gets the maximum number of 16-bit unsigned integers that can be encoded in a single segment of the serialized ATN.

  Returns:

  the serialized ATN segment limit

  See Also:

  SerializedATN.getSegments()

• getInlineTestSetWordSize

  public int getInlineTestSetWordSize()

  How many bits should be used to do inline token type tests? Java assumes a 64-bit word for bitsets. Must be a valid wordsize for your target like 8, 16, 32, 64, etc...

  Since:

  4.5

• grammarSymbolCausesIssueInGeneratedCode

  public boolean grammarSymbolCausesIssueInGeneratedCode(GrammarAST idNode)

• visibleGrammarSymbolCausesIssueInGeneratedCode

  protected abstract boolean visibleGrammarSymbolCausesIssueInGeneratedCode(GrammarAST idNode)

• templatesExist

  public boolean templatesExist()

• loadTemplates

  protected STGroup loadTemplates()

• wantsBaseListener

  public boolean wantsBaseListener()

  Since:

  4.3

• wantsBaseVisitor

  public boolean wantsBaseVisitor()

  Since:

  4.3

• supportsOverloadedMethods

  public boolean supportsOverloadedMethods()

  Since:

  4.3