com.massa.dsl.matcher

Class AbstractMatcherWrapper

java.lang.Object

com.massa.dsl.matcher.AbstractMatcherWrapper

All Implemented Interfaces:

Matcher, Serializable

public abstract class AbstractMatcherWrapper
extends Object
implements Matcher

Allows to wrap a Matcher to change some of its behavior. Generally used with AbstractLexerMatcherWrapper, so the getLexerMatcher() should be overriden to avoid unexpected behaviors.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractMatcherWrapper()
AbstractMatcherWrapper(Matcher wrapped) Wraps the provided matcher

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
boolean	equivalent(Matcher obj) Equality without start mark.
List<ParsingContext.AutoCompleteResult>	getAutoCompleteOptions(MatchingPhase phase) Computes autoComplete options from current partial matches, if any.
int	getEffectiveStartMark()
int	getEndMark()
Pattern	getFollowingCharPattern()
CharPatternMatchResult	getFollowingCharPatternMatchResult()
Grammar	getGrammar()
LexerMatcher	getLexerMatcher()
LexerParser	getLexerParser()
String	getMatchedText() Retrieves text between start of match and end of match.
ParsingContext	getParsingContext()
Pattern	getPreviousCharPattern()
CharPatternMatchResult	getPreviousCharPatternMatchResult()
AdvancedReader	getSource()
int	getStartMark()
Integer	getWeight()
Matcher	getWrapped()
int	hashCode()
void	injectResult(Object target) If the matcher (or one or several of the matchers in the chain) generates an Object, this allows to inject it (or them) into the result.
boolean	isAutoCompletePossible() Considering match result, tells if autoComplete is possible or not (i.e. if options should be searched or not).
boolean	isExcludedFromHierarchy(Matcher matcher) Tells if provided sub matcher should be excluded from matching hierarchy.
boolean	isExclusionHierarchyBreaker() Tells if this matcher should break search for exclusion in older hierarchy.
Boolean	isMatched()
boolean	isSkipMatchText()
int	match(MatchingPhase phase, boolean unread) Can't be overriden in order to force update of matching hierarchy.
void	toBeginParse() Replaces the source at its state to where the parsing process should begin.
void	toEndOfMatch() Replaces the source at its state after match ended if successful.
void	toStartOfMatch() Replaces the source at its state before match started.
String	toString()
protected int	wrappedMatch(MatchingPhase phase, boolean unread) This method can be overridden if necessary, instead of match(MatchingPhase, boolean).

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMatcherWrapper

public AbstractMatcherWrapper()

AbstractMatcherWrapper

public AbstractMatcherWrapper(Matcher wrapped)

Wraps the provided matcher

Parameters:

wrapped - Matcher to wrap

Method Detail

match

public final int match(MatchingPhase phase,
                       boolean unread)
                throws IOException,
                       DslException

Can't be overriden in order to force update of matching hierarchy.

Specified by:

match in interface Matcher

Parameters:

phase - Phase when the matching is performed.

unread - Tells if the source should be replaced at start after the match operation or not. If match fails, this parameter is ignored and source is unread.

Returns:

< 0 if not matched, the match weight otherwise.

Throws:

IOException

DslException

See Also:

wrappedMatch(MatchingPhase, boolean)

wrappedMatch

protected int wrappedMatch(MatchingPhase phase,
                           boolean unread)
                    throws IOException,
                           DslException

This method can be overridden if necessary, instead of match(MatchingPhase, boolean).

Throws:

IOException

DslException

getAutoCompleteOptions

public List<ParsingContext.AutoCompleteResult> getAutoCompleteOptions(MatchingPhase phase)
                                                               throws IOException,
                                                                      DslException

Description copied from interface: Matcher

Computes autoComplete options from current partial matches, if any.
This method can't be invoked if match has not been done.

Specified by:

getAutoCompleteOptions in interface Matcher

Parameters:

phase - Phase when the matching is performed.

Returns:

AutoComplete options

Throws:

IOException

DslException

isAutoCompletePossible

public boolean isAutoCompletePossible()
                               throws DslException

Description copied from interface: Matcher

Considering match result, tells if autoComplete is possible or not (i.e. if options should be searched or not).

Specified by:

isAutoCompletePossible in interface Matcher

Returns:

true if possible

Throws:

DslException

toStartOfMatch

public void toStartOfMatch()

Description copied from interface: Matcher

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

Specified by:

toStartOfMatch in interface Matcher

toEndOfMatch

public void toEndOfMatch()

Description copied from interface: Matcher

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

Specified by:

toEndOfMatch in interface Matcher

getMatchedText

public String getMatchedText()
                      throws IOException

Description copied from interface: Matcher

