class SarifResult

Declaration

class SarifResult { /* full declaration omitted */ };

Description

A SARIF result (also called a "reporting item") is a unit of output produced when one of the tool's \c reportingDescriptor encounters a match on the file being analysed by the tool. This builder provides a \ref SarifResult::create static method that can be used to create an empty shell onto which attributes can be added using the\c setX(...) methods. For example: Reference: 1. SARIF result

Declared at: clang/include/clang/Basic/Sarif.h:248

Member Variables

private uint32_t RuleIdx
private std::string RuleId
private std::string DiagnosticMessage
private llvm::SmallVector<CharSourceRange, 8> Locations
private llvm::SmallVector<ThreadFlow, 8> ThreadFlows

Method Overview

  • private SarifResult()
  • private SarifResult(uint32_t RuleIdx)
  • public static clang::SarifResult create(uint32_t RuleIdx)
  • public clang::SarifResult setDiagnosticMessage(llvm::StringRef Message)
  • public clang::SarifResult setIndex(uint32_t Idx)
  • public clang::SarifResult setLocations(llvm::ArrayRef<CharSourceRange> DiagLocs)
  • public clang::SarifResult setRuleId(llvm::StringRef Id)
  • public clang::SarifResult setThreadFlows(llvm::ArrayRef<ThreadFlow> ThreadFlowResults)

Methods

SarifResult()

Declared at: clang/include/clang/Basic/Sarif.h:261

SarifResult(uint32_t RuleIdx)

Declared at: clang/include/clang/Basic/Sarif.h:262

Parameters

uint32_t RuleIdx

static clang::SarifResult create(uint32_t RuleIdx)

Declared at: clang/include/clang/Basic/Sarif.h:265

Parameters

uint32_t RuleIdx

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

Declared at: clang/include/clang/Basic/Sarif.h:277

Parameters

llvm::StringRef Message

clang::SarifResult setIndex(uint32_t Idx)

Declared at: clang/include/clang/Basic/Sarif.h:267

Parameters

uint32_t Idx

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

Declared at: clang/include/clang/Basic/Sarif.h:282

Parameters

llvm::ArrayRef<CharSourceRange> DiagLocs

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

Declared at: clang/include/clang/Basic/Sarif.h:272

Parameters

llvm::StringRef Id

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

Declared at: clang/include/clang/Basic/Sarif.h:292

Parameters

llvm::ArrayRef<ThreadFlow> ThreadFlowResults