eu.cqse.check.framework.core

Interface ICheckContext

All Superinterfaces:

ITokenElementContext

All Known Implementing Classes:

TestCheckContext

public interface ICheckContext
extends ITokenElementContext

Context interface for custom checks, that provides custom check related functionality to a custom check. Besides the token element access, this also provides methods for creation of findings and for accessing the results of global pre-computation phases.

Method Summary

Modifier and Type	Method and Description
<T extends IExtractedValue<D>,D extends java.io.Serializable> java.util.function.Function<java.lang.String,java.util.List<T>>	accessPhaseInvertedResult(java.lang.Class<? extends IGlobalExtractionPhase<T,D>> phaseClass) Returns an accessor function to read inverted results of the provided phase.
<T extends IExtractedValue<D>,D extends java.io.Serializable> java.util.function.Function<java.lang.String,java.util.List<T>>	accessPhaseResult(java.lang.Class<? extends IGlobalExtractionPhase<T,D>> phaseClass) Returns an accessor function to read results of the provided phase.
void	createFindingForElement(java.lang.String message) Creates a finding with the given message for the whole analyzed token element.
void	createFindingForLines(java.lang.String message, int startLine, int endLine, ECodeViewOption.ETextViewOption textView) Creates a finding with the given message from the given start line (inclusive) to the given end line (inclusive).
void	createFindingForOffsets(java.lang.String message, int startOffset, int endOffset, ECodeViewOption.ETextViewOption textView) Creates a finding with the given message from the given start offset (inclusive) to the given end offset (inclusive).
void	createFindingForSiblings(java.lang.String message, CheckTextRegionLocation mainLocation, java.util.List<CheckTextRegionLocation> siblingLocations) Creates one finding for the given message and main location.
void	createFindingForSiblingsInCurrentFile(java.lang.String message, java.util.List<OffsetBasedRegion> regions) Creates a finding for each entry in the given List of OffsetBasedRegion with the given message from the given start offsets (inclusive) to the corresponding end offsets (inclusive).
<T extends IExtractedValue<D>,D extends java.io.Serializable> java.util.List<java.lang.String>	listAllPhaseValues(java.lang.Class<? extends IGlobalExtractionPhase<T,D>> phaseClass) Returns all values that have been extracted by the phase.

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

calculateLocalPreprocessedTokens, getAbstractSyntaxTree, getClangTranslationUnitWrapper, getLanguage, getRootEntity, getTextContent, getTokens, getTypeResolution, getUniformPath

Method Detail

createFindingForElement

void createFindingForElement(java.lang.String message)
                      throws CheckException

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

Throws:

CheckException

createFindingForLines

void createFindingForLines(java.lang.String message,
                           int startLine,
                           int endLine,
                           ECodeViewOption.ETextViewOption textView)
                    throws CheckException

Creates a finding with the given message from the given start line (inclusive) to the given end line (inclusive). Provide the ECodeViewOption.ETextViewOption that was used to get the token stream. If textView is ECodeViewOption.ETextViewOption.UNFILTERED_CONTENT and the finding refers to filtered code, then it will be ignored.

Throws:

CheckException

createFindingForSiblingsInCurrentFile

void createFindingForSiblingsInCurrentFile(java.lang.String message,
                                           java.util.List<OffsetBasedRegion> regions)
                                    throws CheckException

Creates a finding for each entry in the given List of OffsetBasedRegion with the given message from the given start offsets (inclusive) to the corresponding end offsets (inclusive). Offsets must be based on filtered content (ECodeViewOption.ETextViewOption.FILTERED_CONTENT).

Throws:

CheckException

createFindingForSiblings

void createFindingForSiblings(java.lang.String message,
                              CheckTextRegionLocation mainLocation,
                              java.util.List<CheckTextRegionLocation> siblingLocations)

Creates one finding for the given message and main location. Adds the given siblingLocations as siblings to the new finding. The list of sibling locations must not contain the main location. All offsets/line numbers are based on ECodeViewOption.ETextViewOption.UNFILTERED_CONTENT.

createFindingForOffsets

void createFindingForOffsets(java.lang.String message,
                             int startOffset,
                             int endOffset,
                             ECodeViewOption.ETextViewOption textView)
                      throws CheckException

Creates a finding with the given message from the given start offset (inclusive) to the given end offset (inclusive). Provide the ECodeViewOption.ETextViewOption that was used to get the token stream. If textView is ECodeViewOption.ETextViewOption.UNFILTERED_CONTENT and the finding refers to filtered code, then it will be ignored.

Throws:

CheckException

accessPhaseResult

<T extends IExtractedValue<D>,D extends java.io.Serializable> java.util.function.Function<java.lang.String,java.util.List<T>> accessPhaseResult(java.lang.Class<? extends IGlobalExtractionPhase<T,D>> phaseClass)

Returns an accessor function to read results of the provided phase. The accessor returns the values for a given uniform path.

accessPhaseInvertedResult

<T extends IExtractedValue<D>,D extends java.io.Serializable> java.util.function.Function<java.lang.String,java.util.List<T>> accessPhaseInvertedResult(java.lang.Class<? extends IGlobalExtractionPhase<T,D>> phaseClass)

Returns an accessor function to read inverted results of the provided phase. The accessor returns the values for a given value.

listAllPhaseValues

<T extends IExtractedValue<D>,D extends java.io.Serializable> java.util.List<java.lang.String> listAllPhaseValues(java.lang.Class<? extends IGlobalExtractionPhase<T,D>> phaseClass)

Returns all values that have been extracted by the phase. This is potentially expensive if a lot of values are expected from a phase. For phases with few expected values, this can be used safely.