eu.cqse.check.framework.core.phase

Interface ITokenElementContext

All Known Subinterfaces:

ICheckContext

All Known Implementing Classes:

TestCheckContext, TestTokenElementContext

public interface ITokenElementContext

Context interface for accessing different views of a token element.

Method Summary

Modifier and Type	Method and Description
default java.util.List<IToken>	calculateLocalPreprocessedTokens(java.util.List<IToken> tokens) Calculates the pre-processed tokens (no global include 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.
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.

Method Detail

getLanguage

ELanguage getLanguage()

Returns the language of the analyzed token element.

getUniformPath

java.lang.String getUniformPath()

Returns the uniform path of the analyzed token element.

getTokens

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

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

Throws:

CheckException

getTextContent

java.lang.String getTextContent(ECodeViewOption.ETextViewOption view)
                         throws CheckException

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.

Throws:

CheckException

getRootEntity

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.

Throws:

CheckException

getAbstractSyntaxTree

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.

Throws:

CheckException

getTypeResolution

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.

Throws:

CheckException

calculateLocalPreprocessedTokens

default java.util.List<IToken> calculateLocalPreprocessedTokens(java.util.List<IToken> tokens)

Calculates the pre-processed tokens (no global include resolution).

getClangTranslationUnitWrapper

ClangTranslationUnitWrapper getClangTranslationUnitWrapper()

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.