Modifier and Type	Class and Description
pack-priv static enum	ParseContext.ErrorType
pack-priv static interface	ParseContext.ParserTrace Allows tracing of parsing progress during error condition, to ease debugging.

Field Summary

Modifier and Type	Field and Description
pack-priv int	at The current position of the input.
private int	currentErrorAt
private int	currentErrorIndex
private TreeNode	currentErrorNode
private ParseContext.ErrorType	currentErrorType
private String	encountered
pack-priv static final String	EOF
private final ArrayList<Object>	errors
private boolean	errorSuppressed
pack-priv final SourceLocator	locator
pack-priv final String	module
private ParseContext.ErrorType	overrideErrorType
pack-priv Object	result The current parse result.
pack-priv final CharSequence	source
pack-priv int	step The current logical step.
private ParseContext.ParserTrace	trace

Constructor Summary

Access	Constructor and Description
pack-priv	ParseContext(CharSequence source, int at, String module, SourceLocator locator)
pack-priv	ParseContext(CharSequence source, Object ret, int at, String module, SourceLocator locator)

Method Summary

Modifier and Type	Method and Description
pack-priv final boolean	applyAsDelimiter(Parser<?> parser) Runs `parser` with error recording suppressed.
pack-priv final boolean	applyNested(Parser<?> parser, ParseContext nestedState)
pack-priv final boolean	applyNewNode(Parser<?> parser, String name) Applies `parser` as a new tree node with `name`, and if fails, reports "expecting $name".
pack-priv final ParseTree	buildErrorParseTree()
pack-priv final ParseTree	buildParseTree()
pack-priv abstract CharSequence	characters() Reads the characters as input.
private void	copyErrorFrom(ParseContext that)
pack-priv final void	enableTrace(final String rootName) Enables parse tree tracing with `rootName` as the name of the root node.
pack-priv final int	errorIndex() The physical index of the current most relevant error, `0` if none.
pack-priv final void	expected(Object what)
pack-priv final void	fail(String message)
private String	getEncountered()
pack-priv final int	getIndex() Returns the current index in the original source.
pack-priv abstract String	getInputName(int pos) Returns the string representation of the current input (character or token).
pack-priv abstract Token	getToken() Returns the current token.
pack-priv final ParseContext.ParserTrace	getTrace()
pack-priv abstract boolean	isEof()
pack-priv final void	missing(Object what)
pack-priv final void	next()
pack-priv final void	next(int n)
pack-priv abstract char	peekChar() Peeks the current character.
pack-priv final void	raise(ParseContext.ErrorType type, Object subject)
pack-priv final ParseErrorDetails	renderError() Only called when rendering the error in `ParserException`.
pack-priv final boolean	repeat(Parser<?> parser, int n)
pack-priv final <T> boolean	repeat(Parser<? extends T> parser, int n, Collection<T> collection)
pack-priv final void	set(int step, int at, Object ret)
pack-priv final void	setAt(int step, int at)
private void	setErrorState(int errorAt, int errorIndex, ParseContext.ErrorType errorType, List<Object> errors)
private void	setErrorState(int errorAt, int errorIndex, ParseContext.ErrorType errorType)
pack-priv final boolean	stillThere(int wasAt, int originalStep)
pack-priv abstract int	toIndex(int pos) Translates the logical position to physical index in the original source.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
pack-priv final void	unexpected(String what)
pack-priv final boolean	withErrorSuppressed(Parser<?> parser) Runs `parser` with error recording suppressed.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

at	back to summary
pack-priv int at The current position of the input. Points to the token array for token level.

currentErrorAt	back to summary
private int currentErrorAt

currentErrorIndex	back to summary
private int currentErrorIndex

currentErrorNode	back to summary
private TreeNode currentErrorNode

currentErrorType	back to summary
private ParseContext.ErrorType currentErrorType

encountered	back to summary
private String encountered

EOF	back to summary
pack-priv static final String EOF

errors	back to summary
private final ArrayList<Object> errors

errorSuppressed	back to summary
private boolean errorSuppressed

locator	back to summary
pack-priv final SourceLocator locator

module	back to summary
pack-priv final String module

