blob: b5d0bcb0cb02c3d71e203b5390b07cfdc9baa2f9 [file] [log] [blame]
Reid Spencer5f016e22007-07-11 17:01:13 +00001//===--- TextDiagnosticPrinter.cpp - Diagnostic Printer -------------------===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner0bc735f2007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Reid Spencer5f016e22007-07-11 17:01:13 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This diagnostic client prints out their diagnostic messages.
11//
12//===----------------------------------------------------------------------===//
13
Daniel Dunbare1bd4e62009-03-02 06:16:29 +000014#include "clang/Frontend/TextDiagnosticPrinter.h"
Axel Naumann04331162011-01-27 10:55:51 +000015#include "clang/Basic/FileManager.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000016#include "clang/Basic/SourceManager.h"
Daniel Dunbareace8742009-11-04 06:24:30 +000017#include "clang/Frontend/DiagnosticOptions.h"
Chandler Carruthdb463bb2011-10-15 23:43:53 +000018#include "clang/Frontend/TextDiagnostic.h"
Reid Spencer5f016e22007-07-11 17:01:13 +000019#include "clang/Lex/Lexer.h"
Chris Lattner037fb7f2009-05-05 22:03:18 +000020#include "llvm/Support/MemoryBuffer.h"
Chris Lattnera03a5b52008-11-19 06:56:25 +000021#include "llvm/Support/raw_ostream.h"
David Blaikie548f6c82011-09-23 05:57:42 +000022#include "llvm/Support/ErrorHandling.h"
Chris Lattnerf4c83962008-11-19 06:51:40 +000023#include "llvm/ADT/SmallString.h"
Douglas Gregor4b2d3f72009-02-26 21:00:50 +000024#include <algorithm>
Reid Spencer5f016e22007-07-11 17:01:13 +000025using namespace clang;
26
Chris Lattner5f9e2722011-07-23 10:55:15 +000027TextDiagnosticPrinter::TextDiagnosticPrinter(raw_ostream &os,
Daniel Dunbaraea36412009-11-11 09:38:24 +000028 const DiagnosticOptions &diags,
29 bool _OwnsOutputStream)
Chandler Carruth21a869a2011-10-16 02:57:39 +000030 : OS(os), LangOpts(0), DiagOpts(&diags), SM(0),
Daniel Dunbaraea36412009-11-11 09:38:24 +000031 OwnsOutputStream(_OwnsOutputStream) {
32}
33
34TextDiagnosticPrinter::~TextDiagnosticPrinter() {
35 if (OwnsOutputStream)
36 delete &OS;
Daniel Dunbareace8742009-11-04 06:24:30 +000037}
38
Chandler Carruth21a869a2011-10-16 02:57:39 +000039void TextDiagnosticPrinter::BeginSourceFile(const LangOptions &LO,
40 const Preprocessor *PP) {
41 LangOpts = &LO;
42}
43
44void TextDiagnosticPrinter::EndSourceFile() {
45 LangOpts = 0;
46 TextDiag.reset(0);
47}
48
Chandler Carrutha3ba6bb2011-09-26 01:30:09 +000049/// \brief Print the diagnostic name to a raw_ostream.
50///
51/// This prints the diagnostic name to a raw_ostream if it has one. It formats
52/// the name according to the expected diagnostic message formatting:
53/// " [diagnostic_name_here]"
54static void printDiagnosticName(raw_ostream &OS, const Diagnostic &Info) {
Chandler Carruth76145782011-09-26 00:37:30 +000055 if (!DiagnosticIDs::isBuiltinNote(Info.getID()))
56 OS << " [" << DiagnosticIDs::getName(Info.getID()) << "]";
57}
58
Chandler Carrutha3ba6bb2011-09-26 01:30:09 +000059/// \brief Print any diagnostic option information to a raw_ostream.
60///
61/// This implements all of the logic for adding diagnostic options to a message
62/// (via OS). Each relevant option is comma separated and all are enclosed in
63/// the standard bracketing: " [...]".
64static void printDiagnosticOptions(raw_ostream &OS,
Chandler Carruth53a529e2011-09-26 00:44:09 +000065 DiagnosticsEngine::Level Level,
David Blaikie40847cf2011-09-26 01:18:08 +000066 const Diagnostic &Info,
Chandler Carruth53a529e2011-09-26 00:44:09 +000067 const DiagnosticOptions &DiagOpts) {
Chandler Carruth253d41d2011-09-26 01:21:58 +000068 bool Started = false;
Chandler Carruth53a529e2011-09-26 00:44:09 +000069 if (DiagOpts.ShowOptionNames) {
Chandler Carruth253d41d2011-09-26 01:21:58 +000070 // Handle special cases for non-warnings early.
71 if (Info.getID() == diag::fatal_too_many_errors) {
72 OS << " [-ferror-limit=]";
73 return;
74 }
75
Daniel Dunbar76101cf2011-09-29 01:01:08 +000076 // The code below is somewhat fragile because we are essentially trying to
77 // report to the user what happened by inferring what the diagnostic engine
78 // did. Eventually it might make more sense to have the diagnostic engine
79 // include some "why" information in the diagnostic.
80
81 // If this is a warning which has been mapped to an error by the user (as
82 // inferred by checking whether the default mapping is to an error) then
83 // flag it as such. Note that diagnostics could also have been mapped by a
84 // pragma, but we don't currently have a way to distinguish this.
Chandler Carruth53a529e2011-09-26 00:44:09 +000085 if (Level == DiagnosticsEngine::Error &&
Daniel Dunbar76101cf2011-09-29 01:01:08 +000086 DiagnosticIDs::isBuiltinWarningOrExtension(Info.getID()) &&
87 !DiagnosticIDs::isDefaultMappingAsError(Info.getID())) {
88 OS << " [-Werror";
89 Started = true;
Chandler Carruth253d41d2011-09-26 01:21:58 +000090 }
91
92 // If the diagnostic is an extension diagnostic and not enabled by default
93 // then it must have been turned on with -pedantic.
94 bool EnabledByDefault;
95 if (DiagnosticIDs::isBuiltinExtensionDiag(Info.getID(),
96 EnabledByDefault) &&
97 !EnabledByDefault) {
98 OS << (Started ? "," : " [") << "-pedantic";
99 Started = true;
Chandler Carruth53a529e2011-09-26 00:44:09 +0000100 }
101
102 StringRef Opt = DiagnosticIDs::getWarningOptionForDiag(Info.getID());
103 if (!Opt.empty()) {
Chandler Carruth253d41d2011-09-26 01:21:58 +0000104 OS << (Started ? "," : " [") << "-W" << Opt;
105 Started = true;
Chandler Carruth53a529e2011-09-26 00:44:09 +0000106 }
107 }
Chandler Carruth53a529e2011-09-26 00:44:09 +0000108
Chandler Carruth253d41d2011-09-26 01:21:58 +0000109 // If the user wants to see category information, include it too.
110 if (DiagOpts.ShowCategories) {
111 unsigned DiagCategory =
112 DiagnosticIDs::getCategoryNumberForDiag(Info.getID());
Chandler Carruth53a529e2011-09-26 00:44:09 +0000113 if (DiagCategory) {
Chandler Carruth253d41d2011-09-26 01:21:58 +0000114 OS << (Started ? "," : " [");
Benjamin Kramera65cb0c2011-09-26 02:14:13 +0000115 Started = true;
Chandler Carruth53a529e2011-09-26 00:44:09 +0000116 if (DiagOpts.ShowCategories == 1)
Benjamin Kramera65cb0c2011-09-26 02:14:13 +0000117 OS << DiagCategory;
Chandler Carruth53a529e2011-09-26 00:44:09 +0000118 else {
119 assert(DiagOpts.ShowCategories == 2 && "Invalid ShowCategories value");
120 OS << DiagnosticIDs::getCategoryNameFromID(DiagCategory);
121 }
122 }
Chandler Carruth53a529e2011-09-26 00:44:09 +0000123 }
Benjamin Kramera65cb0c2011-09-26 02:14:13 +0000124 if (Started)
125 OS << ']';
Chandler Carruth53a529e2011-09-26 00:44:09 +0000126}
127
Chandler Carrutha6290042011-09-26 00:26:47 +0000128void TextDiagnosticPrinter::HandleDiagnostic(DiagnosticsEngine::Level Level,
David Blaikie40847cf2011-09-26 01:18:08 +0000129 const Diagnostic &Info) {
Chandler Carrutha6290042011-09-26 00:26:47 +0000130 // Default implementation (Warnings/errors count).
131 DiagnosticConsumer::HandleDiagnostic(Level, Info);
132
Chandler Carruth0ef89882011-09-26 11:25:30 +0000133 // Render the diagnostic message into a temporary buffer eagerly. We'll use
134 // this later as we print out the diagnostic to the terminal.
135 llvm::SmallString<100> OutStr;
136 Info.FormatDiagnostic(OutStr);
137
138 llvm::raw_svector_ostream DiagMessageStream(OutStr);
139 if (DiagOpts->ShowNames)
140 printDiagnosticName(DiagMessageStream, Info);
141 printDiagnosticOptions(DiagMessageStream, Level, Info, *DiagOpts);
142
Chandler Carrutha6290042011-09-26 00:26:47 +0000143 // Keeps track of the the starting position of the location
144 // information (e.g., "foo.c:10:4:") that precedes the error
145 // message. We use this information to determine how long the
146 // file+line+column number prefix is.
147 uint64_t StartOfLocationInfo = OS.tell();
148
149 if (!Prefix.empty())
150 OS << Prefix << ": ";
151
Chandler Carruth0ef89882011-09-26 11:25:30 +0000152 // Use a dedicated, simpler path for diagnostics without a valid location.
Chandler Carruthe6d1dff2011-09-26 11:38:46 +0000153 // This is important as if the location is missing, we may be emitting
154 // diagnostics in a context that lacks language options, a source manager, or
155 // other infrastructure necessary when emitting more rich diagnostics.
Chandler Carruth0ef89882011-09-26 11:25:30 +0000156 if (!Info.getLocation().isValid()) {
Chandler Carruth7eb84dc2011-10-15 22:49:21 +0000157 TextDiagnostic::printDiagnosticLevel(OS, Level, DiagOpts->ShowColors);
Chandler Carruth1f3839e2011-10-15 22:57:29 +0000158 TextDiagnostic::printDiagnosticMessage(OS, Level, DiagMessageStream.str(),
159 OS.tell() - StartOfLocationInfo,
160 DiagOpts->MessageLength,
161 DiagOpts->ShowColors);
Chandler Carruth0ef89882011-09-26 11:25:30 +0000162 OS.flush();
163 return;
Chandler Carrutha6290042011-09-26 00:26:47 +0000164 }
165
Chandler Carruthe6d1dff2011-09-26 11:38:46 +0000166 // Assert that the rest of our infrastructure is setup properly.
167 assert(LangOpts && "Unexpected diagnostic outside source file processing");
168 assert(DiagOpts && "Unexpected diagnostic without options set");
169 assert(Info.hasSourceManager() &&
170 "Unexpected diagnostic with no source manager");
Chandler Carruthe6d1dff2011-09-26 11:38:46 +0000171
Chandler Carruth21a869a2011-10-16 02:57:39 +0000172 // Rebuild the TextDiagnostic utility if missing or the source manager has
173 // changed.
174 if (!TextDiag || SM != &Info.getSourceManager()) {
175 SM = &Info.getSourceManager();
176 TextDiag.reset(new TextDiagnostic(OS, *SM, *LangOpts, *DiagOpts));
177 }
Chandler Carruth0ef89882011-09-26 11:25:30 +0000178
Chandler Carruth21a869a2011-10-16 02:57:39 +0000179 TextDiag->emitDiagnostic(Info.getLocation(), Level, DiagMessageStream.str(),
180 Info.getRanges(),
181 llvm::makeArrayRef(Info.getFixItHints(),
182 Info.getNumFixItHints()));
Daniel Dunbarcbff0dc2009-09-07 23:07:56 +0000183
Chris Lattnera03a5b52008-11-19 06:56:25 +0000184 OS.flush();
Reid Spencer5f016e22007-07-11 17:01:13 +0000185}
Douglas Gregoraee526e2011-09-29 00:38:00 +0000186
187DiagnosticConsumer *
188TextDiagnosticPrinter::clone(DiagnosticsEngine &Diags) const {
189 return new TextDiagnosticPrinter(OS, *DiagOpts, /*OwnsOutputStream=*/false);
190}