org.eclipse.xtext.parser.packrat

Class AbstractPackratParser

java.lang.Object

org.eclipse.xtext.parser.AbstractParser

org.eclipse.xtext.parser.packrat.AbstractPackratParser

All Implemented Interfaces:

CharSequence, IParser, IConsumerUtility, ICharSequenceWithOffset, IHiddenTokenHandler, IMarkerFactory, Marker.IMarkerClient, IPackratParser, IParsedTokenAcceptor

Direct Known Subclasses:

TerminalsPackratParser

public abstract class AbstractPackratParser
extends AbstractParser
implements IPackratParser, Marker.IMarkerClient, ICharSequenceWithOffset, IParsedTokenAcceptor, IHiddenTokenHandler, IConsumerUtility

Author:

Sebastian Zarnekow - Initial contribution and API, Jan Koehnlein

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.xtext.parser.IParser

IParser.NullImpl

Nested classes/interfaces inherited from interface org.eclipse.xtext.parser.packrat.IMarkerFactory

IMarkerFactory.IMarker

Nested classes/interfaces inherited from interface org.eclipse.xtext.parser.packrat.IHiddenTokenHandler

IHiddenTokenHandler.IHiddenTokenState

Field Summary

Fields inherited from interface org.eclipse.xtext.parser.packrat.IHiddenTokenHandler

EMPTY_HIDDENS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPackratParser(IParseResultFactory parseResultFactory, IGrammarAccess grammarAccess)

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(AbstractParsedToken token)
char	charAt(int index)
void	consumeAction(Action action, boolean isMany)
int	consumeEnum(EnumLiteralDeclaration literal, ICharacterClass notFollowedBy)
protected void	consumeHiddens()
int	consumeKeyword(Keyword keyword, String feature, boolean isMany, boolean isBoolean, ICharacterClass notFollowedBy, boolean optional)
int	consumeNonTerminal(INonTerminalConsumer consumer, String feature, boolean isMany, boolean isDatatype, boolean isBoolean, AbstractElement grammarElement, boolean optional)
int	consumeTerminal(ITerminalConsumer consumer, String feature, boolean isMany, boolean isBoolean, AbstractElement grammarElement, ISequenceMatcher notMatching, boolean optional)
protected CharSequence	createCharSequence(Reader reader0)
protected KeywordConsumer	createKeywordConsumer()
protected EnumLiteralConsumer	createLiteralConsumer()
protected abstract IParserConfiguration	createParserConfiguration(AbstractParserConfiguration.IInternalParserConfiguration configuration)
protected IParseResult	doParse(CharSequence sequence)
protected IParseResult	doParse(Reader reader)
Marker	getActiveMarker()
protected IGrammarAccess	getGrammarAccess()
CharSequence	getInput()
Marker	getNextMarker(Marker parent, int offset)
int	getOffset() Retrieves the current state of the offset property.
protected IParseResultFactory	getParseResultFactory()
protected INonTerminalConsumer	getRootConsumer()
void	incOffset() Increments the offset by one.
void	incOffset(int amount) Increments the offset by the given amount.
int	length()
IMarkerFactory.IMarker	mark() Creates a new marker.
IParseResult	parse(CharSequence input)
IParseResult	parse(CharSequence input, INonTerminalConsumer consumer)
protected IParseResult	parse(INonTerminalConsumer consumer)
void	releaseMarker(Marker marker)
IHiddenTokenHandler.IHiddenTokenState	replaceHiddenTokens(ITerminalConsumer... consumers)
void	setActiveMarker(Marker marker)
void	setOffset(int offset) Random access to modify the offset.
CharSequence	subSequence(int start, int end)

Methods inherited from class org.eclipse.xtext.parser.AbstractParser

doReparse, isReparseSupported, parse, reparse

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.xtext.parser.IParser

parse, parse, parse, reparse

Methods inherited from interface java.lang.CharSequence

toString

Constructor Detail

AbstractPackratParser

protected AbstractPackratParser(IParseResultFactory parseResultFactory,
                     IGrammarAccess grammarAccess)

Method Detail

createParserConfiguration

protected abstract IParserConfiguration createParserConfiguration(AbstractParserConfiguration.IInternalParserConfiguration configuration)

createKeywordConsumer

protected KeywordConsumer createKeywordConsumer()

createLiteralConsumer

protected EnumLiteralConsumer createLiteralConsumer()

