blob: fe62c2a50442741fbbea36143347081ba0100ee7 [file] [log] [blame]
Ted Kremenekc4bbd852011-12-17 05:26:04 +00001//===--- DiagnosticRenderer.cpp - Diagnostic Pretty-Printing --------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
10#include "clang/Frontend/DiagnosticRenderer.h"
Douglas Gregor811db4e2012-10-23 22:26:28 +000011#include "clang/Basic/DiagnosticOptions.h"
Ted Kremenekc4bbd852011-12-17 05:26:04 +000012#include "clang/Basic/FileManager.h"
13#include "clang/Basic/SourceManager.h"
Ted Kremenekf7639e12012-03-06 20:06:33 +000014#include "clang/Edit/Commit.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000015#include "clang/Edit/EditedSource.h"
Ted Kremenekf7639e12012-03-06 20:06:33 +000016#include "clang/Edit/EditsReceiver.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000017#include "clang/Lex/Lexer.h"
Eli Friedman34ff0ea2012-11-03 03:36:51 +000018#include "llvm/ADT/SmallSet.h"
Ted Kremenekc4bbd852011-12-17 05:26:04 +000019#include "llvm/ADT/SmallString.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000020#include "llvm/Support/ErrorHandling.h"
21#include "llvm/Support/MemoryBuffer.h"
22#include "llvm/Support/raw_ostream.h"
Ted Kremenekc4bbd852011-12-17 05:26:04 +000023#include <algorithm>
24using namespace clang;
25
Argyrios Kyrtzidisabff5f12012-01-23 16:58:33 +000026/// \brief Retrieve the name of the immediate macro expansion.
27///
28/// This routine starts from a source location, and finds the name of the macro
29/// responsible for its immediate expansion. It looks through any intervening
30/// macro argument expansions to compute this. It returns a StringRef which
31/// refers to the SourceManager-owned buffer of the source where that macro
32/// name is spelled. Thus, the result shouldn't out-live that SourceManager.
33///
34/// This differs from Lexer::getImmediateMacroName in that any macro argument
35/// location will result in the topmost function macro that accepted it.
36/// e.g.
37/// \code
38/// MAC1( MAC2(foo) )
39/// \endcode
40/// for location of 'foo' token, this function will return "MAC1" while
41/// Lexer::getImmediateMacroName will return "MAC2".
42static StringRef getImmediateMacroName(SourceLocation Loc,
43 const SourceManager &SM,
44 const LangOptions &LangOpts) {
45 assert(Loc.isMacroID() && "Only reasonble to call this on macros");
46 // Walk past macro argument expanions.
47 while (SM.isMacroArgExpansion(Loc))
48 Loc = SM.getImmediateExpansionRange(Loc).first;
49
Richard Smithf89e2e22012-12-05 11:04:55 +000050 // If the macro's spelling has no FileID, then it's actually a token paste
51 // or stringization (or similar) and not a macro at all.
52 if (!SM.getFileEntryForID(SM.getFileID(SM.getSpellingLoc(Loc))))
53 return StringRef();
54
Argyrios Kyrtzidisabff5f12012-01-23 16:58:33 +000055 // Find the spelling location of the start of the non-argument expansion
56 // range. This is where the macro name was spelled in order to begin
57 // expanding this macro.
58 Loc = SM.getSpellingLoc(SM.getImmediateExpansionRange(Loc).first);
59
60 // Dig out the buffer where the macro name was spelled and the extents of the
61 // name so that we can render it into the expansion note.
62 std::pair<FileID, unsigned> ExpansionInfo = SM.getDecomposedLoc(Loc);
63 unsigned MacroTokenLength = Lexer::MeasureTokenLength(Loc, SM, LangOpts);
64 StringRef ExpansionBuffer = SM.getBufferData(ExpansionInfo.first);
65 return ExpansionBuffer.substr(ExpansionInfo.second, MacroTokenLength);
66}
67
Argyrios Kyrtzidisb16ff5d2012-05-10 05:03:45 +000068DiagnosticRenderer::DiagnosticRenderer(const LangOptions &LangOpts,
Douglas Gregor811db4e2012-10-23 22:26:28 +000069 DiagnosticOptions *DiagOpts)
70 : LangOpts(LangOpts), DiagOpts(DiagOpts), LastLevel() {}
Ted Kremenekc4bbd852011-12-17 05:26:04 +000071
72DiagnosticRenderer::~DiagnosticRenderer() {}
73
Ted Kremenekf7639e12012-03-06 20:06:33 +000074namespace {
75
76class FixitReceiver : public edit::EditsReceiver {
77 SmallVectorImpl<FixItHint> &MergedFixits;
78
79public:
80 FixitReceiver(SmallVectorImpl<FixItHint> &MergedFixits)
81 : MergedFixits(MergedFixits) { }
Craig Topperafa7cb32014-03-13 06:07:04 +000082 void insert(SourceLocation loc, StringRef text) override {
Ted Kremenekf7639e12012-03-06 20:06:33 +000083 MergedFixits.push_back(FixItHint::CreateInsertion(loc, text));
84 }
Craig Topperafa7cb32014-03-13 06:07:04 +000085 void replace(CharSourceRange range, StringRef text) override {
Ted Kremenekf7639e12012-03-06 20:06:33 +000086 MergedFixits.push_back(FixItHint::CreateReplacement(range, text));
87 }
88};
89
Alexander Kornienkoab9db512015-06-22 23:07:51 +000090}
Ted Kremenekf7639e12012-03-06 20:06:33 +000091
92static void mergeFixits(ArrayRef<FixItHint> FixItHints,
93 const SourceManager &SM, const LangOptions &LangOpts,
94 SmallVectorImpl<FixItHint> &MergedFixits) {
95 edit::Commit commit(SM, LangOpts);
96 for (ArrayRef<FixItHint>::const_iterator
97 I = FixItHints.begin(), E = FixItHints.end(); I != E; ++I) {
98 const FixItHint &Hint = *I;
99 if (Hint.CodeToInsert.empty()) {
100 if (Hint.InsertFromRange.isValid())
101 commit.insertFromRange(Hint.RemoveRange.getBegin(),
102 Hint.InsertFromRange, /*afterToken=*/false,
103 Hint.BeforePreviousInsertions);
104 else
105 commit.remove(Hint.RemoveRange);
106 } else {
107 if (Hint.RemoveRange.isTokenRange() ||
108 Hint.RemoveRange.getBegin() != Hint.RemoveRange.getEnd())
109 commit.replace(Hint.RemoveRange, Hint.CodeToInsert);
110 else
111 commit.insert(Hint.RemoveRange.getBegin(), Hint.CodeToInsert,
112 /*afterToken=*/false, Hint.BeforePreviousInsertions);
113 }
114 }
115
116 edit::EditedSource Editor(SM, LangOpts);
117 if (Editor.commit(commit)) {
118 FixitReceiver Rec(MergedFixits);
119 Editor.applyRewrites(Rec);
120 }
121}
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000122
123void DiagnosticRenderer::emitDiagnostic(SourceLocation Loc,
124 DiagnosticsEngine::Level Level,
125 StringRef Message,
126 ArrayRef<CharSourceRange> Ranges,
127 ArrayRef<FixItHint> FixItHints,
Argyrios Kyrtzidisb16ff5d2012-05-10 05:03:45 +0000128 const SourceManager *SM,
Ted Kremenek0964cca2012-02-14 02:46:00 +0000129 DiagOrStoredDiag D) {
Argyrios Kyrtzidisb16ff5d2012-05-10 05:03:45 +0000130 assert(SM || Loc.isInvalid());
Richard Smithc01cca22012-12-05 09:47:49 +0000131
Ted Kremenek0964cca2012-02-14 02:46:00 +0000132 beginDiagnostic(D, Level);
Richard Smithc01cca22012-12-05 09:47:49 +0000133
134 if (!Loc.isValid())
135 // If we have no source location, just emit the diagnostic message.
136 emitDiagnosticMessage(Loc, PresumedLoc(), Level, Message, Ranges, SM, D);
137 else {
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000138 // Get the ranges into a local array we can hack on.
139 SmallVector<CharSourceRange, 20> MutableRanges(Ranges.begin(),
140 Ranges.end());
Richard Smithc01cca22012-12-05 09:47:49 +0000141
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000142 SmallVector<FixItHint, 8> MergedFixits;
Ted Kremenekf7639e12012-03-06 20:06:33 +0000143 if (!FixItHints.empty()) {
Argyrios Kyrtzidisb16ff5d2012-05-10 05:03:45 +0000144 mergeFixits(FixItHints, *SM, LangOpts, MergedFixits);
Ted Kremenekf7639e12012-03-06 20:06:33 +0000145 FixItHints = MergedFixits;
146 }
147
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000148 for (ArrayRef<FixItHint>::const_iterator I = FixItHints.begin(),
149 E = FixItHints.end();
150 I != E; ++I)
151 if (I->RemoveRange.isValid())
152 MutableRanges.push_back(I->RemoveRange);
Richard Smithaebee682012-12-05 06:20:58 +0000153
Richard Smithc01cca22012-12-05 09:47:49 +0000154 SourceLocation UnexpandedLoc = Loc;
Richard Smithaebee682012-12-05 06:20:58 +0000155
Ted Kremenek372735f2012-12-19 01:16:49 +0000156 // Find the ultimate expansion location for the diagnostic.
157 Loc = SM->getFileLoc(Loc);
Richard Smithc01cca22012-12-05 09:47:49 +0000158
159 PresumedLoc PLoc = SM->getPresumedLoc(Loc, DiagOpts->ShowPresumedLoc);
160
161 // First, if this diagnostic is not in the main file, print out the
162 // "included from" lines.
163 emitIncludeStack(Loc, PLoc, Level, *SM);
164
165 // Next, emit the actual diagnostic message and caret.
166 emitDiagnosticMessage(Loc, PLoc, Level, Message, Ranges, SM, D);
167 emitCaret(Loc, Level, MutableRanges, FixItHints, *SM);
168
169 // If this location is within a macro, walk from UnexpandedLoc up to Loc
170 // and produce a macro backtrace.
171 if (UnexpandedLoc.isValid() && UnexpandedLoc.isMacroID()) {
Richard Trieu97c45b62015-07-28 20:53:46 +0000172 emitMacroExpansions(UnexpandedLoc, Level, MutableRanges, FixItHints, *SM);
Richard Smithaebee682012-12-05 06:20:58 +0000173 }
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000174 }
Richard Smithc01cca22012-12-05 09:47:49 +0000175
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000176 LastLoc = Loc;
177 LastLevel = Level;
Richard Smithc01cca22012-12-05 09:47:49 +0000178
Ted Kremenek0964cca2012-02-14 02:46:00 +0000179 endDiagnostic(D, Level);
180}
181
182
183void DiagnosticRenderer::emitStoredDiagnostic(StoredDiagnostic &Diag) {
184 emitDiagnostic(Diag.getLocation(), Diag.getLevel(), Diag.getMessage(),
185 Diag.getRanges(), Diag.getFixIts(),
Argyrios Kyrtzidisb16ff5d2012-05-10 05:03:45 +0000186 Diag.getLocation().isValid() ? &Diag.getLocation().getManager()
Craig Topper49a27902014-05-22 04:46:25 +0000187 : nullptr,
Ted Kremenek0964cca2012-02-14 02:46:00 +0000188 &Diag);
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000189}
190
Alp Toker4db87ab2014-06-21 23:31:59 +0000191void DiagnosticRenderer::emitBasicNote(StringRef Message) {
192 emitDiagnosticMessage(
193 SourceLocation(), PresumedLoc(), DiagnosticsEngine::Note, Message,
Craig Topper5fc8fc22014-08-27 06:28:36 +0000194 None, nullptr, DiagOrStoredDiag());
Alp Toker4db87ab2014-06-21 23:31:59 +0000195}
196
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000197/// \brief Prints an include stack when appropriate for a particular
198/// diagnostic level and location.
199///
200/// This routine handles all the logic of suppressing particular include
201/// stacks (such as those for notes) and duplicate include stacks when
202/// repeated warnings occur within the same file. It also handles the logic
203/// of customizing the formatting and display of the include stack.
204///
Douglas Gregor22103e32012-11-30 21:58:49 +0000205/// \param Loc The diagnostic location.
206/// \param PLoc The presumed location of the diagnostic location.
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000207/// \param Level The diagnostic level of the message this stack pertains to.
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000208void DiagnosticRenderer::emitIncludeStack(SourceLocation Loc,
Douglas Gregor22103e32012-11-30 21:58:49 +0000209 PresumedLoc PLoc,
Argyrios Kyrtzidisb16ff5d2012-05-10 05:03:45 +0000210 DiagnosticsEngine::Level Level,
211 const SourceManager &SM) {
Douglas Gregor22103e32012-11-30 21:58:49 +0000212 SourceLocation IncludeLoc = PLoc.getIncludeLoc();
213
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000214 // Skip redundant include stacks altogether.
Douglas Gregor22103e32012-11-30 21:58:49 +0000215 if (LastIncludeLoc == IncludeLoc)
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000216 return;
Douglas Gregor22103e32012-11-30 21:58:49 +0000217
218 LastIncludeLoc = IncludeLoc;
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000219
Douglas Gregor811db4e2012-10-23 22:26:28 +0000220 if (!DiagOpts->ShowNoteIncludeStack && Level == DiagnosticsEngine::Note)
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000221 return;
Douglas Gregor22103e32012-11-30 21:58:49 +0000222
223 if (IncludeLoc.isValid())
224 emitIncludeStackRecursively(IncludeLoc, SM);
225 else {
Douglas Gregor63365432012-11-30 22:11:57 +0000226 emitModuleBuildStack(SM);
Douglas Gregor22103e32012-11-30 21:58:49 +0000227 emitImportStack(Loc, SM);
228 }
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000229}
230
231/// \brief Helper to recursivly walk up the include stack and print each layer
232/// on the way back down.
Argyrios Kyrtzidisb16ff5d2012-05-10 05:03:45 +0000233void DiagnosticRenderer::emitIncludeStackRecursively(SourceLocation Loc,
234 const SourceManager &SM) {
Douglas Gregoraf8f0262012-11-30 18:38:50 +0000235 if (Loc.isInvalid()) {
Douglas Gregor63365432012-11-30 22:11:57 +0000236 emitModuleBuildStack(SM);
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000237 return;
Douglas Gregoraf8f0262012-11-30 18:38:50 +0000238 }
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000239
Richard Smith0b50cb72012-11-14 23:55:25 +0000240 PresumedLoc PLoc = SM.getPresumedLoc(Loc, DiagOpts->ShowPresumedLoc);
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000241 if (PLoc.isInvalid())
242 return;
Douglas Gregor22103e32012-11-30 21:58:49 +0000243
244 // If this source location was imported from a module, print the module
245 // import stack rather than the
246 // FIXME: We want submodule granularity here.
247 std::pair<SourceLocation, StringRef> Imported = SM.getModuleImportLoc(Loc);
248 if (Imported.first.isValid()) {
249 // This location was imported by a module. Emit the module import stack.
250 emitImportStackRecursively(Imported.first, Imported.second, SM);
251 return;
252 }
253
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000254 // Emit the other include frames first.
Argyrios Kyrtzidisb16ff5d2012-05-10 05:03:45 +0000255 emitIncludeStackRecursively(PLoc.getIncludeLoc(), SM);
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000256
257 // Emit the inclusion text/note.
Argyrios Kyrtzidisb16ff5d2012-05-10 05:03:45 +0000258 emitIncludeLocation(Loc, PLoc, SM);
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000259}
260
Douglas Gregor22103e32012-11-30 21:58:49 +0000261/// \brief Emit the module import stack associated with the current location.
262void DiagnosticRenderer::emitImportStack(SourceLocation Loc,
263 const SourceManager &SM) {
264 if (Loc.isInvalid()) {
Douglas Gregor63365432012-11-30 22:11:57 +0000265 emitModuleBuildStack(SM);
Douglas Gregor22103e32012-11-30 21:58:49 +0000266 return;
267 }
268
269 std::pair<SourceLocation, StringRef> NextImportLoc
270 = SM.getModuleImportLoc(Loc);
271 emitImportStackRecursively(NextImportLoc.first, NextImportLoc.second, SM);
272}
273
274/// \brief Helper to recursivly walk up the import stack and print each layer
275/// on the way back down.
276void DiagnosticRenderer::emitImportStackRecursively(SourceLocation Loc,
277 StringRef ModuleName,
278 const SourceManager &SM) {
279 if (Loc.isInvalid()) {
280 return;
281 }
282
283 PresumedLoc PLoc = SM.getPresumedLoc(Loc, DiagOpts->ShowPresumedLoc);
284 if (PLoc.isInvalid())
285 return;
286
287 // Emit the other import frames first.
288 std::pair<SourceLocation, StringRef> NextImportLoc
289 = SM.getModuleImportLoc(Loc);
290 emitImportStackRecursively(NextImportLoc.first, NextImportLoc.second, SM);
291
292 // Emit the inclusion text/note.
293 emitImportLocation(Loc, PLoc, ModuleName, SM);
294}
295
Douglas Gregor63365432012-11-30 22:11:57 +0000296/// \brief Emit the module build stack, for cases where a module is (re-)built
Douglas Gregoraf8f0262012-11-30 18:38:50 +0000297/// on demand.
Douglas Gregor63365432012-11-30 22:11:57 +0000298void DiagnosticRenderer::emitModuleBuildStack(const SourceManager &SM) {
299 ModuleBuildStack Stack = SM.getModuleBuildStack();
300 for (unsigned I = 0, N = Stack.size(); I != N; ++I) {
301 const SourceManager &CurSM = Stack[I].second.getManager();
302 SourceLocation CurLoc = Stack[I].second;
Douglas Gregoraf8f0262012-11-30 18:38:50 +0000303 emitBuildingModuleLocation(CurLoc,
304 CurSM.getPresumedLoc(CurLoc,
305 DiagOpts->ShowPresumedLoc),
Douglas Gregor63365432012-11-30 22:11:57 +0000306 Stack[I].first,
Douglas Gregoraf8f0262012-11-30 18:38:50 +0000307 CurSM);
308 }
309}
310
Eli Friedman34ff0ea2012-11-03 03:36:51 +0000311// Helper function to fix up source ranges. It takes in an array of ranges,
312// and outputs an array of ranges where we want to draw the range highlighting
313// around the location specified by CaretLoc.
314//
315// To find locations which correspond to the caret, we crawl the macro caller
316// chain for the beginning and end of each range. If the caret location
317// is in a macro expansion, we search each chain for a location
318// in the same expansion as the caret; otherwise, we crawl to the top of
319// each chain. Two locations are part of the same macro expansion
320// iff the FileID is the same.
321static void mapDiagnosticRanges(
322 SourceLocation CaretLoc,
Richard Smithaebee682012-12-05 06:20:58 +0000323 ArrayRef<CharSourceRange> Ranges,
Richard Smithc01cca22012-12-05 09:47:49 +0000324 SmallVectorImpl<CharSourceRange> &SpellingRanges,
Eli Friedman34ff0ea2012-11-03 03:36:51 +0000325 const SourceManager *SM) {
326 FileID CaretLocFileID = SM->getFileID(CaretLoc);
327
Richard Smithaebee682012-12-05 06:20:58 +0000328 for (ArrayRef<CharSourceRange>::const_iterator I = Ranges.begin(),
Eli Friedman34ff0ea2012-11-03 03:36:51 +0000329 E = Ranges.end();
330 I != E; ++I) {
331 SourceLocation Begin = I->getBegin(), End = I->getEnd();
332 bool IsTokenRange = I->isTokenRange();
333
Eli Friedmandea98de2012-11-30 06:19:40 +0000334 FileID BeginFileID = SM->getFileID(Begin);
Nadav Rotemb8937342012-12-13 19:58:10 +0000335 FileID EndFileID = SM->getFileID(End);
Eli Friedmandea98de2012-11-30 06:19:40 +0000336
Nadav Rotemb8937342012-12-13 19:58:10 +0000337 // Find the common parent for the beginning and end of the range.
338
339 // First, crawl the expansion chain for the beginning of the range.
340 llvm::SmallDenseMap<FileID, SourceLocation> BeginLocsMap;
341 while (Begin.isMacroID() && BeginFileID != EndFileID) {
342 BeginLocsMap[BeginFileID] = Begin;
343 Begin = SM->getImmediateExpansionRange(Begin).first;
344 BeginFileID = SM->getFileID(Begin);
345 }
346
347 // Then, crawl the expansion chain for the end of the range.
348 if (BeginFileID != EndFileID) {
349 while (End.isMacroID() && !BeginLocsMap.count(EndFileID)) {
Eli Friedman34ff0ea2012-11-03 03:36:51 +0000350 End = SM->getImmediateExpansionRange(End).second;
Nadav Rotemb8937342012-12-13 19:58:10 +0000351 EndFileID = SM->getFileID(End);
352 }
353 if (End.isMacroID()) {
354 Begin = BeginLocsMap[EndFileID];
355 BeginFileID = EndFileID;
Eli Friedman34ff0ea2012-11-03 03:36:51 +0000356 }
Eli Friedmancdb135a2012-12-13 00:14:59 +0000357 }
358
Nadav Rotemb8937342012-12-13 19:58:10 +0000359 while (Begin.isMacroID() && BeginFileID != CaretLocFileID) {
360 if (SM->isMacroArgExpansion(Begin)) {
361 Begin = SM->getImmediateSpellingLoc(Begin);
362 End = SM->getImmediateSpellingLoc(End);
363 } else {
364 Begin = SM->getImmediateExpansionRange(Begin).first;
365 End = SM->getImmediateExpansionRange(End).second;
366 }
367 BeginFileID = SM->getFileID(Begin);
Eli Friedman672845b2012-12-18 00:52:36 +0000368 if (BeginFileID != SM->getFileID(End)) {
369 // FIXME: Ugly hack to stop a crash; this code is making bad
370 // assumptions and it's too complicated for me to reason
371 // about.
372 Begin = End = SourceLocation();
373 break;
374 }
Eli Friedman34ff0ea2012-11-03 03:36:51 +0000375 }
376
377 // Return the spelling location of the beginning and end of the range.
378 Begin = SM->getSpellingLoc(Begin);
379 End = SM->getSpellingLoc(End);
380 SpellingRanges.push_back(CharSourceRange(SourceRange(Begin, End),
381 IsTokenRange));
382 }
383}
384
Richard Smithaebee682012-12-05 06:20:58 +0000385void DiagnosticRenderer::emitCaret(SourceLocation Loc,
386 DiagnosticsEngine::Level Level,
387 ArrayRef<CharSourceRange> Ranges,
388 ArrayRef<FixItHint> Hints,
389 const SourceManager &SM) {
390 SmallVector<CharSourceRange, 4> SpellingRanges;
391 mapDiagnosticRanges(Loc, Ranges, SpellingRanges, &SM);
392 emitCodeContext(Loc, Level, SpellingRanges, Hints, SM);
393}
394
Richard Trieu97c45b62015-07-28 20:53:46 +0000395/// \brief A helper function for emitMacroExpansion to print the
396/// macro expansion message
397void DiagnosticRenderer::emitSingleMacroExpansion(
398 SourceLocation Loc,
399 DiagnosticsEngine::Level Level,
400 ArrayRef<CharSourceRange> Ranges,
401 const SourceManager &SM) {
Richard Smith7a2d40d2012-12-05 03:18:16 +0000402 // Find the spelling location for the macro definition. We must use the
Richard Trieu97c45b62015-07-28 20:53:46 +0000403 // spelling location here to avoid emitting a macro backtrace for the note.
Richard Smith7a2d40d2012-12-05 03:18:16 +0000404 SourceLocation SpellingLoc = Loc;
Richard Trieu97c45b62015-07-28 20:53:46 +0000405
Richard Smith7a2d40d2012-12-05 03:18:16 +0000406 // If this is the expansion of a macro argument, point the caret at the
407 // use of the argument in the definition of the macro, not the expansion.
408 if (SM.isMacroArgExpansion(Loc))
409 SpellingLoc = SM.getImmediateExpansionRange(Loc).first;
410 SpellingLoc = SM.getSpellingLoc(SpellingLoc);
411
412 // Map the ranges into the FileID of the diagnostic location.
Eli Friedman34ff0ea2012-11-03 03:36:51 +0000413 SmallVector<CharSourceRange, 4> SpellingRanges;
Richard Smith7a2d40d2012-12-05 03:18:16 +0000414 mapDiagnosticRanges(Loc, Ranges, SpellingRanges, &SM);
Eli Friedman34ff0ea2012-11-03 03:36:51 +0000415
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000416 SmallString<100> MessageStorage;
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000417 llvm::raw_svector_ostream Message(MessageStorage);
Richard Smithf89e2e22012-12-05 11:04:55 +0000418 StringRef MacroName = getImmediateMacroName(Loc, SM, LangOpts);
419 if (MacroName.empty())
420 Message << "expanded from here";
421 else
422 Message << "expanded from macro '" << MacroName << "'";
Richard Trieu97c45b62015-07-28 20:53:46 +0000423
Dmitri Gribenko44ebbd52013-05-05 00:41:58 +0000424 emitDiagnostic(SpellingLoc, DiagnosticsEngine::Note, Message.str(),
425 SpellingRanges, None, &SM);
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000426}
427
Richard Trieu97c45b62015-07-28 20:53:46 +0000428/// \brief Recursively emit notes for each macro expansion and caret
429/// diagnostics where appropriate.
430///
431/// Walks up the macro expansion stack printing expansion notes, the code
432/// snippet, caret, underlines and FixItHint display as appropriate at each
433/// level.
434///
435/// \param Loc The location for this caret.
436/// \param Level The diagnostic level currently being emitted.
437/// \param Ranges The underlined ranges for this code snippet.
438/// \param Hints The FixIt hints active for this diagnostic.
439void DiagnosticRenderer::emitMacroExpansions(SourceLocation Loc,
440 DiagnosticsEngine::Level Level,
441 ArrayRef<CharSourceRange> Ranges,
442 ArrayRef<FixItHint> Hints,
443 const SourceManager &SM) {
444 assert(!Loc.isInvalid() && "must have a valid source location here");
445
446 // Produce a stack of macro backtraces.
447 SmallVector<SourceLocation, 8> LocationStack;
448 while (Loc.isMacroID()) {
449 LocationStack.push_back(Loc);
450 Loc = SM.getImmediateMacroCallerLoc(Loc);
451 assert(!Loc.isInvalid() && "must have a valid source location here");
452 }
453
454 unsigned MacroDepth = LocationStack.size();
455 unsigned MacroLimit = DiagOpts->MacroBacktraceLimit;
456 if (MacroDepth <= MacroLimit || MacroLimit == 0) {
457 for (auto I = LocationStack.rbegin(), E = LocationStack.rend();
458 I != E; ++I)
459 emitSingleMacroExpansion(*I, Level, Ranges, SM);
460 return;
461 }
462
463 unsigned MacroStartMessages = MacroLimit / 2;
464 unsigned MacroEndMessages = MacroLimit / 2 + MacroLimit % 2;
465
466 for (auto I = LocationStack.rbegin(),
467 E = LocationStack.rbegin() + MacroStartMessages;
468 I != E; ++I)
469 emitSingleMacroExpansion(*I, Level, Ranges, SM);
470
471 SmallString<200> MessageStorage;
472 llvm::raw_svector_ostream Message(MessageStorage);
473 Message << "(skipping " << (MacroDepth - MacroLimit)
474 << " expansions in backtrace; use -fmacro-backtrace-limit=0 to "
475 "see all)";
476 emitBasicNote(Message.str());
477
478 for (auto I = LocationStack.rend() - MacroEndMessages,
479 E = LocationStack.rend();
480 I != E; ++I)
481 emitSingleMacroExpansion(*I, Level, Ranges, SM);
482}
483
Ted Kremenek0964cca2012-02-14 02:46:00 +0000484DiagnosticNoteRenderer::~DiagnosticNoteRenderer() {}
485
486void DiagnosticNoteRenderer::emitIncludeLocation(SourceLocation Loc,
Argyrios Kyrtzidisb16ff5d2012-05-10 05:03:45 +0000487 PresumedLoc PLoc,
488 const SourceManager &SM) {
Ted Kremenek0964cca2012-02-14 02:46:00 +0000489 // Generate a note indicating the include location.
490 SmallString<200> MessageStorage;
491 llvm::raw_svector_ostream Message(MessageStorage);
492 Message << "in file included from " << PLoc.getFilename() << ':'
493 << PLoc.getLine() << ":";
Argyrios Kyrtzidisb16ff5d2012-05-10 05:03:45 +0000494 emitNote(Loc, Message.str(), &SM);
Ted Kremenek0964cca2012-02-14 02:46:00 +0000495}
496
Douglas Gregor22103e32012-11-30 21:58:49 +0000497void DiagnosticNoteRenderer::emitImportLocation(SourceLocation Loc,
498 PresumedLoc PLoc,
499 StringRef ModuleName,
500 const SourceManager &SM) {
501 // Generate a note indicating the include location.
502 SmallString<200> MessageStorage;
503 llvm::raw_svector_ostream Message(MessageStorage);
504 Message << "in module '" << ModuleName << "' imported from "
505 << PLoc.getFilename() << ':' << PLoc.getLine() << ":";
506 emitNote(Loc, Message.str(), &SM);
507}
508
Douglas Gregoraf8f0262012-11-30 18:38:50 +0000509void
510DiagnosticNoteRenderer::emitBuildingModuleLocation(SourceLocation Loc,
511 PresumedLoc PLoc,
512 StringRef ModuleName,
513 const SourceManager &SM) {
514 // Generate a note indicating the include location.
515 SmallString<200> MessageStorage;
516 llvm::raw_svector_ostream Message(MessageStorage);
Richard Smith7bea1d42014-03-05 20:55:36 +0000517 if (PLoc.getFilename())
518 Message << "while building module '" << ModuleName << "' imported from "
519 << PLoc.getFilename() << ':' << PLoc.getLine() << ":";
520 else
Jordan Rose6dcdaa62014-07-26 01:22:02 +0000521 Message << "while building module '" << ModuleName << "':";
Douglas Gregoraf8f0262012-11-30 18:38:50 +0000522 emitNote(Loc, Message.str(), &SM);
523}