IParserState Interface

public interface IParserState

IAstNodeBuilder AstNodeBuilder { get; }

Property Value

IAstNodeBuilder:

The IAstNodeBuilder to use for constructing AST node results.

object CustomData { get; set; }

Property Value

System.Object:

Custom data that can be altered during a parsing operation.

IEnumerable<IParseError> ParseErrors { get; }

Property Value

System.Collections.Generic.IEnumerable<IParseError>:

The collection of IParseError objects that will be returned in the IParseData parsing result.

ILLParser Parser { get; }

Property Value

ILLParser:

The ILLParser for which this state is tracking data

ITextSnapshot Snapshot { get; }

Property Value

ITextSnapshot:

The ITextSnapshot used to initiate the parsing operation, if known.

ITokenReader TokenReader { get; }

Property Value

ITokenReader:

The ITokenReader that is used to read tokens during the parsing operation.

IEnumerable<int> UntargetableParseErrorTokenIds { get; set; }

Property Value

System.Collections.Generic.IEnumerable<System.Int32>:

The collection of token IDs that should be avoided when determining where untargeted parse errors will appear.

Remarks

If a parse error is reported without a target token, the parser will normally place the parse error at the next token. If that token is one of the IDs found in this collection, the parse error will appear after the previous token instead. This property should be set to a collection of any IDs for visually-insignificant tokens that can be passed to the parser such as a line feed, line continuation, document end, etc.

void ReportError(IParseError parseError)

Parameter	Type	Description
parseError	IParseError	The IParseError object that contains details about the error.

IParseError ReportError(ParseErrorLevel level, string description)

Parameter	Type	Description
level	ParseErrorLevel	A ParseErrorLevel indicating the error level.
description	System.String	The description of the error, which is displayed in the user interface.

Returns

IParseError:

The IParseError that was reported.

IParseError ReportError(ParseErrorLevel level, string description, IToken token)

Parameter	Type	Description
level	ParseErrorLevel	A ParseErrorLevel indicating the error level.
description	System.String	The description of the error, which is displayed in the user interface.
token	IToken	The IToken to examine for the error range. If not passed, the look-ahead token is used.

Returns

IParseError:

The IParseError that was reported.

IParseError ReportNonTerminalExpectedError(NonTerminal nonTerminal)

Parameter	Type	Description
nonTerminal	NonTerminal	The NonTerminal that was expected.

Returns

IParseError:

The IParseError that was reported.

IParseError ReportNonTerminalExpectedError(NonTerminal nonTerminal, IToken token)

Parameter	Type	Description
nonTerminal	NonTerminal	The NonTerminal that was expected.
token	IToken	The IToken at which the error should be reported.

Returns

IParseError:

The IParseError that was reported.

IParseError ReportNonTerminalExpectedError(NonTerminal nonTerminal, TextPositionRange positionRange)

Parameter	Type	Description
nonTerminal	NonTerminal	The NonTerminal that was expected.
positionRange	TextPositionRange	The TextPositionRange over which the error should be reported.

Returns

IParseError:

The IParseError that was reported.

IParseError ReportTerminalExpectedError(Terminal terminal)

Parameter	Type	Description
terminal	Terminal	The Terminal that was expected.

Returns

IParseError:

The IParseError that was reported.

IParseError ReportTerminalExpectedError(Terminal terminal, IToken token)

Parameter	Type	Description
terminal	Terminal	The Terminal that was expected.
token	IToken	The IToken at which the error should be reported.

Returns

IParseError:

The IParseError that was reported.

IParseError ReportTerminalExpectedError(Terminal terminal, TextPositionRange positionRange)

Parameter	Type	Description
terminal	Terminal	The Terminal that was expected.
positionRange	TextPositionRange	The TextPositionRange over which the error should be reported.

Returns

IParseError:

The IParseError that was reported.