Coverage Report

Created: 2021-08-24 07:12

/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
161k
    OwnsOutputStream(_OwnsOutputStream) {
29
161k
}
30
31
155k
TextDiagnosticPrinter::~TextDiagnosticPrinter() {
32
155k
  if (OwnsOutputStream)
33
0
    delete &OS;
34
155k
}
35
36
void TextDiagnosticPrinter::BeginSourceFile(const LangOptions &LO,
37
97.1k
                                            const Preprocessor *PP) {
38
  // Build the TextDiagnostic utility.
39
97.1k
  TextDiag.reset(new TextDiagnostic(OS, LO, &*DiagOpts));
40
97.1k
}
41
42
91.0k
void TextDiagnosticPrinter::EndSourceFile() {
43
91.0k
  TextDiag.reset();
44
91.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
40.1k
                                   const DiagnosticOptions &DiagOpts) {
55
40.1k
  bool Started = false;
56
40.1k
  if (DiagOpts.ShowOptionNames) {
57
    // Handle special cases for non-warnings early.
58
28.6k
    if (Info.getID() == diag::fatal_too_many_errors) {
59
8
      OS << " [-ferror-limit=]";
60
8
      return;
61
8
    }
62
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
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
28.6k
    if (Level == DiagnosticsEngine::Error &&
73
28.6k
        
DiagnosticIDs::isBuiltinWarningOrExtension(Info.getID())6.33k
&&
74
28.6k
        
!DiagnosticIDs::isDefaultMappingAsError(Info.getID())233
) {
75
186
      OS << " [-Werror";
76
186
      Started = true;
77
186
    }
78
79
28.6k
    StringRef Opt = DiagnosticIDs::getWarningOptionForDiag(Info.getID());
80
28.6k
    if (!Opt.empty()) {
81
11.4k
      OS << (Started ? 
","184
:
" ["11.3k
)
82
11.4k
         << (Level == DiagnosticsEngine::Remark ? 
"-R"231
:
"-W"11.2k
) << Opt;
83
11.4k
      StringRef OptValue = Info.getDiags()->getFlagValue();
84
11.4k
      if (!OptValue.empty())
85
39
        OS << "=" << OptValue;
86
11.4k
      Started = true;
87
11.4k
    }
88
28.6k
  }
89
90
  // If the user wants to see category information, include it too.
91
40.1k
  if (DiagOpts.ShowCategories) {
92
9
    unsigned DiagCategory =
93
9
      DiagnosticIDs::getCategoryNumberForDiag(Info.getID());
94
9
    if (DiagCategory) {
95
9
      OS << (Started ? 
","1
:
" ["8
);
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
0
        OS << DiagnosticIDs::getCategoryNameFromID(DiagCategory);
102
6
      }
103
9
    }
104
9
  }
105
40.1k
  if (Started)
106
11.5k
    OS << ']';
107
40.1k
}
108
109
void TextDiagnosticPrinter::HandleDiagnostic(DiagnosticsEngine::Level Level,
110
40.1k
                                             const Diagnostic &Info) {
111
  // Default implementation (Warnings/errors count).
112
40.1k
  DiagnosticConsumer::HandleDiagnostic(Level, Info);
113
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
40.1k
  SmallString<100> OutStr;
117
40.1k
  Info.FormatDiagnostic(OutStr);
118
119
40.1k
  llvm::raw_svector_ostream DiagMessageStream(OutStr);
120
40.1k
  printDiagnosticOptions(DiagMessageStream, Level, Info, *DiagOpts);
121
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
40.1k
  uint64_t StartOfLocationInfo = OS.tell();
127
128
40.1k
  if (!Prefix.empty())
129
5.14k
    OS << Prefix << ": ";
130
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
40.1k
  if (!Info.getLocation().isValid()) {
136
8.06k
    TextDiagnostic::printDiagnosticLevel(OS, Level, DiagOpts->ShowColors);
137
8.06k
    TextDiagnostic::printDiagnosticMessage(
138
8.06k
        OS, /*IsSupplemental=*/Level == DiagnosticsEngine::Note,
139
8.06k
        DiagMessageStream.str(), OS.tell() - StartOfLocationInfo,
140
8.06k
        DiagOpts->MessageLength, DiagOpts->ShowColors);
141
8.06k
    OS.flush();
142
8.06k
    return;
143
8.06k
  }
144
145
  // Assert that the rest of our infrastructure is setup properly.
146
32.0k
  assert(DiagOpts && "Unexpected diagnostic without options set");
147
0
  assert(Info.hasSourceManager() &&
148
32.0k
         "Unexpected diagnostic with no source manager");
149
0
  assert(TextDiag && "Unexpected diagnostic outside source file processing");
150
151
0
  TextDiag->emitDiagnostic(
152
32.0k
      FullSourceLoc(Info.getLocation(), Info.getSourceManager()), Level,
153
32.0k
      DiagMessageStream.str(), Info.getRanges(), Info.getFixItHints());
154
155
32.0k
  OS.flush();
156
32.0k
}