eu.cqse.check.framework.core

Class CheckImplementationBase

java.lang.Object

eu.cqse.check.framework.core.CheckImplementationBase

Direct Known Subclasses:

CommentCheckBase, EntityCheckBase, HardCodedLiteralsCheckBase, TopLevelTypeCheckBase

public abstract class CheckImplementationBase
extends java.lang.Object

Abstract base class for custom checks. A check is instantiated () and initialized with a check context when its executing processor is set up (CheckProcessor.initializeChecks()) based on CheckInfo Objects. It is destroyed, when the executing processor has finished execution.

Field Summary

Fields

Modifier and Type	Field and Description
protected ICheckContext	context The check context that is used to access custom check specific functionality.

Constructor Summary

Constructors

Constructor and Description
CheckImplementationBase()

Method Summary

Modifier and Type	Method and Description
protected void	createFinding(java.lang.String message) Creates a finding with the given message for the whole analyzed token element.
protected void	createFinding(java.lang.String message, int line) Creates a finding with the given message at the given line.
protected void	createFinding(java.lang.String message, int startLine, int endLine) Creates a finding with the given message from the given start line (inclusive) to the given end line (inclusive).
protected void	createFinding(java.lang.String message, IToken token) Creates a finding with the given message at the given token.
protected void	createFinding(java.lang.String message, IToken startToken, IToken endToken) Creates a finding with the given message beginning from startToken to endToken.
protected void	createFinding(java.lang.String message, java.util.List<IToken> tokens) Creates a finding with the given message beginning from first token to last token.
protected void	createFinding(java.lang.String message, ShallowEntity entity) Creates a finding with the given message for the given entity.
protected void	createFindingForSiblingEntities(java.lang.String message, java.util.List<ShallowEntity> associatedEntities) Creates findings for entities which are associated in some way.
protected void	createFindingForSiblings(java.lang.String message, PairList<IToken,IToken> startAndEndTokens) Creates findings with the given message for the given pair lists of start- and end tokens.
protected void	createFindingOnFirstLine(java.lang.String message, ShallowEntity entity) Creates a finding with the given message on the first line of the given entity.
protected void	createFindingOnUnfilteredCode(java.lang.String message, IToken token) Creates a finding with the given message at the given token.
protected void	createFindingOnUnfilteredCode(java.lang.String message, IToken startToken, IToken endToken) Creates a finding with the given message beginning from startToken to endToken.
protected void	createFindingOnUnfilteredCode(java.lang.String message, ShallowEntity entity) Creates a finding with the given message for the given entity.
static CheckImplementationBase	createInstance(java.lang.Class<?> checkClass) Creates an instance of the given check class.
protected static java.lang.String	createSelectionPattern(EShallowEntityType entityType, java.lang.String... subtypeAlternatives) Creates a xpath-expression to select entities with the given type and the optional subtype alternatives eg.
abstract void	execute() Executes the custom check with the given context.
protected ECodeViewOption	getCodeViewOption() Can be used to specifiy the code representation.
void	initialize() Initializes the custom check.
boolean	isCpp() Determines if the the check is currently processing source code that is written in C++ based on the file extension and the C++ specific tokens.
static java.util.List<ShallowEntity>	select(ShallowEntity entity, java.lang.String xPathExpression) Selects all shallow entities starting from the given entity, that match the given xpath-expression.
protected java.util.List<ShallowEntity>	select(java.lang.String xPathExpression) Selects all shallow entities from the abstract syntax tree, that match the given xpath-expression.
protected java.util.List<ShallowEntity>	selectUnfilteredPreProcessed(java.lang.String xPathExpression) Selects all shallow entities from the abstract syntax tree, that match the given xpath-expression.
void	setContext(ICheckContext context) Sets the context.

Methods inherited from class java.lang.Object

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

Field Detail

context

protected ICheckContext context

The check context that is used to access custom check specific functionality.

Constructor Detail

CheckImplementationBase

public CheckImplementationBase()

Method Detail

setContext

public void setContext(ICheckContext context)

Sets the context. Must not be called if the context has already been set.

initialize

public void initialize()
                throws CheckException

Initializes the custom check. This is called after the parameters have been set, but before the check is executed and before the context is set. This method is called only once for a batch of files that need to be analyzed. Since the context is file-specific it can't be accessed here. This method is intended for preprocessing or parsing of the parameters.

Throws:

CheckException - can be thrown by subclasses

execute

public abstract void execute()
                      throws CheckException

Executes the custom check with the given context.

Throws:

CheckException

getCodeViewOption

protected ECodeViewOption getCodeViewOption()

Can be used to specifiy the code representation. See ECodeViewOption for details, the default is ECodeViewOption.FILTERED. See the Teamscale Code Processing Pipeline

select

protected java.util.List<ShallowEntity> select(java.lang.String xPathExpression)
                                        throws CheckException

Selects all shallow entities from the abstract syntax tree, that match the given xpath-expression. Set CodeViewOption via overwriting getCodeViewOption(). This method can be used, if the executing check requests the ECheckParameter.ABSTRACT_SYNTAX_TREE parameter.

Throws:

CheckException

selectUnfilteredPreProcessed

protected java.util.List<ShallowEntity> selectUnfilteredPreProcessed(java.lang.String xPathExpression)
                                                              throws CheckException

