1//===--- TextDiagnostics.cpp - Text Diagnostics for Paths -------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file defines the TextDiagnostics object.
10//
11//===----------------------------------------------------------------------===//
12
13#include "clang/Analysis/MacroExpansionContext.h"
14#include "clang/Analysis/PathDiagnostic.h"
15#include "clang/Basic/SourceManager.h"
16#include "clang/Basic/Version.h"
17#include "clang/CrossTU/CrossTranslationUnit.h"
18#include "clang/Frontend/ASTUnit.h"
19#include "clang/Lex/Preprocessor.h"
20#include "clang/Rewrite/Core/Rewriter.h"
21#include "clang/StaticAnalyzer/Core/AnalyzerOptions.h"
22#include "clang/StaticAnalyzer/Core/PathDiagnosticConsumers.h"
23#include "clang/Tooling/Core/Replacement.h"
24#include "clang/Tooling/Tooling.h"
25#include "llvm/ADT/SmallPtrSet.h"
26#include "llvm/ADT/SmallVector.h"
27#include "llvm/Support/Casting.h"
28
29using namespace clang;
30using namespace ento;
31using namespace tooling;
32
33namespace {
34/// Emits minimal diagnostics (report message + notes) for the 'none' output
35/// type to the standard error, or to complement many others. Emits detailed
36/// diagnostics in textual format for the 'text' output type.
37class TextDiagnostics : public PathDiagnosticConsumer {
38 PathDiagnosticConsumerOptions DiagOpts;
39 DiagnosticsEngine &DiagEng;
40 const LangOptions &LO;
41 bool ShouldDisplayPathNotes;
42
43public:
44 TextDiagnostics(PathDiagnosticConsumerOptions DiagOpts,
45 DiagnosticsEngine &DiagEng, const LangOptions &LO,
46 bool ShouldDisplayPathNotes)
47 : DiagOpts(std::move(DiagOpts)), DiagEng(DiagEng), LO(LO),
48 ShouldDisplayPathNotes(ShouldDisplayPathNotes) {}
49 ~TextDiagnostics() override {}
50
51 StringRef getName() const override { return "TextDiagnostics"; }
52
53 bool supportsLogicalOpControlFlow() const override { return true; }
54 bool supportsCrossFileDiagnostics() const override { return true; }
55
56 PathGenerationScheme getGenerationScheme() const override {
57 return ShouldDisplayPathNotes ? Minimal : None;
58 }
59
60 void FlushDiagnosticsImpl(std::vector<const PathDiagnostic *> &Diags,
61 FilesMade *filesMade) override {
62 unsigned WarnID =
63 DiagOpts.ShouldDisplayWarningsAsErrors
64 ? DiagEng.getCustomDiagID(L: DiagnosticsEngine::Error, FormatString: "%0")
65 : DiagEng.getCustomDiagID(L: DiagnosticsEngine::Warning, FormatString: "%0");
66 unsigned NoteID = DiagEng.getCustomDiagID(L: DiagnosticsEngine::Note, FormatString: "%0");
67 SourceManager &SM = DiagEng.getSourceManager();
68
69 Replacements Repls;
70 auto reportPiece = [&](unsigned ID, FullSourceLoc Loc, StringRef String,
71 ArrayRef<SourceRange> Ranges,
72 ArrayRef<FixItHint> Fixits) {
73 if (!DiagOpts.ShouldApplyFixIts) {
74 DiagEng.Report(Loc, DiagID: ID) << String << Ranges << Fixits;
75 return;
76 }
77
78 DiagEng.Report(Loc, DiagID: ID) << String << Ranges;
79 for (const FixItHint &Hint : Fixits) {
80 Replacement Repl(SM, Hint.RemoveRange, Hint.CodeToInsert);
81
82 if (llvm::Error Err = Repls.add(R: Repl)) {
83 llvm::errs() << "Error applying replacement " << Repl.toString()
84 << ": " << Err << "\n";
85 }
86 }
87 };
88
89 for (const PathDiagnostic *PD : Diags) {
90 std::string WarningMsg = (DiagOpts.ShouldDisplayDiagnosticName
91 ? " [" + PD->getCheckerName() + "]"
92 : "")
93 .str();
94
95 reportPiece(WarnID, PD->getLocation().asLocation(),
96 (PD->getShortDescription() + WarningMsg).str(),
97 PD->path.back()->getRanges(), PD->path.back()->getFixits());
98
99 // First, add extra notes, even if paths should not be included.
100 for (const auto &Piece : PD->path) {
101 if (!isa<PathDiagnosticNotePiece>(Val: Piece.get()))
102 continue;
103
104 reportPiece(NoteID, Piece->getLocation().asLocation(),
105 Piece->getString(), Piece->getRanges(),
106 Piece->getFixits());
107 }
108
109 if (!ShouldDisplayPathNotes)
110 continue;
111
112 // Then, add the path notes if necessary.
113 PathPieces FlatPath = PD->path.flatten(/*ShouldFlattenMacros=*/true);
114 for (const auto &Piece : FlatPath) {
115 if (isa<PathDiagnosticNotePiece>(Val: Piece.get()))
116 continue;
117
118 reportPiece(NoteID, Piece->getLocation().asLocation(),
119 Piece->getString(), Piece->getRanges(),
120 Piece->getFixits());
121 }
122 }
123
124 if (Repls.empty())
125 return;
126
127 Rewriter Rewrite(SM, LO);
128 if (!applyAllReplacements(Replaces: Repls, Rewrite)) {
129 llvm::errs() << "An error occurred during applying fix-it.\n";
130 }
131
132 Rewrite.overwriteChangedFiles();
133 }
134};
135} // end anonymous namespace
136
137void ento::createTextPathDiagnosticConsumer(
138 PathDiagnosticConsumerOptions DiagOpts, PathDiagnosticConsumers &C,
139 const std::string &Prefix, const Preprocessor &PP,
140 const cross_tu::CrossTranslationUnitContext &CTU,
141 const MacroExpansionContext &MacroExpansions) {
142 C.emplace_back(args: new TextDiagnostics(std::move(DiagOpts), PP.getDiagnostics(),
143 PP.getLangOpts(),
144 /*ShouldDisplayPathNotes=*/true));
145}
146
147void ento::createTextMinimalPathDiagnosticConsumer(
148 PathDiagnosticConsumerOptions DiagOpts, PathDiagnosticConsumers &C,
149 const std::string &Prefix, const Preprocessor &PP,
150 const cross_tu::CrossTranslationUnitContext &CTU,
151 const MacroExpansionContext &MacroExpansions) {
152 C.emplace_back(args: new TextDiagnostics(std::move(DiagOpts), PP.getDiagnostics(),
153 PP.getLangOpts(),
154 /*ShouldDisplayPathNotes=*/false));
155}
156