getInput

public CharSequence getInput()

parse

public final IParseResult parse(CharSequence input)

Specified by:

parse in interface IPackratParser

parse

public final IParseResult parse(CharSequence input,
                 INonTerminalConsumer consumer)

Specified by:

parse in interface IPackratParser

parse

protected final IParseResult parse(INonTerminalConsumer consumer)

getRootConsumer

protected INonTerminalConsumer getRootConsumer()

consumeHiddens

protected void consumeHiddens()

mark

public IMarkerFactory.IMarker mark()

Description copied from interface: IMarkerFactory

Creates a new marker.

Specified by:

mark in interface IMarkerFactory

Returns:

the created marker.

getActiveMarker

public Marker getActiveMarker()

Specified by:

getActiveMarker in interface Marker.IMarkerClient

getNextMarker

public Marker getNextMarker(Marker parent,
                   int offset)

Specified by:

getNextMarker in interface Marker.IMarkerClient

setActiveMarker

public void setActiveMarker(Marker marker)

Specified by:

setActiveMarker in interface Marker.IMarkerClient

releaseMarker

public void releaseMarker(Marker marker)

Specified by:

releaseMarker in interface Marker.IMarkerClient

consumeKeyword

public int consumeKeyword(Keyword keyword,
                 String feature,
                 boolean isMany,
                 boolean isBoolean,
                 ICharacterClass notFollowedBy,
                 boolean optional)

Specified by:

consumeKeyword in interface IConsumerUtility

consumeEnum

public int consumeEnum(EnumLiteralDeclaration literal,
              ICharacterClass notFollowedBy)

Specified by:

consumeEnum in interface IConsumerUtility

consumeTerminal

public int consumeTerminal(ITerminalConsumer consumer,
                  String feature,
                  boolean isMany,
                  boolean isBoolean,
                  AbstractElement grammarElement,
                  ISequenceMatcher notMatching,
                  boolean optional)

Specified by:

consumeTerminal in interface IConsumerUtility

consumeNonTerminal

public int consumeNonTerminal(INonTerminalConsumer consumer,
                     String feature,
                     boolean isMany,
                     boolean isDatatype,
                     boolean isBoolean,
                     AbstractElement grammarElement,
                     boolean optional)
                       throws Exception

Specified by:

consumeNonTerminal in interface IConsumerUtility

Throws:

Exception

consumeAction

public void consumeAction(Action action,
                 boolean isMany)

Specified by:

consumeAction in interface IConsumerUtility

getParseResultFactory

protected IParseResultFactory getParseResultFactory()

getGrammarAccess

protected IGrammarAccess getGrammarAccess()

getOffset

public int getOffset()

Description copied from interface: ICharSequenceWithOffset

Retrieves the current state of the offset property.

Specified by:

getOffset in interface ICharSequenceWithOffset

Returns:

the current offset.

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

length

public int length()

Specified by:

length in interface CharSequence

subSequence

public CharSequence subSequence(int start,
                       int end)

Specified by:

subSequence in interface CharSequence

incOffset

public void incOffset()

Description copied from interface: ICharSequenceWithOffset

Increments the offset by one.

Specified by:

incOffset in interface ICharSequenceWithOffset

incOffset

public void incOffset(int amount)

Description copied from interface: ICharSequenceWithOffset

Increments the offset by the given amount. Can be used to decrement the offset.

Specified by:

incOffset in interface ICharSequenceWithOffset

Parameters:

amount - the number of offset that should be shifted.

accept

public void accept(AbstractParsedToken token)

Specified by:

accept in interface IParsedTokenAcceptor

setOffset

public void setOffset(int offset)

Description copied from interface: ICharSequenceWithOffset

Random access to modify the offset. Can be set independently from the length of the char sequence.

Specified by:

setOffset in interface ICharSequenceWithOffset

Parameters:

offset - the new offset.

replaceHiddenTokens

public IHiddenTokenHandler.IHiddenTokenState replaceHiddenTokens(ITerminalConsumer... consumers)

Specified by:

replaceHiddenTokens in interface IHiddenTokenHandler

doParse

protected IParseResult doParse(Reader reader)

Specified by:

doParse in class AbstractParser

createCharSequence

protected CharSequence createCharSequence(Reader reader0)

doParse

protected IParseResult doParse(CharSequence sequence)

Specified by:

doParse in class AbstractParser