llvm/clang/lib/Basic/Sarif.cpp

//===-- clang/Basic/Sarif.cpp - SarifDocumentWriter class definition ------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
///
/// \file
/// This file contains the declaration of the SARIFDocumentWriter class, and
/// associated builders such as:
/// - \ref SarifArtifact
/// - \ref SarifArtifactLocation
/// - \ref SarifRule
/// - \ref SarifResult
//===----------------------------------------------------------------------===//
#include "clang/Basic/Sarif.h"
#include "clang/Basic/SourceLocation.h"
#include "clang/Basic/SourceManager.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/StringExtras.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/ConvertUTF.h"
#include "llvm/Support/JSON.h"
#include "llvm/Support/Path.h"

#include <optional>
#include <string>
#include <utility>

usingnamespaceclang;
usingnamespacellvm;

SarifArtifact;
SarifArtifactLocation;

static StringRef getFileName(FileEntryRef FE) { … }
/// \name URI
/// @{

/// \internal
/// \brief
/// Return the RFC3986 encoding of the input character.
///
/// \param C Character to encode to RFC3986.
///
/// \return The RFC3986 representation of \c C.
static std::string percentEncodeURICharacter(char C) { … }

/// \internal
/// \brief Return a URI representing the given file name.
///
/// \param Filename The filename to be represented as URI.
///
/// \return RFC3986 URI representing the input file name.
static std::string fileNameToURI(StringRef Filename) { … }
///  @}

/// \brief Calculate the column position expressed in the number of UTF-8 code
/// points from column start to the source location
///
/// \param Loc The source location whose column needs to be calculated.
/// \param TokenLen Optional hint for when the token is multiple bytes long.
///
/// \return The column number as a UTF-8 aware byte offset from column start to
/// the effective source location.
static unsigned int adjustColumnPos(FullSourceLoc Loc,
                                    unsigned int TokenLen = 0) { … }

/// \name SARIF Utilities
/// @{

/// \internal
static json::Object createMessage(StringRef Text) { … }

/// \internal
/// \pre CharSourceRange must be a token range
static json::Object createTextRegion(const SourceManager &SM,
                                     const CharSourceRange &R) { … }

static json::Object createLocation(json::Object &&PhysicalLocation,
                                   StringRef Message = "") { … }

static StringRef importanceToStr(ThreadFlowImportance I) { … }

static StringRef resultLevelToStr(SarifResultLevel R) { … }

static json::Object
createThreadFlowLocation(json::Object &&Location,
                         const ThreadFlowImportance &Importance) { … }
///  @}

json::Object
SarifDocumentWriter::createPhysicalLocation(const CharSourceRange &R) { … }

json::Object &SarifDocumentWriter::getCurrentTool() { … }

void SarifDocumentWriter::reset() { … }

void SarifDocumentWriter::endRun() { … }

json::Array
SarifDocumentWriter::createThreadFlows(ArrayRef<ThreadFlow> ThreadFlows) { … }

json::Object
SarifDocumentWriter::createCodeFlow(ArrayRef<ThreadFlow> ThreadFlows) { … }

void SarifDocumentWriter::createRun(StringRef ShortToolName,
                                    StringRef LongToolName,
                                    StringRef ToolVersion) { … }

json::Object &SarifDocumentWriter::getCurrentRun() { … }

size_t SarifDocumentWriter::createRule(const SarifRule &Rule) { … }

void SarifDocumentWriter::appendResult(const SarifResult &Result) { … }

json::Object SarifDocumentWriter::createDocument() { … }