15ffd83dbSDimitry Andric //===--- TextDiagnostics.cpp - Text Diagnostics for Paths -------*- C++ -*-===//
25ffd83dbSDimitry Andric //
35ffd83dbSDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
45ffd83dbSDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
55ffd83dbSDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
65ffd83dbSDimitry Andric //
75ffd83dbSDimitry Andric //===----------------------------------------------------------------------===//
85ffd83dbSDimitry Andric //
95ffd83dbSDimitry Andric // This file defines the TextDiagnostics object.
105ffd83dbSDimitry Andric //
115ffd83dbSDimitry Andric //===----------------------------------------------------------------------===//
125ffd83dbSDimitry Andric
13fe6060f1SDimitry Andric #include "clang/Analysis/MacroExpansionContext.h"
145ffd83dbSDimitry Andric #include "clang/Analysis/PathDiagnostic.h"
155ffd83dbSDimitry Andric #include "clang/Basic/SourceManager.h"
165ffd83dbSDimitry Andric #include "clang/Basic/Version.h"
175ffd83dbSDimitry Andric #include "clang/CrossTU/CrossTranslationUnit.h"
185ffd83dbSDimitry Andric #include "clang/Frontend/ASTUnit.h"
195ffd83dbSDimitry Andric #include "clang/Lex/Preprocessor.h"
205ffd83dbSDimitry Andric #include "clang/Rewrite/Core/Rewriter.h"
215ffd83dbSDimitry Andric #include "clang/StaticAnalyzer/Core/AnalyzerOptions.h"
225ffd83dbSDimitry Andric #include "clang/StaticAnalyzer/Core/PathDiagnosticConsumers.h"
235ffd83dbSDimitry Andric #include "clang/Tooling/Core/Replacement.h"
245ffd83dbSDimitry Andric #include "clang/Tooling/Tooling.h"
255ffd83dbSDimitry Andric #include "llvm/ADT/SmallPtrSet.h"
265ffd83dbSDimitry Andric #include "llvm/ADT/SmallVector.h"
275ffd83dbSDimitry Andric #include "llvm/Support/Casting.h"
285ffd83dbSDimitry Andric
295ffd83dbSDimitry Andric using namespace clang;
305ffd83dbSDimitry Andric using namespace ento;
315ffd83dbSDimitry Andric using namespace tooling;
325ffd83dbSDimitry Andric
335ffd83dbSDimitry Andric namespace {
34bdd1243dSDimitry Andric /// Emits minimal diagnostics (report message + notes) for the 'none' output
35bdd1243dSDimitry Andric /// type to the standard error, or to complement many others. Emits detailed
365ffd83dbSDimitry Andric /// diagnostics in textual format for the 'text' output type.
375ffd83dbSDimitry Andric class TextDiagnostics : public PathDiagnosticConsumer {
38e8d8bef9SDimitry Andric PathDiagnosticConsumerOptions DiagOpts;
395ffd83dbSDimitry Andric DiagnosticsEngine &DiagEng;
405ffd83dbSDimitry Andric const LangOptions &LO;
41e8d8bef9SDimitry Andric bool ShouldDisplayPathNotes;
425ffd83dbSDimitry Andric
435ffd83dbSDimitry Andric public:
TextDiagnostics(PathDiagnosticConsumerOptions DiagOpts,DiagnosticsEngine & DiagEng,const LangOptions & LO,bool ShouldDisplayPathNotes)44e8d8bef9SDimitry Andric TextDiagnostics(PathDiagnosticConsumerOptions DiagOpts,
45e8d8bef9SDimitry Andric DiagnosticsEngine &DiagEng, const LangOptions &LO,
46e8d8bef9SDimitry Andric bool ShouldDisplayPathNotes)
47e8d8bef9SDimitry Andric : DiagOpts(std::move(DiagOpts)), DiagEng(DiagEng), LO(LO),
48e8d8bef9SDimitry Andric ShouldDisplayPathNotes(ShouldDisplayPathNotes) {}
~TextDiagnostics()495ffd83dbSDimitry Andric ~TextDiagnostics() override {}
505ffd83dbSDimitry Andric
getName() const515ffd83dbSDimitry Andric StringRef getName() const override { return "TextDiagnostics"; }
525ffd83dbSDimitry Andric
supportsLogicalOpControlFlow() const535ffd83dbSDimitry Andric bool supportsLogicalOpControlFlow() const override { return true; }
supportsCrossFileDiagnostics() const545ffd83dbSDimitry Andric bool supportsCrossFileDiagnostics() const override { return true; }
555ffd83dbSDimitry Andric
getGenerationScheme() const565ffd83dbSDimitry Andric PathGenerationScheme getGenerationScheme() const override {
57e8d8bef9SDimitry Andric return ShouldDisplayPathNotes ? Minimal : None;
585ffd83dbSDimitry Andric }
595ffd83dbSDimitry Andric
FlushDiagnosticsImpl(std::vector<const PathDiagnostic * > & Diags,FilesMade * filesMade)605ffd83dbSDimitry Andric void FlushDiagnosticsImpl(std::vector<const PathDiagnostic *> &Diags,
615ffd83dbSDimitry Andric FilesMade *filesMade) override {
625ffd83dbSDimitry Andric unsigned WarnID =
63e8d8bef9SDimitry Andric DiagOpts.ShouldDisplayWarningsAsErrors
645ffd83dbSDimitry Andric ? DiagEng.getCustomDiagID(DiagnosticsEngine::Error, "%0")
655ffd83dbSDimitry Andric : DiagEng.getCustomDiagID(DiagnosticsEngine::Warning, "%0");
665ffd83dbSDimitry Andric unsigned NoteID = DiagEng.getCustomDiagID(DiagnosticsEngine::Note, "%0");
675ffd83dbSDimitry Andric SourceManager &SM = DiagEng.getSourceManager();
685ffd83dbSDimitry Andric
695ffd83dbSDimitry Andric Replacements Repls;
705ffd83dbSDimitry Andric auto reportPiece = [&](unsigned ID, FullSourceLoc Loc, StringRef String,
715ffd83dbSDimitry Andric ArrayRef<SourceRange> Ranges,
725ffd83dbSDimitry Andric ArrayRef<FixItHint> Fixits) {
73e8d8bef9SDimitry Andric if (!DiagOpts.ShouldApplyFixIts) {
745ffd83dbSDimitry Andric DiagEng.Report(Loc, ID) << String << Ranges << Fixits;
755ffd83dbSDimitry Andric return;
765ffd83dbSDimitry Andric }
775ffd83dbSDimitry Andric
785ffd83dbSDimitry Andric DiagEng.Report(Loc, ID) << String << Ranges;
795ffd83dbSDimitry Andric for (const FixItHint &Hint : Fixits) {
805ffd83dbSDimitry Andric Replacement Repl(SM, Hint.RemoveRange, Hint.CodeToInsert);
815ffd83dbSDimitry Andric
825ffd83dbSDimitry Andric if (llvm::Error Err = Repls.add(Repl)) {
835ffd83dbSDimitry Andric llvm::errs() << "Error applying replacement " << Repl.toString()
845ffd83dbSDimitry Andric << ": " << Err << "\n";
855ffd83dbSDimitry Andric }
865ffd83dbSDimitry Andric }
875ffd83dbSDimitry Andric };
885ffd83dbSDimitry Andric
89*06c3fb27SDimitry Andric for (const PathDiagnostic *PD : Diags) {
90e8d8bef9SDimitry Andric std::string WarningMsg = (DiagOpts.ShouldDisplayDiagnosticName
91e8d8bef9SDimitry Andric ? " [" + PD->getCheckerName() + "]"
92e8d8bef9SDimitry Andric : "")
935ffd83dbSDimitry Andric .str();
945ffd83dbSDimitry Andric
955ffd83dbSDimitry Andric reportPiece(WarnID, PD->getLocation().asLocation(),
965ffd83dbSDimitry Andric (PD->getShortDescription() + WarningMsg).str(),
975ffd83dbSDimitry Andric PD->path.back()->getRanges(), PD->path.back()->getFixits());
985ffd83dbSDimitry Andric
995ffd83dbSDimitry Andric // First, add extra notes, even if paths should not be included.
1005ffd83dbSDimitry Andric for (const auto &Piece : PD->path) {
1015ffd83dbSDimitry Andric if (!isa<PathDiagnosticNotePiece>(Piece.get()))
1025ffd83dbSDimitry Andric continue;
1035ffd83dbSDimitry Andric
1045ffd83dbSDimitry Andric reportPiece(NoteID, Piece->getLocation().asLocation(),
1055ffd83dbSDimitry Andric Piece->getString(), Piece->getRanges(),
1065ffd83dbSDimitry Andric Piece->getFixits());
1075ffd83dbSDimitry Andric }
1085ffd83dbSDimitry Andric
109e8d8bef9SDimitry Andric if (!ShouldDisplayPathNotes)
1105ffd83dbSDimitry Andric continue;
1115ffd83dbSDimitry Andric
1125ffd83dbSDimitry Andric // Then, add the path notes if necessary.
1135ffd83dbSDimitry Andric PathPieces FlatPath = PD->path.flatten(/*ShouldFlattenMacros=*/true);
1145ffd83dbSDimitry Andric for (const auto &Piece : FlatPath) {
1155ffd83dbSDimitry Andric if (isa<PathDiagnosticNotePiece>(Piece.get()))
1165ffd83dbSDimitry Andric continue;
1175ffd83dbSDimitry Andric
1185ffd83dbSDimitry Andric reportPiece(NoteID, Piece->getLocation().asLocation(),
1195ffd83dbSDimitry Andric Piece->getString(), Piece->getRanges(),
1205ffd83dbSDimitry Andric Piece->getFixits());
1215ffd83dbSDimitry Andric }
1225ffd83dbSDimitry Andric }
1235ffd83dbSDimitry Andric
124e8d8bef9SDimitry Andric if (Repls.empty())
1255ffd83dbSDimitry Andric return;
1265ffd83dbSDimitry Andric
1275ffd83dbSDimitry Andric Rewriter Rewrite(SM, LO);
1285ffd83dbSDimitry Andric if (!applyAllReplacements(Repls, Rewrite)) {
12981ad6265SDimitry Andric llvm::errs() << "An error occurred during applying fix-it.\n";
1305ffd83dbSDimitry Andric }
1315ffd83dbSDimitry Andric
1325ffd83dbSDimitry Andric Rewrite.overwriteChangedFiles();
1335ffd83dbSDimitry Andric }
1345ffd83dbSDimitry Andric };
1355ffd83dbSDimitry Andric } // end anonymous namespace
1365ffd83dbSDimitry Andric
createTextPathDiagnosticConsumer(PathDiagnosticConsumerOptions DiagOpts,PathDiagnosticConsumers & C,const std::string & Prefix,const Preprocessor & PP,const cross_tu::CrossTranslationUnitContext & CTU,const MacroExpansionContext & MacroExpansions)1375ffd83dbSDimitry Andric void ento::createTextPathDiagnosticConsumer(
138e8d8bef9SDimitry Andric PathDiagnosticConsumerOptions DiagOpts, PathDiagnosticConsumers &C,
139fe6060f1SDimitry Andric const std::string &Prefix, const Preprocessor &PP,
140fe6060f1SDimitry Andric const cross_tu::CrossTranslationUnitContext &CTU,
141fe6060f1SDimitry Andric const MacroExpansionContext &MacroExpansions) {
142e8d8bef9SDimitry Andric C.emplace_back(new TextDiagnostics(std::move(DiagOpts), PP.getDiagnostics(),
143e8d8bef9SDimitry Andric PP.getLangOpts(),
144e8d8bef9SDimitry Andric /*ShouldDisplayPathNotes=*/true));
1455ffd83dbSDimitry Andric }
1465ffd83dbSDimitry Andric
createTextMinimalPathDiagnosticConsumer(PathDiagnosticConsumerOptions DiagOpts,PathDiagnosticConsumers & C,const std::string & Prefix,const Preprocessor & PP,const cross_tu::CrossTranslationUnitContext & CTU,const MacroExpansionContext & MacroExpansions)1475ffd83dbSDimitry Andric void ento::createTextMinimalPathDiagnosticConsumer(
148e8d8bef9SDimitry Andric PathDiagnosticConsumerOptions DiagOpts, PathDiagnosticConsumers &C,
149fe6060f1SDimitry Andric const std::string &Prefix, const Preprocessor &PP,
150fe6060f1SDimitry Andric const cross_tu::CrossTranslationUnitContext &CTU,
151fe6060f1SDimitry Andric const MacroExpansionContext &MacroExpansions) {
152e8d8bef9SDimitry Andric C.emplace_back(new TextDiagnostics(std::move(DiagOpts), PP.getDiagnostics(),
153e8d8bef9SDimitry Andric PP.getLangOpts(),
154e8d8bef9SDimitry Andric /*ShouldDisplayPathNotes=*/false));
1555ffd83dbSDimitry Andric }
156