eu.cqse.check.util.clang.visitors

Class FindingCollectingClangCursorVisitorBase

java.lang.Object

eu.cqse.check.util.clang.visitors.FindingCollectingClangCursorVisitorBase

All Implemented Interfaces:

eu.cqse.clang.IClangCursorVisitor

public abstract class FindingCollectingClangCursorVisitorBase
extends java.lang.Object
implements eu.cqse.clang.IClangCursorVisitor

Base class for IClangCursorVisitors which collect findings while visiting CXCursors in Clang syntax tree.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	fileText The ECodeViewOption.UNFILTERED source file text.
protected eu.cqse.clang.SWIGTYPE_p_CXTranslationUnitImpl	translationUnit The main Clang translation unit for the source file.
protected java.lang.String	uniformPath The uniform path of the source file.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FindingCollectingClangCursorVisitorBase(eu.cqse.clang.SWIGTYPE_p_CXTranslationUnitImpl translationUnit, java.lang.String uniformPath, java.lang.String fileText)

Method Summary

Modifier and Type	Method and Description
java.util.List<Pair<CheckTextRegionLocation,java.lang.String>>	getFindings() Returns the findings reported so far.
protected void	reportFinding(CheckTextRegionLocation textRegionLocation, java.lang.String message) Creates a finding for the CheckTextRegionLocation with the given message.

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.cqse.clang.IClangCursorVisitor

visit

Field Detail

translationUnit

protected final eu.cqse.clang.SWIGTYPE_p_CXTranslationUnitImpl translationUnit

The main Clang translation unit for the source file.

uniformPath

protected final java.lang.String uniformPath

The uniform path of the source file.

fileText

protected final java.lang.String fileText

The ECodeViewOption.UNFILTERED source file text.

Constructor Detail

FindingCollectingClangCursorVisitorBase

protected FindingCollectingClangCursorVisitorBase(eu.cqse.clang.SWIGTYPE_p_CXTranslationUnitImpl translationUnit,
                                                  java.lang.String uniformPath,
                                                  java.lang.String fileText)

Method Detail

getFindings

public java.util.List<Pair<CheckTextRegionLocation,java.lang.String>> getFindings()

Returns the findings reported so far. The contained Pairs consist of the finding CheckTextRegionLocation and the finding message.

reportFinding

protected void reportFinding(CheckTextRegionLocation textRegionLocation,
                             java.lang.String message)

Creates a finding for the CheckTextRegionLocation with the given message.