com.massa.dsl.matcher

Class AbstractMatcher

java.lang.Object

com.massa.dsl.matcher.AbstractMatcher

All Implemented Interfaces:

Matcher, Serializable

Direct Known Subclasses:

AbstractCombineLexerMatcher.AbstractCombineMatcher, AbstractGenericMatcher

public abstract class AbstractMatcher
extends Object
implements Matcher

Abstract implementation handling source positions and return to start or end.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	effectiveStartMark
protected LexerParser	parser

Constructor Summary

Constructors

Constructor and Description
AbstractMatcher(LexerParser parser)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Checks LexerMatcher and start mark.
boolean	equivalent(Matcher obj) Equality without start mark.
List<ParsingContext.AutoCompleteResult>	getAutoCompleteOptions(MatchingPhase phase) Retrieves main autoComplete options from lexer config, if any.
protected abstract List<ParsingContext.AutoCompleteResult>	getAutoCompleteSecondaryOptions(MatchingPhase phase)
int	getEffectiveStartMark()
int	getEndMark()
Pattern	getFollowingCharPattern()
Grammar	getGrammar()
LexerParser	getLexerParser()
String	getMatchedText() Retrieves text between start of match and end of match.
ParsingContext	getParsingContext()
Pattern	getPreviousCharPattern()
AdvancedReader	getSource()
int	getStartMark()
Integer	getWeight()
protected List<ParsingContext.AutoCompleteResult>	handleSecondaryOptions(MatchingPhase phase, AutoCompleteConfiguration lexerAc, AutoCompleteConfiguration matcherAc, List<ParsingContext.AutoCompleteResult> autoCompleteSecondaryOptions) Updates autoComplete groups of the secondary options with the matcher config, of if none with the lexer config.
int	hashCode()
protected abstract int	internalMatch(MatchingPhase phase, boolean unread) Performs specific part of the match.
boolean	isExcludedFromHierarchy(Matcher matcher) Tells if the provided matcher should be excluded from this matcher's lexer's 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) Tells if this match pattern matches the next characters of the source.
void	toBeginParse() If isSkipMatchText is true, goes to end of match.
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()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.massa.dsl.matcher.Matcher

getFollowingCharPatternMatchResult, getLexerMatcher, getPreviousCharPatternMatchResult, injectResult, isAutoCompletePossible

Field Detail

parser

protected final LexerParser parser

effectiveStartMark

protected int effectiveStartMark

Constructor Detail

AbstractMatcher

public AbstractMatcher(LexerParser parser)

Method Detail

match

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

Description copied from interface: Matcher

Tells if this match pattern matches the next characters of the source.
Returns the match weight, which typically consists in returning the number of useful matching character.
If match already performed once, does nothing and returns the previously computed weight.

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

getAutoCompleteOptions

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

Retrieves main autoComplete options from lexer config, if any. Then delegates secondary options retrieval if enabled.

Specified by:

getAutoCompleteOptions in interface Matcher

Parameters:

phase - Phase when the matching is performed.

Returns:

AutoComplete options

Throws:

DslException

IOException

handleSecondaryOptions

protected List<ParsingContext.AutoCompleteResult> handleSecondaryOptions(MatchingPhase phase,
                                                                         AutoCompleteConfiguration lexerAc,
                                                                         AutoCompleteConfiguration matcherAc,
                                                                         List<ParsingContext.AutoCompleteResult> autoCompleteSecondaryOptions)

Updates autoComplete groups of the secondary options with the matcher config, of if none with the lexer config.

Parameters:

phase -

lexerAc -

matcherAc -

autoCompleteSecondaryOptions -

Returns:

Same list as provided (for the default implem)

getAutoCompleteSecondaryOptions

protected abstract List<ParsingContext.AutoCompleteResult> getAutoCompleteSecondaryOptions(MatchingPhase phase)
                                                                                    throws IOException,
                                                                                           DslException

Throws:

IOException

DslException

internalMatch

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

Performs specific part of the match.

Parameters:

phase - Phase is already handled by main match method but is provided as information. It might not be used in general.

unread - Flag is already handled by main match method but is provided as information. It might not be used in general.

Returns:

weight

Throws:

IOException

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()

If isSkipMatchText is true, goes to end of match. Otherwise goes to begin of match.

Specified by:

toBeginParse in interface Matcher

getLexerParser

public LexerParser getLexerParser()

Specified by:

getLexerParser in interface Matcher

Returns:

The owning lexer parser

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

getParsingContext

public ParsingContext getParsingContext()

Specified by:

getParsingContext in interface Matcher

Returns:

The current parsing context for this parsing process

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.

getStartMark

public int getStartMark()

Specified by:

getStartMark in interface Matcher

Returns:

Input source mark positionned at matching process start.

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.

getEndMark

public int getEndMark()

Specified by:

getEndMark in interface Matcher

Returns:

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

toString

public String toString()

Overrides:

toString in class Object

isExcludedFromHierarchy

public boolean isExcludedFromHierarchy(Matcher matcher)
                                throws DslException

Tells if the provided matcher should be excluded from this matcher's lexer's 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

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

equivalent

public boolean equivalent(Matcher obj)

Equality without start mark.

Specified by:

equivalent in interface Matcher

Returns:

true if equivalent