clang 17.0.0git
Go to the documentation of this file.
1//===------- SARIFDiagnosticPrinter.cpp - Diagnostic Printer---------------===//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
9// This diagnostic client prints out their diagnostic messages in SARIF format.
15#include "clang/Basic/Sarif.h"
19#include "clang/Lex/Lexer.h"
20#include "llvm/ADT/SmallString.h"
21#include "llvm/Support/ErrorHandling.h"
22#include "llvm/Support/JSON.h"
23#include "llvm/Support/raw_ostream.h"
24#include <algorithm>
26namespace clang {
29 DiagnosticOptions *Diags)
30 : OS(OS), DiagOpts(Diags) {}
33 const Preprocessor *PP) {
34 // Build the SARIFDiagnostic utility.
35 assert(hasSarifWriter() && "Writer not set!");
36 assert(!SARIFDiag && "SARIFDiagnostic already set.");
37 SARIFDiag = std::make_unique<SARIFDiagnostic>(OS, LO, &*DiagOpts, &*Writer);
38 // Initialize the SARIF object.
39 Writer->createRun("clang", Prefix);
43 assert(SARIFDiag && "SARIFDiagnostic has not been set.");
44 Writer->endRun();
45 llvm::json::Value Value(Writer->createDocument());
46 OS << "\n" << Value << "\n\n";
47 OS.flush();
48 SARIFDiag.reset();
52 const Diagnostic &Info) {
53 assert(SARIFDiag && "SARIFDiagnostic has not been set.");
54 // Default implementation (Warnings/errors count). Keeps track of the
55 // number of errors.
58 // Render the diagnostic message into a temporary buffer eagerly. We'll use
59 // this later as we add the diagnostic to the SARIF object.
60 SmallString<100> OutStr;
61 Info.FormatDiagnostic(OutStr);
63 llvm::raw_svector_ostream DiagMessageStream(OutStr);
65 // Use a dedicated, simpler path for diagnostics without a valid location.
66 // This is important as if the location is missing, we may be emitting
67 // diagnostics in a context that lacks language options, a source manager, or
68 // other infrastructure necessary when emitting more rich diagnostics.
69 if (Info.getLocation().isInvalid()) {
70 // FIXME: Enable diagnostics without a source manager
71 return;
72 }
74 // Assert that the rest of our infrastructure is setup properly.
75 assert(DiagOpts && "Unexpected diagnostic without options set");
76 assert(Info.hasSourceManager() &&
77 "Unexpected diagnostic with no source manager");
79 SARIFDiag->emitDiagnostic(
80 FullSourceLoc(Info.getLocation(), Info.getSourceManager()), Level,
81 DiagMessageStream.str(), Info.getRanges(), Info.getFixItHints(), &Info);
83} // namespace clang
llvm::raw_ostream & OS
Definition: Logger.cpp:24
Defines clang::SarifDocumentWriter, clang::SarifRule, clang::SarifResult.
Defines the SourceManager interface.
virtual void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, const Diagnostic &Info)
Handle this diagnostic, reporting it to the user or capturing it to a log as needed.
Definition: Diagnostic.cpp:564
Options for controlling the compiler diagnostics engine.
A little helper class (which is basically a smart pointer that forwards info from DiagnosticsEngine) ...
Definition: Diagnostic.h:1566
const SourceLocation & getLocation() const
Definition: Diagnostic.h:1577
void FormatDiagnostic(SmallVectorImpl< char > &OutStr) const
Format this diagnostic into a string, substituting the formal arguments into the %0 slots.
Definition: Diagnostic.cpp:795
SourceManager & getSourceManager() const
Definition: Diagnostic.h:1579
ArrayRef< FixItHint > getFixItHints() const
Definition: Diagnostic.h:1670
bool hasSourceManager() const
Definition: Diagnostic.h:1578
ArrayRef< CharSourceRange > getRanges() const
Return an array reference for this diagnostic's ranges.
Definition: Diagnostic.h:1657
The level of the diagnostic, after it has been through mapping.
Definition: Diagnostic.h:195
A SourceLocation and its associated SourceManager.
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:82
Engages in a tight little dance with the lexer to efficiently preprocess tokens.
Definition: Preprocessor.h:128
void EndSourceFile() override
Callback to inform the diagnostic client that processing of a source file has ended.
void HandleDiagnostic(DiagnosticsEngine::Level Level, const Diagnostic &Info) override
Handle this diagnostic, reporting it to the user or capturing it to a log as needed.
void BeginSourceFile(const LangOptions &LO, const Preprocessor *PP) override
Callback to inform the diagnostic client that processing of a source file is beginning.
SARIFDiagnosticPrinter(raw_ostream &OS, DiagnosticOptions *Diags)