overrideErrorType	back to summary
private ParseContext.ErrorType overrideErrorType

result	back to summary
pack-priv Object result The current parse result.

source	back to summary
pack-priv final CharSequence source

step	back to summary
pack-priv int step The current logical step.

trace	back to summary
private ParseContext.ParserTrace trace

Constructor Detail

ParseContext	back to summary
pack-priv ParseContext(CharSequence source, int at, String module, SourceLocator locator)

ParseContext	back to summary
pack-priv ParseContext(CharSequence source, Object ret, int at, String module, SourceLocator locator)

Method Detail

applyAsDelimiter	back to summary
pack-priv final boolean applyAsDelimiter(Parser<?> parser) Runs `parser` with error recording suppressed.

applyNested	back to summary
pack-priv final boolean applyNested(Parser<?> parser, ParseContext nestedState)

applyNewNode	back to summary
pack-priv final boolean applyNewNode(Parser<?> parser, String name) Applies `parser` as a new tree node with `name`, and if fails, reports "expecting $name".

buildErrorParseTree	back to summary
pack-priv final ParseTree buildErrorParseTree()

buildParseTree	back to summary
pack-priv final ParseTree buildParseTree()

characters	back to summary
pack-priv abstract CharSequence characters() Reads the characters as input. Only applicable to character level parsers.

copyErrorFrom	back to summary
private void copyErrorFrom(ParseContext that)

enableTrace	back to summary
pack-priv final void enableTrace(final String rootName) Enables parse tree tracing with `rootName` as the name of the root node.

errorIndex	back to summary
pack-priv final int errorIndex() The physical index of the current most relevant error, `0` if none.

expected	back to summary
pack-priv final void expected(Object what)

fail	back to summary
pack-priv final void fail(String message)

getEncountered	back to summary
private String getEncountered()

getIndex	back to summary
pack-priv final int getIndex() Returns the current index in the original source.

getInputName	back to summary
pack-priv abstract String getInputName(int pos) Returns the string representation of the current input (character or token).

getToken	back to summary
pack-priv abstract Token getToken() Returns the current token. Only applicable to token level parser.

getTrace	back to summary
pack-priv final ParseContext.ParserTrace getTrace()

isEof	back to summary
pack-priv abstract boolean isEof()

missing	back to summary
pack-priv final void missing(Object what)

next	back to summary
pack-priv final void next()

next	back to summary
pack-priv final void next(int n)

peekChar	back to summary
pack-priv abstract char peekChar() Peeks the current character. Only applicable to character level parser.

raise	back to summary
pack-priv final void raise(ParseContext.ErrorType type, Object subject) Annotations @Private

renderError	back to summary
pack-priv final ParseErrorDetails renderError() Only called when rendering the error in `ParserException`.

repeat	back to summary
pack-priv final boolean repeat(Parser<?> parser, int n)

repeat	back to summary
pack-priv final <T> boolean repeat(Parser<? extends T> parser, int n, Collection<T> collection)

set	back to summary
pack-priv final void set(int step, int at, Object ret)

setAt	back to summary
pack-priv final void setAt(int step, int at)

setErrorState	back to summary
private void setErrorState(int errorAt, int errorIndex, ParseContext.ErrorType errorType, List<Object> errors)

setErrorState	back to summary
private void setErrorState(int errorAt, int errorIndex, ParseContext.ErrorType errorType)

stillThere	back to summary
pack-priv final boolean stillThere(int wasAt, int originalStep)

toIndex	back to summary
pack-priv abstract int toIndex(int pos) Translates the logical position to physical index in the original source.

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

unexpected	back to summary
pack-priv final void unexpected(String what)

withErrorSuppressed	back to summary
pack-priv final boolean withErrorSuppressed(Parser<?> parser) Runs `parser` with error recording suppressed.

org.jparsec back to summary

pack-priv final Enum ParseContext.ErrorType

Class Inheritance

extends Enum<ParseContext.ErrorType>

java.lang.Object
java.lang.Enum
org.jparsec.ParseContext.ErrorType

Field Summary

