clang::SarifResult Class Reference

A SARIF result (also called a "reporting item") is a unit of output produced when one of the tool's reportingDescriptor encounters a match on the file being analysed by the tool. More...

#include "clang/Basic/Sarif.h"

Public Member Functions
SarifResult	setIndex (uint32_t Idx)
SarifResult	setRuleId (llvm::StringRef Id)
SarifResult	setDiagnosticMessage (llvm::StringRef Message)
SarifResult	setHostedViewerURI (llvm::StringRef URI)
SarifResult	addLocations (llvm::ArrayRef< CharSourceRange > DiagLocs)
SarifResult	addRelatedLocations (llvm::ArrayRef< CharSourceRange > DiagLocs)
SarifResult	setThreadFlows (llvm::ArrayRef< ThreadFlow > ThreadFlowResults)
SarifResult	setDiagnosticLevel (const SarifResultLevel &TheLevel)
SarifResult	addPartialFingerprint (llvm::StringRef key, llvm::StringRef value)

Static Public Member Functions
static SarifResult	create (uint32_t RuleIdx)

Friends
class	clang::SarifDocumentWriter

Detailed Description

A SARIF result (also called a "reporting item") is a unit of output produced when one of the tool's reportingDescriptor encounters a match on the file being analysed by the tool.

This builder provides a SarifResult::create static method that can be used to create an empty shell onto which attributes can be added using the setX(...) methods.

For example:

SarifResult result = SarifResult::create(...)
                        .setRuleId(...)
                        .setDiagnosticMessage(...);

Reference:

1. SARIFresult

Definition at line 322 of file Sarif.h.

Member Function Documentation

addLocations()

SarifResult clang::SarifResult::addLocations ( llvm::ArrayRef< CharSourceRange > DiagLocs )

inline

Definition at line 365 of file Sarif.h.

addPartialFingerprint()

SarifResult clang::SarifResult::addPartialFingerprint ( llvm::StringRef key, llvm::StringRef value )

inline

Definition at line 398 of file Sarif.h.

addRelatedLocations()

SarifResult clang::SarifResult::addRelatedLocations ( llvm::ArrayRef< CharSourceRange > DiagLocs )

inline

Definition at line 376 of file Sarif.h.

create()

SarifResult clang::SarifResult::create ( uint32_t RuleIdx )

inlinestatic

Definition at line 343 of file Sarif.h.

References uint32_t.

Referenced by clang::SARIFDiagnostic::emitDiagnosticMessage(), and clang::ssaf::writeSARIFTransformationReport().

setDiagnosticLevel()

SarifResult clang::SarifResult::setDiagnosticLevel ( const SarifResultLevel & TheLevel )

inline

Definition at line 393 of file Sarif.h.

Referenced by clang::ssaf::writeSARIFTransformationReport().

setDiagnosticMessage()

SarifResult clang::SarifResult::setDiagnosticMessage ( llvm::StringRef Message )

inline

Definition at line 355 of file Sarif.h.

Referenced by clang::SARIFDiagnostic::emitDiagnosticMessage(), and clang::ssaf::writeSARIFTransformationReport().

setHostedViewerURI()

SarifResult clang::SarifResult::setHostedViewerURI ( llvm::StringRef URI )

inline

Definition at line 360 of file Sarif.h.

setIndex()

SarifResult clang::SarifResult::setIndex ( uint32_t Idx )

inline

Definition at line 345 of file Sarif.h.

References uint32_t.

setRuleId()

SarifResult clang::SarifResult::setRuleId ( llvm::StringRef Id )

inline

Definition at line 350 of file Sarif.h.

Referenced by clang::ssaf::writeSARIFTransformationReport().

setThreadFlows()

SarifResult clang::SarifResult::setThreadFlows ( llvm::ArrayRef< ThreadFlow > ThreadFlowResults )

inline

Definition at line 388 of file Sarif.h.

Friends And Related Symbol Documentation

clang::SarifDocumentWriter

friend class clang::SarifDocumentWriter

friend

Definition at line 323 of file Sarif.h.

References uint32_t.

---

The documentation for this class was generated from the following file:

• include/clang/Basic/Sarif.h