eu.cqse.check.base

Class HardCodedLiteralsCheckBase

java.lang.Object

eu.cqse.check.framework.core.CheckImplementationBase

eu.cqse.check.base.HardCodedLiteralsCheckBase

public abstract class HardCodedLiteralsCheckBase
extends CheckImplementationBase

Base class for checks on hard-coded character literals. Subclasses check literals which match getLiteralRegex() (if specified) and which occur in context with an identifier (e.g. assignment, comparison). The identifier is checked with isMatchingIdentifier(IToken). findAllMatchingLiteral() can be overwritten if all literals matching getLiteralRegex() should produce a finding, regardless of the context where these occur. The checks works on pre-processed tokens, thus implementing checks must have the parameter ECheckParameter.ABSTRACT_SYNTAX_TREE enabled.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<IToken>	preprocessedTokens Tokens of the current element, but without comments

Fields inherited from class eu.cqse.check.framework.core.CheckImplementationBase

context

Constructor Summary

Constructors

Constructor and Description
HardCodedLiteralsCheckBase()

Method Summary

Modifier and Type	Method and Description
void	execute() Executes the custom check with the given context.
protected boolean	findAllMatchingLiteral() Indicates if any literal matching getLiteralRegex() should be reported.
protected abstract java.lang.String	getFindingsMessageText()
protected abstract java.lang.String	getLiteralRegex() Gets the regular expression against which literals must match.
protected abstract boolean	isMatchingIdentifier(IToken identifier) Checks if the given identifier matches
protected boolean	isMatchingLiteral(IToken literal)
protected java.util.Optional<IToken>	lookupIdentifierIfInCaseWhen(IToken literal) ABAP Specific function Performs a lookup for the identifier if the given literal occurs as an WHEN option inside a CASE/WHEN structure.
protected java.util.Optional<IToken>	lookupIdentifierIfInDefinition(IToken literal) ABAP Specific function Performs a lookup for identifier when a literal is assigned with the VALUE addition.
protected java.util.Optional<IToken>	lookupIdentifierIfInNewStatement(IToken literal) CLike Specific function Performs a lookup for the identifier if the given literal occurs as in a NEW statement.
protected java.util.Optional<IToken>	lookupIdentifierIfInOperation(IToken literal, boolean leftHandLookup) Performs a lookup for the identifier, if the given literal is stated within an operation where on the other side of the operator an identifier is stated
protected java.util.Optional<IToken>	lookupIdentifierIfInProperty(IToken literal) C# Specific function Performs a lookup for the identifier if the given literal occurs as an PROPERTY.

Methods inherited from class eu.cqse.check.framework.core.CheckImplementationBase

createFinding, createFinding, createFinding, createFinding, createFinding, createFinding, createFinding, createFindingForSiblingEntities, createFindingForSiblings, createFindingOnFirstLine, createFindingOnUnfilteredCode, createFindingOnUnfilteredCode, createFindingOnUnfilteredCode, createInstance, createSelectionPattern, getCodeViewOption, initialize, isCpp, select, select, selectUnfilteredPreProcessed, setContext

Methods inherited from class java.lang.Object

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

Field Detail

preprocessedTokens

protected java.util.List<IToken> preprocessedTokens

Tokens of the current element, but without comments

Constructor Detail

HardCodedLiteralsCheckBase

public HardCodedLiteralsCheckBase()

Method Detail

execute

public void execute()
             throws CheckException

Executes the custom check with the given context.

Specified by:

execute in class CheckImplementationBase

Throws:

CheckException

isMatchingLiteral

protected boolean isMatchingLiteral(IToken literal)

Returns:

true if the literal matches and should be checked

findAllMatchingLiteral

protected boolean findAllMatchingLiteral()

Indicates if any literal matching getLiteralRegex() should be reported. Default implementation is false.

lookupIdentifierIfInOperation

protected java.util.Optional<IToken> lookupIdentifierIfInOperation(IToken literal,
                                                                   boolean leftHandLookup)

Performs a lookup for the identifier, if the given literal is stated within an operation where on the other side of the operator an identifier is stated

Parameters:

leftHandLookup - determines if identifier should be search on the left side, otherwise it is expected on the right side of the operator.

Returns:

An Optional holding the IToken of the identifier, empty optional if no identifier found.

lookupIdentifierIfInCaseWhen

protected java.util.Optional<IToken> lookupIdentifierIfInCaseWhen(IToken literal)

ABAP Specific function Performs a lookup for the identifier if the given literal occurs as an WHEN option inside a CASE/WHEN structure.

Returns:

An Optional holding the IToken of the identifier which controls the CASE/WHEN structure, empty optional if no identifier found.

lookupIdentifierIfInDefinition

protected java.util.Optional<IToken> lookupIdentifierIfInDefinition(IToken literal)

ABAP Specific function Performs a lookup for identifier when a literal is assigned with the VALUE addition.

Returns:

An Optional holding the IToken of the identifier, empty optional if no identifier found.

lookupIdentifierIfInProperty

protected java.util.Optional<IToken> lookupIdentifierIfInProperty(IToken literal)

C# Specific function Performs a lookup for the identifier if the given literal occurs as an PROPERTY.

Returns:

An Optional holding the IToken of the identifier of the property, empty optional if no identifier found.

lookupIdentifierIfInNewStatement

protected java.util.Optional<IToken> lookupIdentifierIfInNewStatement(IToken literal)

CLike Specific function Performs a lookup for the identifier if the given literal occurs as in a NEW statement.

Returns:

An Optional holding the IToken of the identifier of the new statement, empty optional if no identifier found.

getLiteralRegex

protected abstract java.lang.String getLiteralRegex()

Gets the regular expression against which literals must match. If null any literal matches.

isMatchingIdentifier

protected abstract boolean isMatchingIdentifier(IToken identifier)

Checks if the given identifier matches

getFindingsMessageText

protected abstract java.lang.String getFindingsMessageText()

Returns:

text for findings message