Coverage Report

Created: 2019-07-24 05:18

/Users/buildslave/jenkins/workspace/clang-stage2-coverage-R/llvm/tools/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
75.7k
    OwnsOutputStream(_OwnsOutputStream) {
29
75.7k
}
30
31
61.3k
TextDiagnosticPrinter::~TextDiagnosticPrinter() {
32
61.3k
  if (OwnsOutputStream)
33
0
    delete &OS;
34
61.3k
}
35
36
void TextDiagnosticPrinter::BeginSourceFile(const LangOptions &LO,
37
46.8k
                                            const Preprocessor *PP) {
38
46.8k
  // Build the TextDiagnostic utility.
39
46.8k
  TextDiag.reset(new TextDiagnostic(OS, LO, &*DiagOpts));
40
46.8k
}
41
42
44.3k
void TextDiagnosticPrinter::EndSourceFile() {
43
44.3k
  TextDiag.reset();
44
44.3k
}
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
28.9k
                                   const DiagnosticOptions &DiagOpts) {
55
28.9k
  bool Started = false;
56
28.9k
  if (DiagOpts.ShowOptionNames) {
57
9.34k
    // Handle special cases for non-warnings early.
58
9.34k
    if (Info.getID() == diag::fatal_too_many_errors) {
59
21
      OS << " [-ferror-limit=]";
60
21
      return;
61
21
    }
62
9.32k
63
9.32k
    // The code below is somewhat fragile because we are essentially trying to
64
9.32k
    // report to the user what happened by inferring what the diagnostic engine
65
9.32k
    // did. Eventually it might make more sense to have the diagnostic engine
66
9.32k
    // include some "why" information in the diagnostic.
67
9.32k
68
9.32k
    // If this is a warning which has been mapped to an error by the user (as
69
9.32k
    // inferred by checking whether the default mapping is to an error) then
70
9.32k
    // flag it as such. Note that diagnostics could also have been mapped by a
71
9.32k
    // pragma, but we don't currently have a way to distinguish this.
72
9.32k
    if (Level == DiagnosticsEngine::Error &&
73
9.32k
        
DiagnosticIDs::isBuiltinWarningOrExtension(Info.getID())2.20k
&&
74
9.32k
        
!DiagnosticIDs::isDefaultMappingAsError(Info.getID())155
) {
75
150
      OS << " [-Werror";
76
150
      Started = true;
77
150
    }
78
9.32k
79
9.32k
    StringRef Opt = DiagnosticIDs::getWarningOptionForDiag(Info.getID());
80
9.32k
    if (!Opt.empty()) {
81
5.50k
      OS << (Started ? 
","150
:
" ["5.35k
)
82
5.50k
         << (Level == DiagnosticsEngine::Remark ? 
"-R"3
:
"-W"5.49k
) << Opt;
83
5.50k
      StringRef OptValue = Info.getDiags()->getFlagValue();
84
5.50k
      if (!OptValue.empty())
85
4
        OS << "=" << OptValue;
86
5.50k
      Started = true;
87
5.50k
    }
88
9.32k
  }
89
28.9k
90
28.9k
  // If the user wants to see category information, include it too.
91
28.9k
  
if (28.9k
DiagOpts.ShowCategories28.9k
) {
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
6
        OS << DiagnosticIDs::getCategoryNameFromID(DiagCategory);
102
6
      }
103
9
    }
104
9
  }
105
28.9k
  if (Started)
106
5.50k
    OS << ']';
107
28.9k
}
108
109
void TextDiagnosticPrinter::HandleDiagnostic(DiagnosticsEngine::Level Level,
110
28.9k
                                             const Diagnostic &Info) {
111
28.9k
  // Default implementation (Warnings/errors count).
112
28.9k
  DiagnosticConsumer::HandleDiagnostic(Level, Info);
113
28.9k
114
28.9k
  // Render the diagnostic message into a temporary buffer eagerly. We'll use
115
28.9k
  // this later as we print out the diagnostic to the terminal.
116
28.9k
  SmallString<100> OutStr;
117
28.9k
  Info.FormatDiagnostic(OutStr);
118
28.9k
119
28.9k
  llvm::raw_svector_ostream DiagMessageStream(OutStr);
120
28.9k
  printDiagnosticOptions(DiagMessageStream, Level, Info, *DiagOpts);
121
28.9k
122
28.9k
  // Keeps track of the starting position of the location
123
28.9k
  // information (e.g., "foo.c:10:4:") that precedes the error
124
28.9k
  // message. We use this information to determine how long the
125
28.9k
  // file+line+column number prefix is.
126
28.9k
  uint64_t StartOfLocationInfo = OS.tell();
127
28.9k
128
28.9k
  if (!Prefix.empty())
129
7.56k
    OS << Prefix << ": ";
130
28.9k
131
28.9k
  // Use a dedicated, simpler path for diagnostics without a valid location.
132
28.9k
  // This is important as if the location is missing, we may be emitting
133
28.9k
  // diagnostics in a context that lacks language options, a source manager, or
134
28.9k
  // other infrastructure necessary when emitting more rich diagnostics.
135
28.9k
  if (!Info.getLocation().isValid()) {
136
8.26k
    TextDiagnostic::printDiagnosticLevel(OS, Level, DiagOpts->ShowColors,
137
8.26k
                                         DiagOpts->CLFallbackMode);
138
8.26k
    TextDiagnostic::printDiagnosticMessage(OS, Level, DiagMessageStream.str(),
139
8.26k
                                           OS.tell() - StartOfLocationInfo,
140
8.26k
                                           DiagOpts->MessageLength,
141
8.26k
                                           DiagOpts->ShowColors);
142
8.26k
    OS.flush();
143
8.26k
    return;
144
8.26k
  }
145
20.7k
146
20.7k
  // Assert that the rest of our infrastructure is setup properly.
147
20.7k
  assert(DiagOpts && "Unexpected diagnostic without options set");
148
20.7k
  assert(Info.hasSourceManager() &&
149
20.7k
         "Unexpected diagnostic with no source manager");
150
20.7k
  assert(TextDiag && "Unexpected diagnostic outside source file processing");
151
20.7k
152
20.7k
  TextDiag->emitDiagnostic(
153
20.7k
      FullSourceLoc(Info.getLocation(), Info.getSourceManager()), Level,
154
20.7k
      DiagMessageStream.str(), Info.getRanges(), Info.getFixItHints());
155
20.7k
156
20.7k
  OS.flush();
157
20.7k
}