com.massa.dsl.lexer

Class AbstractLexerParser

java.lang.Object

com.massa.dsl.lexer.AbstractLexerParser

All Implemented Interfaces:

LexerParser, Serializable

Direct Known Subclasses:

ObjectLexer.ObjectLexerParser

public abstract class AbstractLexerParser
extends Object
implements LexerParser

Base convenience implementation

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	effectiveParseStartMark

Constructor Summary

Constructors

Constructor and Description
AbstractLexerParser(LexerParser parent)

Method Summary

Modifier and Type	Method and Description
protected void	afterParse() Hook called after parsing, including positioning the source at end of parse provided by end matcher if present.
protected void	beforeParse() Hook called before parsing, but after positioning the source at begin of parse provided by start matcher.
boolean	equals(Object obj) Checks LexerMatcher and start mark.
int	getEffectiveParseStartMark()
Grammar	getGrammar()
LexerParser	getParent()
int	getParseEndMark()
int	getParseStartMark()
ParsingContext	getParsingContext()
Object	getResult() Retrieves parsed result.
AdvancedReader	getSource()
protected void	handleAutoCompletes()
protected void	handleOtherInjectionStrategy(InjectableLexerBlock parentBlock, Object parentResult) Default implementation throws Exception.
int	hashCode()
void	injectResult(InjectableLexerBlock parentBlock, Object parentResult) Handles "add" and "set" injection strategies but delegates "other" to handleOtherInjectionStrategy(InjectableLexerBlock, Object)
protected abstract Object	internalParse()
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.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.massa.dsl.lexer.LexerParser

getLexer

Field Detail

effectiveParseStartMark

protected int effectiveParseStartMark

Constructor Detail

AbstractLexerParser

public AbstractLexerParser(LexerParser parent)

Method Detail

resolveStart

public Matcher resolveStart()
                     throws DslException

Description copied from interface: LexerParser

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

Specified by:

resolveStart in interface LexerParser

Throws:

DslException

resolveEnd

public Matcher resolveEnd()
                   throws DslException

Description copied from interface: LexerParser

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

Specified by:

resolveEnd in interface LexerParser

Throws:

DslException

parse

public final void parse()
                 throws DslException,
                        IOException

Description copied from interface: LexerParser

Parses the portion of the source targeted by this lexer.

Specified by:

parse in interface LexerParser

Throws:

DslException

IOException

handleAutoCompletes

protected void handleAutoCompletes()
                            throws DslException,
                                   IOException

Throws:

DslException

IOException

getResult

public Object getResult()

Description copied from interface: LexerParser

Retrieves parsed result.

Specified by:

getResult in interface LexerParser

Returns:

Result.

injectResult

public void injectResult(InjectableLexerBlock parentBlock,
                         Object parentResult)
                  throws UtilsException

Handles "add" and "set" injection strategies but delegates "other" to handleOtherInjectionStrategy(InjectableLexerBlock, Object)

Specified by:

injectResult in interface LexerParser

Throws:

UtilsException

handleOtherInjectionStrategy

protected void handleOtherInjectionStrategy(InjectableLexerBlock parentBlock,
                                            Object parentResult)
                                     throws UtilsException

Default implementation throws Exception.

Throws:

UtilsException

beforeParse

protected void beforeParse()
                    throws DslException,
                           IOException

Hook called before parsing, but after positioning the source at begin of parse provided by start matcher.
If a listener is configured, the sequencing is as follows :

• listener.beginParse
• this.beforeParse()
• listener.beforeParse()

Throws:

DslException

IOException

internalParse

protected abstract Object internalParse()
                                 throws DslException,
                                        IOException

Throws:

DslException

IOException

afterParse

protected void afterParse()
                   throws DslException,
                          IOException

Hook called after parsing, including positioning the source at end of parse provided by end matcher if present.
If a listener is configured, the sequencing is as follows :

• listener.afterParse
• this.afterParse()
• listener.endParse()

Throws:

DslException

IOException

toStart

public void toStart()

Description copied from interface: LexerParser

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.

Specified by:

toStart in interface LexerParser

toStartOfParse

public void toStartOfParse()

Description copied from interface: LexerParser

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.

Specified by:

toStartOfParse in interface LexerParser

toEndOfParse

public void toEndOfParse()

Description copied from interface: LexerParser

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.

Specified by:

toEndOfParse in interface LexerParser

toEnd

public void toEnd()

Description copied from interface: LexerParser

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.

Specified by:

toEnd in interface LexerParser

isExcludedFromHierarchy

public boolean isExcludedFromHierarchy(Matcher matcher)
                                throws DslException

Description copied from interface: LexerParser

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

Specified by:

isExcludedFromHierarchy in interface LexerParser

Returns:

True if should be excluded

Throws:

DslException

getParseStartMark

public int getParseStartMark()

Specified by:

getParseStartMark in interface LexerParser

Returns:

Source mark where parse began

getEffectiveParseStartMark

public int getEffectiveParseStartMark()

Specified by:

getEffectiveParseStartMark in interface LexerParser

Returns:

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

getParseEndMark

public int getParseEndMark()

Specified by:

getParseEndMark in interface LexerParser

Returns:

Source mark where parse ended

getParent

public LexerParser getParent()

Specified by:

getParent in interface LexerParser

Returns:

The parent parser from the current parsing process

isRoot

public boolean isRoot()

Description copied from interface: LexerParser

Is this lexer root ?

Specified by:

isRoot in interface LexerParser

getGrammar

public Grammar getGrammar()

Specified by:

getGrammar in interface LexerParser

Returns:

The grammar defining the source structure

getSource

public AdvancedReader getSource()

Specified by:

getSource in interface LexerParser

Returns:

The source currently being parsed

getParsingContext

public ParsingContext getParsingContext()

Specified by:

getParsingContext in interface LexerParser

Returns:

The current parsing context for this parsing process

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Checks LexerMatcher and start mark.

Overrides:

equals in class Object