Nested and Inner Type Summary

Modifier and Type	Class and Description
public class	RubyTarget.RubyRenderer

Field Summary

Modifier and Type	Field and Description
public static final Set<String>	rubyKeywords A set of ruby keywords which are used to escape labels and method names which will cause parse errors in the ruby source
public static Map<String, Map<String, Object>>	sharedActionBlocks

Inherited from org.antlr.codegen.Target:: targetCharValueEscape

Constructor Summary

Access	Constructor and Description
public	RubyTarget()

Method Summary

Modifier and Type	Method and Description
public String	encodeIntAsCharEscape(final int v) Overrides org.antlr.codegen.Target.encodeIntAsCharEscape.
protected void	genRecognizerFile(Tool tool, CodeGenerator generator, Grammar grammar, ST outputFileST) Overrides org.antlr.codegen.Target.genRecognizerFile.
public int	getMaxCharValue(CodeGenerator generator) Overrides org.antlr.codegen.Target.getMaxCharValue. Some targets only support ASCII or 8-bit chars/strings.
public String	getTargetCharLiteralFromANTLRCharLiteral(CodeGenerator generator, String literal) Overrides org.antlr.codegen.Target.getTargetCharLiteralFromANTLRCharLiteral. Convert from an ANTLR char literal found in a grammar file to an equivalent char literal in the target language.
public String	getTokenTypeAsTargetLabel(CodeGenerator generator, int ttype) Overrides org.antlr.codegen.Target.getTokenTypeAsTargetLabel. Target must be able to override the labels used for token types
public boolean	isValidActionScope(int grammarType, String scope) Overrides org.antlr.codegen.Target.isValidActionScope. Is scope in @scope::name {action} valid for this kind of grammar?

Inherited from org.antlr.codegen.Target:: genRecognizerHeaderFile getTarget64BitStringFromValue getTargetStringLiteralFromANTLRStringLiteral getTargetStringLiteralFromString getTargetStringLiteralFromString performGrammarAnalysis postProcessAction useBaseTemplatesForSynPredFragments

Field Detail

rubyKeywords	back to summary
public static final Set<String> rubyKeywords A set of ruby keywords which are used to escape labels and method names which will cause parse errors in the ruby source

sharedActionBlocks	back to summary
public static Map<String, Map<String, Object>> sharedActionBlocks

Constructor Detail

RubyTarget	back to summary
public RubyTarget()

Method Detail

encodeIntAsCharEscape	back to summary
public String encodeIntAsCharEscape(final int v) Overrides org.antlr.codegen.Target.encodeIntAsCharEscape. Annotations @Override

encodeIntAsCharEscape

back to summary

public String encodeIntAsCharEscape(final int v)

Overrides org.antlr.codegen.Target.encodeIntAsCharEscape.

Annotations

@Override

genRecognizerFile	back to summary
protected void genRecognizerFile(Tool tool, CodeGenerator generator, Grammar grammar, ST outputFileST) throws IOException Overrides org.antlr.codegen.Target.genRecognizerFile. Annotations @Override

genRecognizerFile

back to summary

protected void genRecognizerFile(Tool tool, CodeGenerator generator, Grammar grammar, ST outputFileST) throws IOException

Overrides org.antlr.codegen.Target.genRecognizerFile.

Annotations

@Override

getMaxCharValue	back to summary
public int getMaxCharValue(CodeGenerator generator) Overrides org.antlr.codegen.Target.getMaxCharValue. Doc from org.antlr.codegen.Target.getMaxCharValue. Some targets only support ASCII or 8-bit chars/strings. For example, C++ will probably want to return 0xFF here. Annotations @Override

getMaxCharValue

back to summary

public int getMaxCharValue(CodeGenerator generator)

Overrides org.antlr.codegen.Target.getMaxCharValue.

Doc from org.antlr.codegen.Target.getMaxCharValue.

Some targets only support ASCII or 8-bit chars/strings. For example, C++ will probably want to return 0xFF here.

Annotations

@Override

getTargetCharLiteralFromANTLRCharLiteral	back to summary
public String getTargetCharLiteralFromANTLRCharLiteral(CodeGenerator generator, String literal) Overrides org.antlr.codegen.Target.getTargetCharLiteralFromANTLRCharLiteral. Doc from org.antlr.codegen.Target.getTargetCharLiteralFromANTLRCharLiteral. 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. Annotations @Override

getTargetCharLiteralFromANTLRCharLiteral

back to summary

public String getTargetCharLiteralFromANTLRCharLiteral(CodeGenerator generator, String literal)

Overrides org.antlr.codegen.Target.getTargetCharLiteralFromANTLRCharLiteral.