Retrieves text between start of match and end of match.

Specified by:

getMatchedText in interface Matcher

Throws:

IOException

toBeginParse

public void toBeginParse()

Description copied from interface: Matcher

Replaces the source at its state to where the parsing process should begin.
This position is in general at end of match, or at begin. But it could be anywhere in the matched part in theory.
If no match has been made or it failed or source is already at end position, it has no effect.

Specified by:

toBeginParse in interface Matcher

getWeight

public Integer getWeight()

Specified by:

getWeight in interface Matcher

Returns:

weight computed by match operation. If not performed, returns null.

isMatched

public Boolean isMatched()

Specified by:

isMatched in interface Matcher

Returns:

true if match OK, false if match KO, null if match not performed.

getPreviousCharPatternMatchResult

public CharPatternMatchResult getPreviousCharPatternMatchResult()

Specified by:

getPreviousCharPatternMatchResult in interface Matcher

Returns:

Result of match of PreviousCharPattern on the previous character, null if match not performed.

getFollowingCharPatternMatchResult

public CharPatternMatchResult getFollowingCharPatternMatchResult()

Specified by:

getFollowingCharPatternMatchResult in interface Matcher

Returns:

Result of match of FollowingCharPattern on the next character, null if match not performed.

injectResult

public void injectResult(Object target)
                  throws DslException

Description copied from interface: Matcher

If the matcher (or one or several of the matchers in the chain) generates an Object, this allows to inject it (or them) into the result.
This method should be called by the concerned lexers.

Specified by:

injectResult in interface Matcher

Throws:

DslException

getLexerMatcher

public LexerMatcher getLexerMatcher()

Specified by:

getLexerMatcher in interface Matcher

Returns:

The owning lexer matcher

getLexerParser

public LexerParser getLexerParser()

Specified by:

getLexerParser in interface Matcher

Returns:

The owning lexer parser

getParsingContext

public ParsingContext getParsingContext()

Specified by:

getParsingContext in interface Matcher

Returns:

The current parsing context for this parsing process

getGrammar

public Grammar getGrammar()

Specified by:

getGrammar in interface Matcher

Returns:

The grammar defining the source structure

getSource

public AdvancedReader getSource()

Specified by:

getSource in interface Matcher

Returns:

The source currently being parsed

getEffectiveStartMark

public int getEffectiveStartMark()

Specified by:

getEffectiveStartMark in interface Matcher

Returns:

Input source mark positionned at matching process start, just after unuseful characters were skipped.

getStartMark

public int getStartMark()

Specified by:

getStartMark in interface Matcher

Returns:

Input source mark positionned at matching process start.

getEndMark

public int getEndMark()

Specified by:

getEndMark in interface Matcher

Returns:

Input source mark positionned at matching process end, if match is successful.

isExcludedFromHierarchy

public boolean isExcludedFromHierarchy(Matcher matcher)
                                throws DslException

Description copied from interface: Matcher

Tells if provided sub matcher should be excluded from matching hierarchy.

Specified by:

isExcludedFromHierarchy in interface Matcher

Returns:

true if should be excluded

Throws:

DslException

getPreviousCharPattern

public Pattern getPreviousCharPattern()

Specified by:

getPreviousCharPattern in interface Matcher

Returns:

Regex Pattern to which the previous character must match, or null if unspecified.
This method can use the LexerMatcher equivalent method as a default, or recompute the result depending on the current matching situation.
Please note that the provided regex must apply to a single character, otherwise it will never match.

getFollowingCharPattern

public Pattern getFollowingCharPattern()

Specified by:

getFollowingCharPattern in interface Matcher

Returns:

Regex Pattern to which the following character must match, or null if unspecified.
This method can use the LexerMatcher equivalent method as a default, or recompute the result depending on the current matching situation. Please note that the provided regex must apply to a single character, otherwise it will never match.

isSkipMatchText

public boolean isSkipMatchText()

Specified by:

isSkipMatchText in interface Matcher

Returns:

true if matched text must be skipped or unread to be provided to the parser.
This method can use the LexerMatcher equivalent method as a default, or recompute the result depending on the current matching situation.

isExclusionHierarchyBreaker

public boolean isExclusionHierarchyBreaker()

Description copied from interface: Matcher

Tells if this matcher should break search for exclusion in older hierarchy.
Typically, the AndLexerMatcher is concerned.

Specified by:

isExclusionHierarchyBreaker in interface Matcher

toString

public String toString()

Overrides:

toString in class Object

getWrapped

public Matcher getWrapped()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equivalent

public boolean equivalent(Matcher obj)

Equality without start mark.

Specified by:

equivalent in interface Matcher

Returns:

true if equivalent