eu.cqse.check.framework.shallowparser.languages.base

Class LineBasedStatementRecognizerBase<STATE extends java.lang.Enum<STATE>>

java.lang.Object

eu.cqse.check.framework.shallowparser.framework.RecognizerBase<STATE>

eu.cqse.check.framework.shallowparser.languages.base.LineBasedStatementRecognizerBase<STATE>

Direct Known Subclasses:

PythonSimpleStatementRecognizer

public abstract class LineBasedStatementRecognizerBase<STATE extends java.lang.Enum<STATE>>
extends RecognizerBase<STATE>

Base class for recognizing statements in a language whose statements are primarily line-based. It also assumes that a semicolon may always be used to terminate a statement.

Field Summary

Fields inherited from class eu.cqse.check.framework.shallowparser.framework.RecognizerBase

NO_MATCH, tailRecognizers

Constructor Summary

Constructors

Constructor and Description
LineBasedStatementRecognizerBase() Constructor.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getEntityName(java.util.List<IToken> tokens, int startOffset)
protected java.lang.String	getEntitySubtypeName()
protected EShallowEntityType	getEntityType()
protected abstract STATE	getSubParseState() Returns the state to be used for a sub parse.
protected boolean	isNestedClosingToken(ETokenType token) Check whether the given token is a type of closing token for tokens which might be nested in a statement.
protected int	matchesLocally(ParserState<STATE> parserState, java.util.List<IToken> tokens, int startOffset) Attempts to match the recognizer locally (without respecting tail recognizers).
protected void	registerNestingMatch(ETokenType opening, ETokenType closing) Registers nesting tokens (e.g.
protected abstract boolean	startsNewStatement(IToken token, IToken lastToken) Returns true if the given token starts a new statement.
protected abstract boolean	tokenStartsSubParse(ETokenType tokenType, java.util.List<IToken> tokens, int offset, java.util.Stack<ETokenType> expectedClosing) Returns true if the token signals to start a sub parse (e.g.

Methods inherited from class eu.cqse.check.framework.shallowparser.framework.RecognizerBase

createNode, createNode, createNode, debug, endNode, endNodeWithContinuation, endNodeWithContinuation, endNodeWithName, ensureTopLevel, getRecognizerStringRepresentation, markStart, matches, notPreCondition, optional, optionalSubRecognizer, parseOnce, parseStrictlyUntil, parseUntil, parseUntilOrEof, preCondition, repeated, repeatedAtLeastOnce, repeatedSubRecognizer, sequence, sequenceBefore, skipAny, skipBefore, skipBeforeWithNesting, skipBeforeWithNesting, skipBeforeWithNesting, skipBeforeWithNesting, skipBeforeWithNesting, skipBeforeWithNesting, skipForward, skipNested, skipNested, skipTo, skipToWithNesting, skipToWithNesting, skipToWithNesting, skipToWithNesting, skipWithNesting, skipWithNesting, subRecognizer, subRecognizer, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LineBasedStatementRecognizerBase

public LineBasedStatementRecognizerBase()

Constructor.

Method Detail

registerNestingMatch

protected void registerNestingMatch(ETokenType opening,
                                    ETokenType closing)

Registers nesting tokens (e.g. braces). When the recognizer is going through a statement it will check if the current token is of a type registered with this method.

isNestedClosingToken

protected boolean isNestedClosingToken(ETokenType token)

Check whether the given token is a type of closing token for tokens which might be nested in a statement.

For example `)` would return true in `a = new ArrayList();`.

matchesLocally

protected int matchesLocally(ParserState<STATE> parserState,
                             java.util.List<IToken> tokens,
                             int startOffset)

Attempts to match the recognizer locally (without respecting tail recognizers).

Overrides:

matchesLocally in class RecognizerBase<STATE extends java.lang.Enum<STATE>>

Parameters:

parserState - the current state of the underlying parser.

tokens - the list of tokens.

startOffset - the current offset into the tokens from where to start matching.

Returns:

the new offset (position right behind the match) or RecognizerBase.NO_MATCH if matching was not possible at this position.

getEntityType

protected EShallowEntityType getEntityType()

Returns:

The entity type that is to be created when matching.

getEntitySubtypeName

protected java.lang.String getEntitySubtypeName()

Returns:

The entity subtype name to be used when creating a node.

getEntityName

protected java.lang.String getEntityName(java.util.List<IToken> tokens,
                                         int startOffset)

Returns:

The name used for the created entity node. Default implementation uses the text of the first token (the token at position startOffset).

getSubParseState

protected abstract STATE getSubParseState()

Returns the state to be used for a sub parse.

tokenStartsSubParse

protected abstract boolean tokenStartsSubParse(ETokenType tokenType,
                                               java.util.List<IToken> tokens,
                                               int offset,
                                               java.util.Stack<ETokenType> expectedClosing)

Returns true if the token signals to start a sub parse (e.g. embedded classes, functions, etc.).

Parameters:

tokenType - the type of the current token.

tokens - the entire token stream.

offset - the offset of the current token in the token stream.

expectedClosing - the stack of currently expected closing delimiters

startsNewStatement

protected abstract boolean startsNewStatement(IToken token,
                                              IToken lastToken)

Returns true if the given token starts a new statement.