eu.bandm.tools.xantlr.runtime

Class X_LLkParser

java.lang.Object

antlr.Parser

antlr.LLkParser

eu.bandm.tools.xantlr.runtime.X_LLkParser

Direct Known Subclasses:

D2dParser, JavaParser, UModParser

@Runtime
public class X_LLkParser
extends antlr.LLkParser

Base class for all parsers generated by xantlr, see user doc. Such a new base class is needed (1) to perform the event generation, which is the purpose of the xantlr tool, and (2) to re-implement the antlr error handling routines, for to pipe the antlr errors and warnings into the metatools message system.

(1) is done as follows: the xantlr transformations add semantic actions (as described in the user doc) to the parser code which call the event genrating runtime routines in that EventGenerator object which is stored in event.
(Currently this object is always a SAXEventGenerator, but this is not necessarily so.)
(2) is achieved by re-implementing the methods reportError(String), reportWarning(String), etc., which are called by standard antlr behaviour, and here create Message objects.
Before starting any parser process, the user has to configure this class corretly with the targets of these both data channeld, ie. by calling setEventGenerator(EventGenerator) and setMessageReceiver(MessageReceiver). After creation of the X_LLKParser, the field event contains a new EventFilter, which is a clsss which discards all events! This is probably not what you want.
(Plese note that the parser has to be linked to a lexer using HistoryToken. See there for an example.)

Field Summary

Fields

Modifier and Type	Field and Description
protected EventGenerator<NamespaceName,XMLDocumentIdentifier>	event
protected MessageReceiver<? super SimpleMessage<XMLDocumentIdentifier>>	messageReceiver

Fields inherited from class antlr.Parser

astFactory, inputState, returnAST, tokenNames, tokenTypeToASTClassMap, traceDepth

Constructor Summary

Constructors

Constructor and Description
X_LLkParser(antlr.ParserSharedInputState lexer, int k)
X_LLkParser(antlr.TokenBuffer lexer, int k)
X_LLkParser(antlr.TokenStream lexer, int k)

Method Summary

Modifier and Type	Method and Description
EventGenerator<NamespaceName,XMLDocumentIdentifier>	getEventGenerator()
Location<XMLDocumentIdentifier>	getLocation()
void	reportError(antlr.RecognitionException e)
void	reportError(String s)
void	reportWarning(String s)
void	setEventGenerator(EventGenerator<NamespaceName,XMLDocumentIdentifier> event)
void	setFilename(String filename) Deprecated. ignored by #getLocator mechanism.
void	setMessageReceiver(MessageReceiver<? super SimpleMessage<XMLDocumentIdentifier>> mr)

Methods inherited from class antlr.LLkParser

consume, LA, LT, traceIn, traceOut

Methods inherited from class antlr.Parser

addMessageListener, addParserListener, addParserMatchListener, addParserTokenListener, addSemanticPredicateListener, addSyntacticPredicateListener, addTraceListener, consumeUntil, consumeUntil, defaultDebuggingSetup, getAST, getASTFactory, getFilename, getInputState, getTokenName, getTokenNames, getTokenTypeToASTClassMap, isDebugMode, mark, match, match, matchNot, panic, removeMessageListener, removeParserListener, removeParserMatchListener, removeParserTokenListener, removeSemanticPredicateListener, removeSyntacticPredicateListener, removeTraceListener, rewind, setASTFactory, setASTNodeClass, setASTNodeType, setDebugMode, setIgnoreInvalidDebugCalls, setInputState, setTokenBuffer, traceIndent

Methods inherited from class java.lang.Object

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

Field Detail

event

protected EventGenerator<NamespaceName,XMLDocumentIdentifier> event

messageReceiver

protected MessageReceiver<? super SimpleMessage<XMLDocumentIdentifier>> messageReceiver

Constructor Detail

X_LLkParser

public X_LLkParser(antlr.TokenStream lexer,
                   int k)

X_LLkParser

public X_LLkParser(antlr.TokenBuffer lexer,
                   int k)

X_LLkParser

public X_LLkParser(antlr.ParserSharedInputState lexer,
                   int k)

Method Detail

setEventGenerator

public void setEventGenerator(EventGenerator<NamespaceName,XMLDocumentIdentifier> event)

getEventGenerator

public EventGenerator<NamespaceName,XMLDocumentIdentifier> getEventGenerator()

setMessageReceiver

public void setMessageReceiver(MessageReceiver<? super SimpleMessage<XMLDocumentIdentifier>> mr)

reportError

public void reportError(String s)

Overrides:

reportError in class antlr.Parser

reportWarning

public void reportWarning(String s)

Overrides:

reportWarning in class antlr.Parser

reportError

public void reportError(antlr.RecognitionException e)

Overrides:

reportError in class antlr.Parser

getLocation

public Location<XMLDocumentIdentifier> getLocation()

setFilename

@Deprecated
public void setFilename(String filename)

Deprecated. ignored by #getLocator mechanism.

Overrides:

setFilename in class antlr.Parser