clang/lib/StaticAnalyzer/Core/TextDiagnostics.cpp

   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
  29 using namespace clang;
  30 using namespace ento;
  31 using namespace tooling;
  32
  33 namespace {
  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.
  37 class TextDiagnostics : public PathDiagnosticConsumer {
  38   PathDiagnosticConsumerOptions DiagOpts;
  39   DiagnosticsEngine &DiagEng;
  40   const LangOptions &LO;
  41   bool ShouldDisplayPathNotes;
  42
  43 public:
  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(DiagnosticsEngine::Error, "%0")
  65             : DiagEng.getCustomDiagID(DiagnosticsEngine::Warning, "%0");
  66     unsigned NoteID = DiagEng.getCustomDiagID(DiagnosticsEngine::Note, "%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, ID) << String << Ranges << Fixits;
  75         return;
  76       }
  77
  78       DiagEng.Report(Loc, 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(Repl)) {
  83           llvm::errs() << "Error applying replacement " << Repl.toString()
  84                        << ": " << Err << "\n";
  85         }
  86       }
  87     };
  88
  89     for (std::vector<const PathDiagnostic *>::iterator I = Diags.begin(),
  90          E = Diags.end();
  91          I != E; ++I) {
  92       const PathDiagnostic *PD = *I;
  93       std::string WarningMsg = (DiagOpts.ShouldDisplayDiagnosticName
  94                                     ? " [" + PD->getCheckerName() + "]"
  95                                     : "")
  96                                    .str();
  97
  98       reportPiece(WarnID, PD->getLocation().asLocation(),
  99                   (PD->getShortDescription() + WarningMsg).str(),
 100                   PD->path.back()->getRanges(), PD->path.back()->getFixits());
 101
 102       // First, add extra notes, even if paths should not be included.
 103       for (const auto &Piece : PD->path) {
 104         if (!isa<PathDiagnosticNotePiece>(Piece.get()))
 105           continue;
 106
 107         reportPiece(NoteID, Piece->getLocation().asLocation(),
 108                     Piece->getString(), Piece->getRanges(),
 109                     Piece->getFixits());
 110       }
 111
 112       if (!ShouldDisplayPathNotes)
 113         continue;
 114
 115       // Then, add the path notes if necessary.
 116       PathPieces FlatPath = PD->path.flatten(/*ShouldFlattenMacros=*/true);
 117       for (const auto &Piece : FlatPath) {
 118         if (isa<PathDiagnosticNotePiece>(Piece.get()))
 119           continue;
 120
 121         reportPiece(NoteID, Piece->getLocation().asLocation(),
 122                     Piece->getString(), Piece->getRanges(),
 123                     Piece->getFixits());
 124       }
 125     }
 126
 127     if (Repls.empty())
 128       return;
 129
 130     Rewriter Rewrite(SM, LO);
 131     if (!applyAllReplacements(Repls, Rewrite)) {
 132       llvm::errs() << "An error occurred during applying fix-it.\n";
 133     }
 134
 135     Rewrite.overwriteChangedFiles();
 136   }
 137 };
 138 } // end anonymous namespace
 139
 140 void ento::createTextPathDiagnosticConsumer(
 141     PathDiagnosticConsumerOptions DiagOpts, PathDiagnosticConsumers &C,
 142     const std::string &Prefix, const Preprocessor &PP,
 143     const cross_tu::CrossTranslationUnitContext &CTU,
 144     const MacroExpansionContext &MacroExpansions) {
 145   C.emplace_back(new TextDiagnostics(std::move(DiagOpts), PP.getDiagnostics(),
 146                                      PP.getLangOpts(),
 147                                      /*ShouldDisplayPathNotes=*/true));
 148 }
 149
 150 void ento::createTextMinimalPathDiagnosticConsumer(
 151     PathDiagnosticConsumerOptions DiagOpts, PathDiagnosticConsumers &C,
 152     const std::string &Prefix, const Preprocessor &PP,
 153     const cross_tu::CrossTranslationUnitContext &CTU,
 154     const MacroExpansionContext &MacroExpansions) {
 155   C.emplace_back(new TextDiagnostics(std::move(DiagOpts), PP.getDiagnostics(),
 156                                      PP.getLangOpts(),
 157                                      /*ShouldDisplayPathNotes=*/false));
 158 }