Selects all shallow entities from the abstract syntax tree, that match the given xpath-expression. Code representation is ECodeViewOption.UNFILTERED_PREPROCESSED.

Throws:

CheckException

createSelectionPattern

protected static java.lang.String createSelectionPattern(EShallowEntityType entityType,
                                                         java.lang.String... subtypeAlternatives)

Creates a xpath-expression to select entities with the given type and the optional subtype alternatives eg. "//METHOD[subtype('function') | subtype('function declaration')]".

select

public static java.util.List<ShallowEntity> select(ShallowEntity entity,
                                                   java.lang.String xPathExpression)
                                            throws CheckException

Selects all shallow entities starting from the given entity, that match the given xpath-expression. This method is still selecting entities from the whole AST as long as the xPath expression does not limit the selection to a special axis. For more information have a look at http://www.w3schools.com/xsl/xpath_syntax.asp

Throws:

CheckException

createFinding

protected void createFinding(java.lang.String message)
                      throws CheckException

Creates a finding with the given message for the whole analyzed token element.

Throws:

CheckException

createFinding

protected void createFinding(java.lang.String message,
                             IToken token)
                      throws CheckException

Creates a finding with the given message at the given token. Use this method, if the token is determined from ICheckContext#getTextContent() or another method that is based on filtered content.

Throws:

CheckException

createFinding

protected void createFinding(java.lang.String message,
                             IToken startToken,
                             IToken endToken)
                      throws CheckException

Creates a finding with the given message beginning from startToken to endToken. Use this method, if the tokens are determined from ICheckContext#getTextContent() or another method that is based on filtered content.

Throws:

CheckException

createFinding

protected void createFinding(java.lang.String message,
                             java.util.List<IToken> tokens)
                      throws CheckException

Creates a finding with the given message beginning from first token to last token. Use this method, if the tokens are determined from ICheckContext#getTextContent() or another method that is based on filtered content.

Throws:

CheckException

createFindingOnUnfilteredCode

protected void createFindingOnUnfilteredCode(java.lang.String message,
                                             IToken startToken,
                                             IToken endToken)
                                      throws CheckException

Creates a finding with the given message beginning from startToken to endToken. Use this method, if the tokens are determined from ICheckContext#getUnfilteredTextContent() or another method that is based on unfiltered content.

Throws:

CheckException

createFinding

protected void createFinding(java.lang.String message,
                             ShallowEntity entity)
                      throws CheckException

Creates a finding with the given message for the given entity. Use this method, if the shallow entity is determined from ICheckContext#getTextContent() or another method that is based on filtered content.

Throws:

CheckException

createFindingOnFirstLine

protected void createFindingOnFirstLine(java.lang.String message,
                                        ShallowEntity entity)
                                 throws CheckException

Creates a finding with the given message on the first line of the given entity. Use this method, if the shallow entity is determined from ICheckContext#getTextContent() or another method that is based on filtered content.

Throws:

CheckException

createFindingOnUnfilteredCode

protected void createFindingOnUnfilteredCode(java.lang.String message,
                                             IToken token)
                                      throws CheckException

Creates a finding with the given message at the given token. Use this method, if the token is determined from ICheckContext#getUnfilteredTextContent() or another method that is based on unfiltered content.

Throws:

CheckException

createFindingOnUnfilteredCode

protected void createFindingOnUnfilteredCode(java.lang.String message,
                                             ShallowEntity entity)
                                      throws CheckException

Creates a finding with the given message for the given entity. Use this method, if the shallow entity is determined from ICheckContext#getUnfilteredTextContent() or another method that is based on unfiltered content.

Throws:

CheckException

createFinding

protected void createFinding(java.lang.String message,
                             int line)
                      throws CheckException

Creates a finding with the given message at the given line. Use this method, if the line is determined from ICheckContext#getTextContent() or another method that is based on filtered content.

Throws:

CheckException

createFindingForSiblings

protected void createFindingForSiblings(java.lang.String message,
                                        PairList<IToken,IToken> startAndEndTokens)
                                 throws CheckException

Creates findings with the given message for the given pair lists of start- and end tokens.

Parameters:

message - the message describing the findings

startAndEndTokens - A list of corresponding pairs of start and end tokens.

Throws:

CheckException

createFindingForSiblingEntities

protected void createFindingForSiblingEntities(java.lang.String message,
                                               java.util.List<ShallowEntity> associatedEntities)
                                        throws CheckException

Creates findings for entities which are associated in some way. The entities must stem from the same file.

Throws:

CheckException

createFinding

protected void createFinding(java.lang.String message,
                             int startLine,
                             int endLine)
                      throws CheckException

Creates a finding with the given message from the given start line (inclusive) to the given end line (inclusive). Use this method, if the lines are determined from ICheckContext#getTextContent() or another method that is based on filtered content.

Throws:

CheckException

createInstance

public static CheckImplementationBase createInstance(java.lang.Class<?> checkClass)
                                              throws CheckException

Creates an instance of the given check class.

Throws:

CheckException

isCpp

public boolean isCpp()
              throws CheckException

Determines if the the check is currently processing source code that is written in C++ based on the file extension and the C++ specific tokens. Especially distinguishes C++ from C source code.

Returns:

true if the context is C++, false else

Throws:

CheckException