eu.cqse.check.framework.checktest

Class TestTokenElementContext

java.lang.Object

eu.cqse.check.framework.checktest.TestTokenElementContext

All Implemented Interfaces:

ITokenElementContext

Direct Known Subclasses:

TestCheckContext

public class TestTokenElementContext
extends java.lang.Object
implements ITokenElementContext

The context implementation used during testing. This context can maintain filtered and unfiltered code separate from each other. However, if the filtered and unfiltered content is different, the line numbers of created findings might not be correct because we cannot convert between filtered and unfiltered offsets like normal teamscale. Therefore, line numbers for reported findings might be wrong in the test context depending on which code (filtered or unfiltered) the custom check computes its finding offsets.

Constructor Summary

Constructors

Constructor and Description
TestTokenElementContext(Resource codeFile, ELanguage language)
TestTokenElementContext(java.lang.String uniformPath, ELanguage language, java.lang.String unfilteredCode, java.util.List<java.util.regex.Pattern> filterPatterns)

Method Summary

Modifier and Type	Method and Description
protected void	accessAst() Template method that is called before accessing the AST.
protected void	accessTypeResolution() Template method called before accessing type resolution.
java.util.List<ShallowEntity>	getAbstractSyntaxTree(ECodeViewOption view) Returns the abstract syntax tree of the analyzed token element as list of shallow entities based on the given view.
ClangTranslationUnitWrapper	getClangTranslationUnitWrapper() Returns a ClangTranslationUnitWrapper containing the initialized JNI interface to Clang for the current file.
protected int	getFilteredOffset(int unfilteredCodeOffset) Returns the offset in filtered code that represents the same character as the given offset in the unfiltered Code.
ELanguage	getLanguage() Returns the language of the analyzed token element.
ShallowEntity	getRootEntity(ECodeViewOption view) Returns the synthetic root entity of the abstract syntax tree based on the given view.
java.lang.String	getTextContent(ECodeViewOption.ETextViewOption view) Returns the text content in the given view.
java.util.List<IToken>	getTokens(ECodeViewOption view) Returns the tokens in the given view.
ITypeResolution	getTypeResolution(ECodeViewOption view) Returns a type resolution, which contains information about known variables and their types.
java.lang.String	getUniformPath() Returns the uniform path of the analyzed token element.
protected boolean	isInFilteredRegion(int unfilteredCodeOffset) Returns whether the given offset in unfiltered code is in a filtered region.

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.cqse.check.framework.core.phase.ITokenElementContext

calculateLocalPreprocessedTokens

Constructor Detail

TestTokenElementContext

public TestTokenElementContext(Resource codeFile,
                               ELanguage language)

TestTokenElementContext

public TestTokenElementContext(java.lang.String uniformPath,
                               ELanguage language,
                               java.lang.String unfilteredCode,
                               java.util.List<java.util.regex.Pattern> filterPatterns)

Method Detail

getLanguage

public ELanguage getLanguage()

Returns the language of the analyzed token element.

Specified by:

getLanguage in interface ITokenElementContext

getUniformPath

public java.lang.String getUniformPath()

Returns the uniform path of the analyzed token element.

Specified by:

getUniformPath in interface ITokenElementContext

accessAst

protected void accessAst()

Template method that is called before accessing the AST.

accessTypeResolution

protected void accessTypeResolution()

Template method called before accessing type resolution.

getFilteredOffset

protected int getFilteredOffset(int unfilteredCodeOffset)

Returns the offset in filtered code that represents the same character as the given offset in the unfiltered Code.

isInFilteredRegion

protected boolean isInFilteredRegion(int unfilteredCodeOffset)

Returns whether the given offset in unfiltered code is in a filtered region.

getTextContent

public java.lang.String getTextContent(ECodeViewOption.ETextViewOption view)

Returns the text content in the given view. For most checks the preferred form of content will be ECodeViewOption.ETextViewOption.FILTERED_CONTENT, as usually no findings shall be generated for filtered code.

Specified by:

getTextContent in interface ITokenElementContext

getTokens

public java.util.List<IToken> getTokens(ECodeViewOption view)

Returns the tokens in the given view. This method can be used, if the executing check requests the ECheckParameter.ABSTRACT_SYNTAX_TREE parameter.

Specified by:

getTokens in interface ITokenElementContext

getRootEntity

public ShallowEntity getRootEntity(ECodeViewOption view)
                            throws CheckException

Returns the synthetic root entity of the abstract syntax tree based on the given view.

This method can be used, if the executing check requests the ECheckParameter.ABSTRACT_SYNTAX_TREE parameter.

Specified by:

getRootEntity in interface ITokenElementContext

Throws:

CheckException

getAbstractSyntaxTree

public java.util.List<ShallowEntity> getAbstractSyntaxTree(ECodeViewOption view)
                                                    throws CheckException

Returns the abstract syntax tree of the analyzed token element as list of shallow entities based on the given view.

This method can be used, if the executing check requests the ECheckParameter.ABSTRACT_SYNTAX_TREE parameter.

Specified by:

getAbstractSyntaxTree in interface ITokenElementContext

Throws:

CheckException

getTypeResolution

public ITypeResolution getTypeResolution(ECodeViewOption view)
                                  throws CheckException

Returns a type resolution, which contains information about known variables and their types. This method can be used, if the executing check request the ECheckParameter.TYPE_RESOLUTION parameter. Based on the given ECodeViewOption.

Specified by:

getTypeResolution in interface ITokenElementContext

Throws:

CheckException

getClangTranslationUnitWrapper

public ClangTranslationUnitWrapper getClangTranslationUnitWrapper()

Description copied from interface: ITokenElementContext

Returns a ClangTranslationUnitWrapper containing the initialized JNI interface to Clang for the current file. To access this, specify the ECheckParameter.CLANG option in the custom check.

Specified by:

getClangTranslationUnitWrapper in interface ITokenElementContext