Coverage Report

Created: 2020-09-15 12:33

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/lib/Frontend/TextDiagnosticPrinter.cpp
Line
Count
Source (jump to first uncovered line)
1
//===--- TextDiagnosticPrinter.cpp - Diagnostic Printer -------------------===//
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 diagnostic client prints out their diagnostic messages.
10
//
11
//===----------------------------------------------------------------------===//
12
13
#include "clang/Frontend/TextDiagnosticPrinter.h"
14
#include "clang/Basic/DiagnosticOptions.h"
15
#include "clang/Basic/SourceManager.h"
16
#include "clang/Frontend/TextDiagnostic.h"
17
#include "clang/Lex/Lexer.h"
18
#include "llvm/ADT/SmallString.h"
19
#include "llvm/Support/ErrorHandling.h"
20
#include "llvm/Support/raw_ostream.h"
21
#include <algorithm>
22
using namespace clang;
23
24
TextDiagnosticPrinter::TextDiagnosticPrinter(raw_ostream &os,
25
                                             DiagnosticOptions *diags,
26
                                             bool _OwnsOutputStream)
27
  : OS(os), DiagOpts(diags),
28
132k
    OwnsOutputStream(_OwnsOutputStream) {
29
132k
}
30
31
123k
TextDiagnosticPrinter::~TextDiagnosticPrinter() {
32
123k
  if (OwnsOutputStream)
33
0
    delete &OS;
34
123k
}
35
36
void TextDiagnosticPrinter::BeginSourceFile(const LangOptions &LO,
37
80.7k
                                            const Preprocessor *PP) {
38
  // Build the TextDiagnostic utility.
39
80.7k
  TextDiag.reset(new TextDiagnostic(OS, LO, &*DiagOpts));
40
80.7k
}
41
42
75.0k
void TextDiagnosticPrinter::EndSourceFile() {
43
75.0k
  TextDiag.reset();
44
75.0k
}
45
46
/// Print any diagnostic option information to a raw_ostream.
47
///
48
/// This implements all of the logic for adding diagnostic options to a message
49
/// (via OS). Each relevant option is comma separated and all are enclosed in
50
/// the standard bracketing: " [...]".
51
static void printDiagnosticOptions(raw_ostream &OS,
52
                                   DiagnosticsEngine::Level Level,
53
                                   const Diagnostic &Info,
54
31.9k
                                   const DiagnosticOptions &DiagOpts) {
55
31.9k
  bool Started = false;
56
31.9k
  if (DiagOpts.ShowOptionNames) {
57
    // Handle special cases for non-warnings early.
58
29.1k
    if (Info.getID() == diag::fatal_too_many_errors) {
59
7
      OS << " [-ferror-limit=]";
60
7
      return;
61
7
    }
62
29.1k
63
    // The code below is somewhat fragile because we are essentially trying to
64
    // report to the user what happened by inferring what the diagnostic engine
65
    // did. Eventually it might make more sense to have the diagnostic engine
66
    // include some "why" information in the diagnostic.
67
29.1k
68
    // If this is a warning which has been mapped to an error by the user (as
69
    // inferred by checking whether the default mapping is to an error) then
70
    // flag it as such. Note that diagnostics could also have been mapped by a
71
    // pragma, but we don't currently have a way to distinguish this.
72
29.1k
    if (Level == DiagnosticsEngine::Error &&
73
5.93k
        DiagnosticIDs::isBuiltinWarningOrExtension(Info.getID()) &&
74
223
        !DiagnosticIDs::isDefaultMappingAsError(Info.getID())) {
75
177
      OS << " [-Werror";
76
177
      Started = true;
77
177
    }
78
29.1k
79
29.1k
    StringRef Opt = DiagnosticIDs::getWarningOptionForDiag(Info.getID());
80
29.1k
    if (!Opt.empty()) {
81
10.9k
      OS << (Started ? 
","175
: " [")
82
10.8k
         << (Level == DiagnosticsEngine::Remark ? 
"-R"219
: "-W") << Opt;
83
11.0k
      StringRef OptValue = Info.getDiags()->getFlagValue();
84
11.0k
      if (!OptValue.empty())
85
27
        OS << "=" << OptValue;
86
11.0k
      Started = true;
87
11.0k
    }
88
29.1k
  }
89
31.9k
90
  // If the user wants to see category information, include it too.
91
31.9k
  if (DiagOpts.ShowCategories) {
92
9
    unsigned DiagCategory =
93
9
      DiagnosticIDs::getCategoryNumberForDiag(Info.getID());
94
9
    if (DiagCategory) {
95
8
      OS << (Started ? 
","1
: " [");
96
9
      Started = true;
97
9
      if (DiagOpts.ShowCategories == 1)
98
3
        OS << DiagCategory;
99
6
      else {
100
6
        assert(DiagOpts.ShowCategories == 2 && "Invalid ShowCategories value");
101
6
        OS << DiagnosticIDs::getCategoryNameFromID(DiagCategory);
102
6
      }
103
9
    }
104
9
  }
105
31.9k
  if (Started)
106
11.1k
    OS << ']';
107
31.9k
}
108
109
void TextDiagnosticPrinter::HandleDiagnostic(DiagnosticsEngine::Level Level,
110
31.9k
                                             const Diagnostic &Info) {
111
  // Default implementation (Warnings/errors count).
112
31.9k
  DiagnosticConsumer::HandleDiagnostic(Level, Info);
113
31.9k
114
  // Render the diagnostic message into a temporary buffer eagerly. We'll use
115
  // this later as we print out the diagnostic to the terminal.
116
31.9k
  SmallString<100> OutStr;
117
31.9k
  Info.FormatDiagnostic(OutStr);
118
31.9k
119
31.9k
  llvm::raw_svector_ostream DiagMessageStream(OutStr);
120
31.9k
  printDiagnosticOptions(DiagMessageStream, Level, Info, *DiagOpts);
121
31.9k
122
  // Keeps track of the starting position of the location
123
  // information (e.g., "foo.c:10:4:") that precedes the error
124
  // message. We use this information to determine how long the
125
  // file+line+column number prefix is.
126
31.9k
  uint64_t StartOfLocationInfo = OS.tell();
127
31.9k
128
31.9k
  if (!Prefix.empty())
129
4.24k
    OS << Prefix << ": ";
130
31.9k
131
  // Use a dedicated, simpler path for diagnostics without a valid location.
132
  // This is important as if the location is missing, we may be emitting
133
  // diagnostics in a context that lacks language options, a source manager, or
134
  // other infrastructure necessary when emitting more rich diagnostics.
135
31.9k
  if (!Info.getLocation().isValid()) {
136
6.75k
    TextDiagnostic::printDiagnosticLevel(OS, Level, DiagOpts->ShowColors,
137
6.75k
                                         DiagOpts->CLFallbackMode);
138
6.75k
    TextDiagnostic::printDiagnosticMessage(OS, Level, DiagMessageStream.str(),
139
6.75k
                                           OS.tell() - StartOfLocationInfo,
140
6.75k
                                           DiagOpts->MessageLength,
141
6.75k
                                           DiagOpts->ShowColors);
142
6.75k
    OS.flush();
143
6.75k
    return;
144
6.75k
  }
145
25.2k
146
  // Assert that the rest of our infrastructure is setup properly.
147
25.2k
  assert(DiagOpts && "Unexpected diagnostic without options set");
148
25.2k
  assert(Info.hasSourceManager() &&
149
25.2k
         "Unexpected diagnostic with no source manager");
150
25.2k
  assert(TextDiag && "Unexpected diagnostic outside source file processing");
151
25.2k
152
25.2k
  TextDiag->emitDiagnostic(
153
25.2k
      FullSourceLoc(Info.getLocation(), Info.getSourceManager()), Level,
154
25.2k
      DiagMessageStream.str(), Info.getRanges(), Info.getFixItHints());
155
25.2k
156
25.2k
  OS.flush();
157
25.2k
}