org.eclipse.xtext.parser.packrat.consumers

Class TerminalConsumer

java.lang.Object

org.eclipse.xtext.parser.packrat.consumers.AbstractConsumer

org.eclipse.xtext.parser.packrat.consumers.TerminalConsumer

All Implemented Interfaces:

ITerminalConsumer

Direct Known Subclasses:

AbstractRuleAwareTerminalConsumer, EnumLiteralConsumer, KeywordConsumer

public abstract class TerminalConsumer
extends AbstractConsumer
implements ITerminalConsumer

Author:

Sebastian Zarnekow - Initial contribution and API

Field Summary

Fields

Modifier and Type	Field and Description
protected int	SUCCESS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TerminalConsumer(ITerminalConsumerConfiguration configuration)

Method Summary

Methods

Modifier and Type	Method and Description
int	consume() Scan the configured input source for a consumable terminal at the current offset.
int	consume(ISequenceMatcher notMatching) Scan the configured input source for a consumable terminal at the current offset.
int	consume(String feature, boolean isMany, boolean isBoolean, AbstractElement element, ISequenceMatcher notMatching, boolean optional) Scan the configured input source for a consumable terminal at the current offset.
protected AbstractParsedToken	createParsedToken(String feature, boolean isMany, boolean isBoolean, AbstractElement element, ISequenceMatcher notMatching, boolean optional, int prevMarker, IParsedTokenSource source)
protected abstract int	doConsume()
protected boolean	eof()
protected char	getChar()
abstract org.eclipse.emf.ecore.EObject	getGrammarElement()
protected abstract String	getRuleName()
protected void	incOffset()
boolean	isHidden()
protected int	mark()
protected boolean	peekChar(ICharacterClass characterClass)
protected boolean	readAnyChar(char... candidates)
protected boolean	readAnyChars(char... candidates)
protected boolean	readChar(char candidate)
protected boolean	readChar(ICharacterClass characterClass)
protected boolean	readCharBetween(char min, char max)
protected boolean	readChars(char candidate)
protected boolean	readChars(ICharacterClass characterClass)
protected boolean	readCharsBetween(char min, char max)
protected boolean	readString(CharSequence seq)
protected boolean	readUntil(CharSequence seq)
protected void	rollbackTo(int marker)
void	setHidden(boolean hidden)
String	toString()

Methods inherited from class org.eclipse.xtext.parser.packrat.consumers.AbstractConsumer

getInput, getOffset, getTokenAcceptor

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS

protected int SUCCESS

Constructor Detail

TerminalConsumer

protected TerminalConsumer(ITerminalConsumerConfiguration configuration)

Method Detail

consume

public final int consume(String feature,
          boolean isMany,
          boolean isBoolean,
          AbstractElement element,
          ISequenceMatcher notMatching,
          boolean optional)

Description copied from interface: ITerminalConsumer

Scan the configured input source for a consumable terminal at the current offset. If it can be found, create a configured parsed token and increase the offset of the input.

Specified by:

consume in interface ITerminalConsumer

createParsedToken

protected AbstractParsedToken createParsedToken(String feature,
                                    boolean isMany,
                                    boolean isBoolean,
                                    AbstractElement element,
                                    ISequenceMatcher notMatching,
                                    boolean optional,
                                    int prevMarker,
                                    IParsedTokenSource source)

consume

public final int consume()

Description copied from interface: ITerminalConsumer

Scan the configured input source for a consumable terminal at the current offset. If it can be found, do nothing but increase the offset of the input.

Specified by:

consume in interface ITerminalConsumer

consume

public final int consume(ISequenceMatcher notMatching)

Description copied from interface: ITerminalConsumer

Scan the configured input source for a consumable terminal at the current offset. If it can be found, do nothing but increase the offset of the input.

Specified by:

consume in interface ITerminalConsumer

incOffset

protected void incOffset()

readAnyChar

protected boolean readAnyChar(char... candidates)

readChar

protected boolean readChar(char candidate)

readChar

protected boolean readChar(ICharacterClass characterClass)

getChar

protected char getChar()

peekChar

protected boolean peekChar(ICharacterClass characterClass)

readCharBetween

protected boolean readCharBetween(char min,
                      char max)

readAnyChars

protected boolean readAnyChars(char... candidates)

readChars

protected boolean readChars(char candidate)

readChars

protected boolean readChars(ICharacterClass characterClass)

readCharsBetween

protected boolean readCharsBetween(char min,
                       char max)

readString

protected boolean readString(CharSequence seq)

readUntil

protected boolean readUntil(CharSequence seq)

doConsume

protected abstract int doConsume()

getGrammarElement

public abstract org.eclipse.emf.ecore.EObject getGrammarElement()

getRuleName

protected abstract String getRuleName()

setHidden

public void setHidden(boolean hidden)

Specified by:

setHidden in interface ITerminalConsumer

isHidden

public boolean isHidden()

Specified by:

isHidden in interface ITerminalConsumer

eof

protected boolean eof()

mark

protected int mark()

rollbackTo

protected void rollbackTo(int marker)

toString

public String toString()

Overrides:

toString in class Object