org.eclipse.xtext.parser.packrat.internal

Class Marker

java.lang.Object

org.eclipse.xtext.parser.packrat.tokens.AbstractParsedToken

org.eclipse.xtext.parser.packrat.internal.Marker

All Implemented Interfaces:

IBacktracker, IMarkerFactory.IMarker, IParsedTokenAcceptor

public class Marker
extends AbstractParsedToken
implements IMarkerFactory.IMarker, IParsedTokenAcceptor, IBacktracker

Author:

Sebastian Zarnekow - Initial contribution and API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Marker.IMarkerClient
static interface	Marker.IMarkerVisitor

Nested classes/interfaces inherited from class org.eclipse.xtext.parser.packrat.tokens.AbstractParsedToken

AbstractParsedToken.End

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

IBacktracker.IBacktrackingResult

Constructor Summary

Constructors

Constructor and Description
Marker(Marker parent, int offset, ICharSequenceWithOffset input, Marker.IMarkerClient client)

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(AbstractParsedToken token)
void	accept(IParsedTokenVisitor visitor)
void	commit() Commit all recorded information.
void	discardLastOffset()
void	flush() Commit all recorded information.
Marker	fork() Create another marker for the very same original state of the parser.
Marker	forkAfterSkipped(int before)
Marker.IMarkerClient	getClient()
List<AbstractParsedToken>	getContent()
ICharSequenceWithOffset	getInput()
Marker	getParent()
IMarkerFactory.IMarker	join(IMarkerFactory.IMarker forkedMarker) Join the forked marker and keep this one as the better one.
Marker	reInit(int offset, Marker parent, ICharSequenceWithOffset input, Marker.IMarkerClient client)
void	replaceContent(List<AbstractParsedToken> tokens)
void	rollback() Discard all recorded information.
void	setClient(Marker.IMarkerClient client)
void	setInput(ICharSequenceWithOffset input)
IBacktracker.IBacktrackingResult	skipPreviousToken()
String	toString()

Methods inherited from class org.eclipse.xtext.parser.packrat.tokens.AbstractParsedToken

getLength, getOffset, getText, isSkipped, setLength, setOffset, setSkipped

Methods inherited from class java.lang.Object

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

Constructor Detail

Marker

public Marker(Marker parent,
      int offset,
      ICharSequenceWithOffset input,
      Marker.IMarkerClient client)

Method Detail

reInit

public Marker reInit(int offset,
            Marker parent,
            ICharSequenceWithOffset input,
            Marker.IMarkerClient client)

rollback

public void rollback()

Description copied from interface: IMarkerFactory.IMarker

Discard all recorded information. Rolls the parser's state back as it was before it was marked. The marker cannot be used any longer after a rollback.

Specified by:

rollback in interface IMarkerFactory.IMarker

flush

public void flush()

Description copied from interface: IMarkerFactory.IMarker

Commit all recorded information. You can reuse a marker flushed marker. The flushed data cannot be rolled back by this marker.

Specified by:

flush in interface IMarkerFactory.IMarker

commit

public void commit()

Description copied from interface: IMarkerFactory.IMarker

Commit all recorded information. You cannot use a marker any longer, if you commit it's data.

Specified by:

commit in interface IMarkerFactory.IMarker

fork

public Marker fork()

Description copied from interface: IMarkerFactory.IMarker

Create another marker for the very same original state of the parser. A fork can be understood as an alternative branch in the decision tree. Before you commit or flush any of the alternatives, you have to ensure that they are rejoined. Otherwise will the commit be rejected.

Specified by:

fork in interface IMarkerFactory.IMarker

forkAfterSkipped

public Marker forkAfterSkipped(int before)

join

public IMarkerFactory.IMarker join(IMarkerFactory.IMarker forkedMarker)

Description copied from interface: IMarkerFactory.IMarker

Join the forked marker and keep this one as the better one. Will discard all recorded information of the forked marker and reset the parsers state to this marker.

Specified by:

join in interface IMarkerFactory.IMarker

getContent

public List<AbstractParsedToken> getContent()

getParent

public Marker getParent()

toString

public String toString()

Overrides:

toString in class AbstractParsedToken

accept

public void accept(IParsedTokenVisitor visitor)

Overrides:

accept in class AbstractParsedToken

accept

public void accept(AbstractParsedToken token)

Specified by:

accept in interface IParsedTokenAcceptor

setClient

public void setClient(Marker.IMarkerClient client)

getClient

public Marker.IMarkerClient getClient()

setInput

public void setInput(ICharSequenceWithOffset input)

getInput

public ICharSequenceWithOffset getInput()

skipPreviousToken

public IBacktracker.IBacktrackingResult skipPreviousToken()

Specified by:

skipPreviousToken in interface IBacktracker

discardLastOffset

public void discardLastOffset()

replaceContent

public void replaceContent(List<AbstractParsedToken> tokens)