Modifier and Type	Field and Description
public static final ParseContext.ErrorType	DELIMITING When the error is mostly lenient (as a delimiter of repetitions for example).
public static final ParseContext.ErrorType	EXPECTING When `Parser#label()` is called.
public static final ParseContext.ErrorType	FAILURE When `Parsers#fail(String)` is called.
pack-priv final boolean	mergeable
public static final ParseContext.ErrorType	MISSING When any expected input isn't found.
public static final ParseContext.ErrorType	NONE Default value, no error.
public static final ParseContext.ErrorType	UNEXPECTED When `Parser#not()` is called.

Constructor Summary

Access	Constructor and Description
private	ErrorType(boolean mergeable)

Method Summary

Modifier and Type	Method and Description
public static ParseContext.ErrorType	valueOf(String name)
public static ParseContext.ErrorType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DELIMITING	back to summary
public static final ParseContext.ErrorType DELIMITING When the error is mostly lenient (as a delimiter of repetitions for example).

EXPECTING	back to summary
public static final ParseContext.ErrorType EXPECTING When `Parser#label()` is called. Signals that a logical stuff isn't found.

FAILURE	back to summary
public static final ParseContext.ErrorType FAILURE When `Parsers#fail(String)` is called. Signals a serious problem.

mergeable	back to summary
pack-priv final boolean mergeable

MISSING	back to summary
public static final ParseContext.ErrorType MISSING When any expected input isn't found.

NONE	back to summary
public static final ParseContext.ErrorType NONE Default value, no error.

UNEXPECTED	back to summary
public static final ParseContext.ErrorType UNEXPECTED When `Parser#not()` is called. Signals that something isn't expected.

Constructor Detail

ErrorType	back to summary
private ErrorType(boolean mergeable)

Method Detail

valueOf	back to summary
public static ParseContext.ErrorType valueOf(String name)

values	back to summary
public static ParseContext.ErrorType[] values()

org.jparsec back to summary

pack-priv Interface ParseContext.ParserTrace

Allows tracing of parsing progress during error condition, to ease debugging.

Method Summary

Modifier and Type	Method and Description
public TreeNode	getCurrentNode() Returns the current node, that is being parsed (not necessarily finished).
public TreeNode	getLatestChild() Called by branching parsers, to save the current state of tree, before trying parsers that could modify the tree state.
public void	pop() When a parser finishes, the current node is popped so we are back to the parent parser.
public void	push(String name) Upon applying a parser with `Parser#label`, the label name is used to create a new child node under the current node.
public void	setCurrentResult(Object result) Whenever a labeled parser succeeds, it calls this method to set its result in the trace.
public void	setLatestChild(TreeNode node) Called by labeled parser to reset the current child node when the current node failed.
public void	setStateAs(ParseContext.ParserTrace that) Set the enclosing parser's tree state into the nested parser's state.
public void	startFresh(ParseContext context) Called when tokenizer passes on to token-level parser.

Method Detail

getCurrentNode	back to summary
public TreeNode getCurrentNode() Returns the current node, that is being parsed (not necessarily finished).

getLatestChild	back to summary
public TreeNode getLatestChild() Called by branching parsers, to save the current state of tree, before trying parsers that could modify the tree state.

pop	back to summary
public void pop() When a parser finishes, the current node is popped so we are back to the parent parser.

push	back to summary
public void push(String name) Upon applying a parser with `Parser#label`, the label name is used to create a new child node under the current node. The new child node is set to be the current node.

setCurrentResult	back to summary
public void setCurrentResult(Object result) Whenever a labeled parser succeeds, it calls this method to set its result in the trace.

setLatestChild	back to summary
public void setLatestChild(TreeNode node) Called by labeled parser to reset the current child node when the current node failed. Also called by `BestParser` to set the optimum parse tree.

setStateAs	back to summary
public void setStateAs(ParseContext.ParserTrace that) Set the enclosing parser's tree state into the nested parser's state. Called for both nested token-level parser and nested scanner.

startFresh	back to summary
public void startFresh(ParseContext context) Called when tokenizer passes on to token-level parser.

pack-priv abstract Class ParseContext

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum ParseContext.ErrorType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface ParseContext.ParserTrace

Method Summary

Method Detail