com.github.fge.grappa.run.context

Interface Context<V>

All Known Subinterfaces:

MatcherContext<V>

All Known Implementing Classes:

DefaultMatcherContext

public interface Context<V>

A Context object is available to parser actions methods during their runtime and provides various support functionalities.

Method Summary

Methods

Modifier and Type	Method and Description
char	getCurrentChar() Returns the character at the current index..
int	getCurrentCodePoint() Return the code point at the current index
int	getCurrentIndex() Returns the current index in the input buffer.
char	getFirstMatchChar() Returns the first character of the input text matched by the rule immediately preceding the action expression that is currently being evaluated.
InputBuffer	getInputBuffer() Returns the InputBuffer the parser is currently running against
int	getLevel() Returns the current matcher level, with 0 being the root level, 1 being one level below the root and so on.
String	getMatch() Returns the input text matched by the rule immediately preceding the action expression that is currently being evaluated.
int	getMatchEndIndex() Returns the end index of the rule immediately preceding the action expression that is currently being evaluated.
Matcher	getMatcher() Returns the Matcher of this context or null, if this context is not valid anymore.
int	getMatchLength() Returns the number of characters matched by the rule immediately preceding the action expression that is currently being evaluated.
IndexRange	getMatchRange() Creates a new IndexRange instance covering the input text matched by the rule immediately preceding the action expression that is currently being evaluated.
int	getMatchStartIndex() Returns the start index of the rule immediately preceding the action expression that is currently being evaluated.
Position	getPosition() Returns the current position in the underlying InputBuffer as a Position instance.
int	getStartIndex() Returns the index into the underlying input buffer where the matcher of this context started its match.
ValueStack<V>	getValueStack() Returns the value stack instance used during this parsing run.
boolean	hasError() Determines if this context or any sub node recorded a parse error.
boolean	inPredicate() Determines if the current rule is running somewhere underneath a Test/TestNot rule.

Method Detail

getInputBuffer

@Nonnull
InputBuffer getInputBuffer()

Returns the InputBuffer the parser is currently running against

Returns:

the InputBuffer

getMatcher

@Nullable
Matcher getMatcher()

Returns the Matcher of this context or null, if this context is not valid anymore.

Returns:

the matcher

getStartIndex

int getStartIndex()

Returns the index into the underlying input buffer where the matcher of this context started its match.

Returns:

the start index

getCurrentIndex

int getCurrentIndex()

Returns the current index in the input buffer.

Returns:

the current index

getCurrentChar

char getCurrentChar()

Returns the character at the current index..

Returns:

the current character

getCurrentCodePoint

int getCurrentCodePoint()

Return the code point at the current index

Returns:

the code point, or -1 if end of buffer

See Also:

InputBuffer.codePointAt(int)

getLevel

int getLevel()

Returns the current matcher level, with 0 being the root level, 1 being one level below the root and so on.

Returns:

the current matcher level

inPredicate

boolean inPredicate()

Determines if the current rule is running somewhere underneath a Test/TestNot rule.

Returns:

true if the current context has a parent which corresponds to a Test/TestNot rule

hasError

boolean hasError()

Determines if this context or any sub node recorded a parse error.

Returns:

true if this context or any sub node recorded a parse error

getMatch

String getMatch()

Returns the input text matched by the rule immediately preceding the action expression that is currently being evaluated. This call can only be used in actions that are part of a Sequence rule and are not at first position in this Sequence.

Returns:

the input text matched by the immediately preceding subcontext

getFirstMatchChar

char getFirstMatchChar()

Returns the first character of the input text matched by the rule immediately preceding the action expression that is currently being evaluated. This call can only be used in actions that are part of a Sequence rule and are not at first position in this Sequence.

If the immediately preceding rule did not match anything this method throws a GrammarException. If you need to able to handle that case use the getMatch() method.

Returns:

the input text matched by the immediately preceding subcontext

getMatchStartIndex

int getMatchStartIndex()

Returns the start index of the rule immediately preceding the action expression that is currently being evaluated. This call can only be used in actions that are part of a Sequence rule and are not at first position in this Sequence.

Returns:

the start index of the context immediately preceding current action

getMatchEndIndex

int getMatchEndIndex()

Returns the end index of the rule immediately preceding the action expression that is currently being evaluated. This call can only be used in actions that are part of a Sequence rule and are not at first position in this Sequence.

Returns:

the end index of the context immediately preceding current action, i.e. the index of the character immediately following the last matched character

getMatchLength

int getMatchLength()

Returns the number of characters matched by the rule immediately preceding the action expression that is currently being evaluated. This call can only be used in actions that are part of a Sequence rule and are not at first position in this Sequence.

Returns:

the number of characters matched

getPosition

Position getPosition()

Returns the current position in the underlying InputBuffer as a Position instance.

Returns:

the current position in the underlying inputbuffer

getMatchRange

IndexRange getMatchRange()

Creates a new IndexRange instance covering the input text matched by the rule immediately preceding the action expression that is currently being evaluated. This call can only be used in actions that are part of a Sequence rule and are not at first position in this Sequence.

Returns:

a new IndexRange instance

getValueStack

ValueStack<V> getValueStack()

Returns the value stack instance used during this parsing run.

Returns:

the value stack