com.massa.dsl.lexer

Interface LexerParser

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractLexerParser, ObjectLexer.ObjectLexerParser

public interface LexerParser
extends Serializable

Encapsulates the context for a parsing operation.
An instance of a LexerParser is NOT thread safe and can not be used for several parsing processes. It will be instantiated when needed by the owning Lexer.

Method Summary

Modifier and Type	Method and Description
int	getEffectiveParseStartMark()
Grammar	getGrammar()
Lexer	getLexer()
LexerParser	getParent()
int	getParseEndMark()
int	getParseStartMark()
ParsingContext	getParsingContext()
Object	getResult() Retrieves parsed result.
AdvancedReader	getSource()
void	injectResult(InjectableLexerBlock parentBlock, Object parentResult) Injects parsed result into parent's result.
boolean	isExcludedFromHierarchy(Matcher matcher) Tells if the provided matcher should be excluded from this lexer parser's hierarchy.
boolean	isRoot() Is this lexer root ?
void	parse() Parses the portion of the source targeted by this lexer.
Matcher	resolveEnd() Resolves the end matcher for this parser.
Matcher	resolveStart() Resolves the start matcher for this parser.
void	toEnd() Replaces the source at its state after process ended for this parser.
void	toEndOfParse() Replaces the source at its state after match ended if successful.
void	toStart() Replaces the source at its state before process started for this parser.
void	toStartOfParse() Replaces the source at its state before parse started.

Method Detail

resolveStart

Matcher resolveStart()
              throws DslException

Resolves the start matcher for this parser. The Matcher instance should always be the same for a given parser instance.

Throws:

DslException

resolveEnd

Matcher resolveEnd()
            throws DslException

Resolves the end matcher for this parser. The Matcher instance should always be the same for a given parser instance.

Throws:

DslException

parse

void parse()
    throws DslException,
           IOException

Parses the portion of the source targeted by this lexer.

Throws:

DslException

IOException

getResult

Object getResult()

Retrieves parsed result.

Returns:

Result.

injectResult

void injectResult(InjectableLexerBlock parentBlock,
                  Object parentResult)
           throws UtilsException

Injects parsed result into parent's result.

Throws:

UtilsException

toStart

void toStart()

Replaces the source at its state before process started for this parser.
If nothing has been made or source is already at start position, it has no effect.

toStartOfParse

void toStartOfParse()

Replaces the source at its state before parse started.
If no parse has been made or source is already at parse start position, it has no effect.

toEndOfParse

void toEndOfParse()

Replaces the source at its state after match ended if successful.
If no parse has been made or it failed or source is already at parse end position, it has no effect.

toEnd

void toEnd()

Replaces the source at its state after process ended for this parser.
If nothing has been made or process failed or source is already at end position, it has no effect.

getParseStartMark

int getParseStartMark()

Returns:

Source mark where parse began

getEffectiveParseStartMark

int getEffectiveParseStartMark()

Returns:

Source mark where parse effectively began, i.e. after unuseful characters were skipped.

getParseEndMark

int getParseEndMark()

Returns:

Source mark where parse ended

getLexer

Lexer getLexer()

Returns:

The owning lexer

getParent

LexerParser getParent()

Returns:

The parent parser from the current parsing process

isRoot

boolean isRoot()

Is this lexer root ?

getGrammar

Grammar getGrammar()

Returns:

The grammar defining the source structure

getSource

AdvancedReader getSource()

Returns:

The source currently being parsed

getParsingContext

ParsingContext getParsingContext()

Returns:

The current parsing context for this parsing process

isExcludedFromHierarchy

boolean isExcludedFromHierarchy(Matcher matcher)
                         throws DslException

Tells if the provided matcher should be excluded from this lexer parser's hierarchy.

Returns:

True if should be excluded

Throws:

DslException