antlr

Class LexerGrammar

java.lang.Object

antlr.Grammar

antlr.LexerGrammar

 class LexerGrammar
extends Grammar

Lexer-specific grammar subclass

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	caseSensitive true if the lexer generates case-sensitive literals testing
protected boolean	caseSensitiveLiterals
protected BitSet	charVocabulary
protected boolean	filterMode true if lexer is to ignore all unrecognized tokens
protected java.lang.String	filterRule if filterMode is true, then filterRule can indicate an optional rule to use as the scarf language.
protected boolean	testLiterals

Fields inherited from class antlr.Grammar

analyzerDebug, antlrTool, buildAST, classMemberAction, className, comment, debuggingOutput, defaultErrorHandler, exportVocab, fileName, generator, hasSyntacticPredicate, hasUserErrorHandling, importVocab, interactive, maxk, options, preambleAction, rules, superClass, symbols, theLLkAnalyzer, tokenManager, traceRules

Constructor Summary

Constructors

Constructor and Description
LexerGrammar(java.lang.String className_, Tool tool_, java.lang.String superClass)

Method Summary

Methods

Modifier and Type	Method and Description
void	generate() Top-level call to generate the code
java.lang.String	getSuperClass()
boolean	getTestLiterals()
void	processArguments(java.lang.String[] args) Process command line arguments.
void	setCharVocabulary(BitSet b) Set the character vocabulary used by the lexer
boolean	setOption(java.lang.String key, Token value) Set lexer options

Methods inherited from class antlr.Grammar

define, getClassName, getDefaultErrorHandler, getFilename, getIntegerOption, getOption, getSymbol, getSymbols, hasOption, isDefined, setCodeGenerator, setFilename, setGrammarAnalyzer, setTokenManager, toString

Methods inherited from class java.lang.Object

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

Field Detail

charVocabulary

protected BitSet charVocabulary

testLiterals

protected boolean testLiterals

caseSensitiveLiterals

protected boolean caseSensitiveLiterals

caseSensitive

protected boolean caseSensitive

true if the lexer generates case-sensitive literals testing

filterMode

protected boolean filterMode

true if lexer is to ignore all unrecognized tokens

filterRule

protected java.lang.String filterRule

if filterMode is true, then filterRule can indicate an optional rule to use as the scarf language. If null, programmer used plain "filter=true" not "filter=rule".

Constructor Detail

LexerGrammar

LexerGrammar(java.lang.String className_,
            Tool tool_,
            java.lang.String superClass)

Method Detail

generate

public void generate()
              throws java.io.IOException

Top-level call to generate the code

Specified by:

generate in class Grammar

Throws:

java.io.IOException

getSuperClass

public java.lang.String getSuperClass()

Specified by:

getSuperClass in class Grammar

getTestLiterals

public boolean getTestLiterals()

processArguments

public void processArguments(java.lang.String[] args)

Process command line arguments. -trace have all rules call traceIn/traceOut -traceLexer have lexical rules call traceIn/traceOut -debug generate debugging output for parser debugger

Specified by:

processArguments in class Grammar

setCharVocabulary

public void setCharVocabulary(BitSet b)

Set the character vocabulary used by the lexer

setOption

public boolean setOption(java.lang.String key,
                Token value)

Set lexer options

Overrides:

setOption in class Grammar

Parameters:

key - The name of the option.

value - The value to associate with the key.

Returns:

true if the option was a valid generic grammar option, false o/w