Doc from org.antlr.codegen.Target.getTargetCharLiteralFromANTLRCharLiteral.

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.

Annotations

@Override

getTokenTypeAsTargetLabel	back to summary
public String getTokenTypeAsTargetLabel(CodeGenerator generator, int ttype) Overrides org.antlr.codegen.Target.getTokenTypeAsTargetLabel. Doc from org.antlr.codegen.Target.getTokenTypeAsTargetLabel. Target must be able to override the labels used for token types Annotations @Override

getTokenTypeAsTargetLabel

back to summary

public String getTokenTypeAsTargetLabel(CodeGenerator generator, int ttype)

Overrides org.antlr.codegen.Target.getTokenTypeAsTargetLabel.

Doc from org.antlr.codegen.Target.getTokenTypeAsTargetLabel.

Target must be able to override the labels used for token types

Annotations

@Override

isValidActionScope	back to summary
public boolean isValidActionScope(int grammarType, String scope) Overrides org.antlr.codegen.Target.isValidActionScope. Doc from org.antlr.codegen.Target.isValidActionScope. Is scope in @scope::name {action} valid for this kind of grammar? Targets like C++ may want to allow new scopes like headerfile or some such. The action names themselves are not policed at the moment so targets can add template actions w/o having to recompile ANTLR. Annotations @Override

isValidActionScope

back to summary

public boolean isValidActionScope(int grammarType, String scope)

Overrides org.antlr.codegen.Target.isValidActionScope.

Doc from org.antlr.codegen.Target.isValidActionScope.

Is scope in @scope::name {action} valid for this kind of grammar? Targets like C++ may want to allow new scopes like headerfile or some such. The action names themselves are not policed at the moment so targets can add template actions w/o having to recompile ANTLR.

Annotations

@Override

org.antlr.codegen back to summary

public Class RubyTarget.RubyRenderer

Class Inheritance

extends Object
implements AttributeRenderer

java.lang.Object
org.antlr.codegen.RubyTarget.RubyRenderer

All Implemented Interfaces

org.stringtemplate.v4.AttributeRenderer

Field Summary

Modifier and Type	Field and Description
protected String[]	rubyCharValueEscape

Constructor Summary

Access	Constructor and Description
public	RubyRenderer()

Method Summary

Modifier and Type	Method and Description
private String	camelcase(String value)
private String	constantcase(String value)
private String	constantPath(String value)
private String	label(String value)
private String	lexerRule(String value)
private String	platform(String value)
private String	rubyString(String value)
private String	snakecase(String value) given an input string, which is presumed to contain a word, which may potentially be camelcased, and convert it to snake_case underscore style.
private String	subcamelcase(String value)
private String	symbol(String value)
public String	toString(Object o, String formatName, Locale locale) Implements org.stringtemplate.v4.AttributeRenderer.toString.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

rubyCharValueEscape	back to summary
protected String[] rubyCharValueEscape

Constructor Detail

RubyRenderer	back to summary
public RubyRenderer()

Method Detail

camelcase	back to summary
private String camelcase(String value)

constantcase	back to summary
private String constantcase(String value)

constantPath	back to summary
private String constantPath(String value)

label	back to summary
private String label(String value)

lexerRule	back to summary
private String lexerRule(String value)

platform	back to summary
private String platform(String value)

rubyString	back to summary
private String rubyString(String value)

snakecase	back to summary
private String snakecase(String value) given an input string, which is presumed to contain a word, which may potentially be camelcased, and convert it to snake_case underscore style. algorithm -- iterate through the string with a sliding window 3 chars wide example -- aGUIWhatNot c c+1 c+2 action a G << 'a' << '_' // a lower-upper word edge G U I << 'g' U I W << 'w' I W h << 'i' << '_' // the last character in an acronym run of uppers W h << 'w' ... and so on

snakecase

back to summary

private String snakecase(String value)

given an input string, which is presumed to contain a word, which may potentially be camelcased, and convert it to snake_case underscore style. algorithm -- iterate through the string with a sliding window 3 chars wide example -- aGUIWhatNot c c+1 c+2 action a G << 'a' << '_' // a lower-upper word edge G U I << 'g' U I W << 'w' I W h << 'i' << '_' // the last character in an acronym run of uppers W h << 'w' ... and so on

subcamelcase	back to summary
private String subcamelcase(String value)

symbol	back to summary
private String symbol(String value)

toString	back to summary
public String toString(Object o, String formatName, Locale locale) Implements org.stringtemplate.v4.AttributeRenderer.toString. Annotations @Override

toString

back to summary

public String toString(Object o, String formatName, Locale locale)

Implements org.stringtemplate.v4.AttributeRenderer.toString.

Annotations

@Override