blob: 757ceec7ec9d01c178c65c770960f8b0aceca916 [file] [log] [blame]
Eugene Zelenko4f233182018-03-22 00:53:26 +00001//===- DiagnosticRenderer.cpp - Diagnostic Pretty-Printing ----------------===//
Ted Kremenekc4bbd852011-12-17 05:26:04 +00002//
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"
Eugene Zelenko4f233182018-03-22 00:53:26 +000011#include "clang/Basic/Diagnostic.h"
Douglas Gregor811db4e2012-10-23 22:26:28 +000012#include "clang/Basic/DiagnosticOptions.h"
Eugene Zelenko4f233182018-03-22 00:53:26 +000013#include "clang/Basic/LLVM.h"
14#include "clang/Basic/SourceLocation.h"
Ted Kremenekc4bbd852011-12-17 05:26:04 +000015#include "clang/Basic/SourceManager.h"
Ted Kremenekf7639e12012-03-06 20:06:33 +000016#include "clang/Edit/Commit.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000017#include "clang/Edit/EditedSource.h"
Ted Kremenekf7639e12012-03-06 20:06:33 +000018#include "clang/Edit/EditsReceiver.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000019#include "clang/Lex/Lexer.h"
Eugene Zelenko4f233182018-03-22 00:53:26 +000020#include "llvm/ADT/ArrayRef.h"
21#include "llvm/ADT/DenseMap.h"
22#include "llvm/ADT/None.h"
Ted Kremenekc4bbd852011-12-17 05:26:04 +000023#include "llvm/ADT/SmallString.h"
Eugene Zelenko4f233182018-03-22 00:53:26 +000024#include "llvm/ADT/SmallVector.h"
25#include "llvm/ADT/StringRef.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000026#include "llvm/Support/raw_ostream.h"
Ted Kremenekc4bbd852011-12-17 05:26:04 +000027#include <algorithm>
Eugene Zelenko4f233182018-03-22 00:53:26 +000028#include <cassert>
29#include <iterator>
30#include <utility>
31
Ted Kremenekc4bbd852011-12-17 05:26:04 +000032using namespace clang;
33
Argyrios Kyrtzidisb16ff5d2012-05-10 05:03:45 +000034DiagnosticRenderer::DiagnosticRenderer(const LangOptions &LangOpts,
Douglas Gregor811db4e2012-10-23 22:26:28 +000035 DiagnosticOptions *DiagOpts)
Eugene Zelenko4f233182018-03-22 00:53:26 +000036 : LangOpts(LangOpts), DiagOpts(DiagOpts), LastLevel() {}
Ted Kremenekc4bbd852011-12-17 05:26:04 +000037
Eugene Zelenko4f233182018-03-22 00:53:26 +000038DiagnosticRenderer::~DiagnosticRenderer() = default;
Ted Kremenekc4bbd852011-12-17 05:26:04 +000039
Ted Kremenekf7639e12012-03-06 20:06:33 +000040namespace {
41
42class FixitReceiver : public edit::EditsReceiver {
43 SmallVectorImpl<FixItHint> &MergedFixits;
44
45public:
46 FixitReceiver(SmallVectorImpl<FixItHint> &MergedFixits)
Eugene Zelenko4f233182018-03-22 00:53:26 +000047 : MergedFixits(MergedFixits) {}
48
Craig Topperafa7cb32014-03-13 06:07:04 +000049 void insert(SourceLocation loc, StringRef text) override {
Ted Kremenekf7639e12012-03-06 20:06:33 +000050 MergedFixits.push_back(FixItHint::CreateInsertion(loc, text));
51 }
Eugene Zelenko4f233182018-03-22 00:53:26 +000052
Craig Topperafa7cb32014-03-13 06:07:04 +000053 void replace(CharSourceRange range, StringRef text) override {
Ted Kremenekf7639e12012-03-06 20:06:33 +000054 MergedFixits.push_back(FixItHint::CreateReplacement(range, text));
55 }
56};
57
Eugene Zelenko4f233182018-03-22 00:53:26 +000058} // namespace
Ted Kremenekf7639e12012-03-06 20:06:33 +000059
60static void mergeFixits(ArrayRef<FixItHint> FixItHints,
61 const SourceManager &SM, const LangOptions &LangOpts,
62 SmallVectorImpl<FixItHint> &MergedFixits) {
63 edit::Commit commit(SM, LangOpts);
Eugene Zelenko4f233182018-03-22 00:53:26 +000064 for (const auto &Hint : FixItHints)
Ted Kremenekf7639e12012-03-06 20:06:33 +000065 if (Hint.CodeToInsert.empty()) {
66 if (Hint.InsertFromRange.isValid())
67 commit.insertFromRange(Hint.RemoveRange.getBegin(),
68 Hint.InsertFromRange, /*afterToken=*/false,
69 Hint.BeforePreviousInsertions);
70 else
71 commit.remove(Hint.RemoveRange);
72 } else {
73 if (Hint.RemoveRange.isTokenRange() ||
74 Hint.RemoveRange.getBegin() != Hint.RemoveRange.getEnd())
75 commit.replace(Hint.RemoveRange, Hint.CodeToInsert);
76 else
77 commit.insert(Hint.RemoveRange.getBegin(), Hint.CodeToInsert,
78 /*afterToken=*/false, Hint.BeforePreviousInsertions);
79 }
Ted Kremenekf7639e12012-03-06 20:06:33 +000080
81 edit::EditedSource Editor(SM, LangOpts);
82 if (Editor.commit(commit)) {
83 FixitReceiver Rec(MergedFixits);
84 Editor.applyRewrites(Rec);
85 }
86}
Ted Kremenekc4bbd852011-12-17 05:26:04 +000087
Christof Doumafb4a0452017-06-27 09:50:38 +000088void DiagnosticRenderer::emitDiagnostic(FullSourceLoc Loc,
Ted Kremenekc4bbd852011-12-17 05:26:04 +000089 DiagnosticsEngine::Level Level,
90 StringRef Message,
91 ArrayRef<CharSourceRange> Ranges,
92 ArrayRef<FixItHint> FixItHints,
Ted Kremenek0964cca2012-02-14 02:46:00 +000093 DiagOrStoredDiag D) {
Christof Doumafb4a0452017-06-27 09:50:38 +000094 assert(Loc.hasManager() || Loc.isInvalid());
Richard Smithc01cca22012-12-05 09:47:49 +000095
Ted Kremenek0964cca2012-02-14 02:46:00 +000096 beginDiagnostic(D, Level);
Richard Smithc01cca22012-12-05 09:47:49 +000097
98 if (!Loc.isValid())
99 // If we have no source location, just emit the diagnostic message.
Christof Doumafb4a0452017-06-27 09:50:38 +0000100 emitDiagnosticMessage(Loc, PresumedLoc(), Level, Message, Ranges, D);
Richard Smithc01cca22012-12-05 09:47:49 +0000101 else {
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000102 // Get the ranges into a local array we can hack on.
103 SmallVector<CharSourceRange, 20> MutableRanges(Ranges.begin(),
104 Ranges.end());
Richard Smithc01cca22012-12-05 09:47:49 +0000105
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000106 SmallVector<FixItHint, 8> MergedFixits;
Ted Kremenekf7639e12012-03-06 20:06:33 +0000107 if (!FixItHints.empty()) {
Christof Doumafb4a0452017-06-27 09:50:38 +0000108 mergeFixits(FixItHints, Loc.getManager(), LangOpts, MergedFixits);
Ted Kremenekf7639e12012-03-06 20:06:33 +0000109 FixItHints = MergedFixits;
110 }
111
Eugene Zelenko4f233182018-03-22 00:53:26 +0000112 for (const auto &Hint : FixItHints)
113 if (Hint.RemoveRange.isValid())
114 MutableRanges.push_back(Hint.RemoveRange);
Richard Smithaebee682012-12-05 06:20:58 +0000115
Christof Doumafb4a0452017-06-27 09:50:38 +0000116 FullSourceLoc UnexpandedLoc = Loc;
Richard Smithaebee682012-12-05 06:20:58 +0000117
Ted Kremenek372735f2012-12-19 01:16:49 +0000118 // Find the ultimate expansion location for the diagnostic.
Christof Doumafb4a0452017-06-27 09:50:38 +0000119 Loc = Loc.getFileLoc();
Richard Smithc01cca22012-12-05 09:47:49 +0000120
Christof Doumafb4a0452017-06-27 09:50:38 +0000121 PresumedLoc PLoc = Loc.getPresumedLoc(DiagOpts->ShowPresumedLoc);
Richard Smithc01cca22012-12-05 09:47:49 +0000122
123 // First, if this diagnostic is not in the main file, print out the
124 // "included from" lines.
Christof Doumafb4a0452017-06-27 09:50:38 +0000125 emitIncludeStack(Loc, PLoc, Level);
Richard Smithc01cca22012-12-05 09:47:49 +0000126
127 // Next, emit the actual diagnostic message and caret.
Christof Doumafb4a0452017-06-27 09:50:38 +0000128 emitDiagnosticMessage(Loc, PLoc, Level, Message, Ranges, D);
129 emitCaret(Loc, Level, MutableRanges, FixItHints);
Richard Smithc01cca22012-12-05 09:47:49 +0000130
131 // If this location is within a macro, walk from UnexpandedLoc up to Loc
132 // and produce a macro backtrace.
133 if (UnexpandedLoc.isValid() && UnexpandedLoc.isMacroID()) {
Christof Doumafb4a0452017-06-27 09:50:38 +0000134 emitMacroExpansions(UnexpandedLoc, Level, MutableRanges, FixItHints);
Richard Smithaebee682012-12-05 06:20:58 +0000135 }
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000136 }
Richard Smithc01cca22012-12-05 09:47:49 +0000137
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000138 LastLoc = Loc;
139 LastLevel = Level;
Richard Smithc01cca22012-12-05 09:47:49 +0000140
Ted Kremenek0964cca2012-02-14 02:46:00 +0000141 endDiagnostic(D, Level);
142}
143
Ted Kremenek0964cca2012-02-14 02:46:00 +0000144void DiagnosticRenderer::emitStoredDiagnostic(StoredDiagnostic &Diag) {
145 emitDiagnostic(Diag.getLocation(), Diag.getLevel(), Diag.getMessage(),
146 Diag.getRanges(), Diag.getFixIts(),
147 &Diag);
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000148}
149
Alp Toker4db87ab2014-06-21 23:31:59 +0000150void DiagnosticRenderer::emitBasicNote(StringRef Message) {
Christof Doumafb4a0452017-06-27 09:50:38 +0000151 emitDiagnosticMessage(FullSourceLoc(), PresumedLoc(), DiagnosticsEngine::Note,
152 Message, None, DiagOrStoredDiag());
Alp Toker4db87ab2014-06-21 23:31:59 +0000153}
154
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000155/// Prints an include stack when appropriate for a particular
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000156/// diagnostic level and location.
157///
158/// This routine handles all the logic of suppressing particular include
159/// stacks (such as those for notes) and duplicate include stacks when
160/// repeated warnings occur within the same file. It also handles the logic
161/// of customizing the formatting and display of the include stack.
162///
Douglas Gregor22103e32012-11-30 21:58:49 +0000163/// \param Loc The diagnostic location.
164/// \param PLoc The presumed location of the diagnostic location.
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000165/// \param Level The diagnostic level of the message this stack pertains to.
Christof Doumafb4a0452017-06-27 09:50:38 +0000166void DiagnosticRenderer::emitIncludeStack(FullSourceLoc Loc, PresumedLoc PLoc,
167 DiagnosticsEngine::Level Level) {
168 FullSourceLoc IncludeLoc =
169 PLoc.isInvalid() ? FullSourceLoc()
170 : FullSourceLoc(PLoc.getIncludeLoc(), Loc.getManager());
Douglas Gregor22103e32012-11-30 21:58:49 +0000171
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000172 // Skip redundant include stacks altogether.
Douglas Gregor22103e32012-11-30 21:58:49 +0000173 if (LastIncludeLoc == IncludeLoc)
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000174 return;
Fangrui Song6907ce22018-07-30 19:24:48 +0000175
Douglas Gregor22103e32012-11-30 21:58:49 +0000176 LastIncludeLoc = IncludeLoc;
Fangrui Song6907ce22018-07-30 19:24:48 +0000177
Douglas Gregor811db4e2012-10-23 22:26:28 +0000178 if (!DiagOpts->ShowNoteIncludeStack && Level == DiagnosticsEngine::Note)
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000179 return;
Douglas Gregor22103e32012-11-30 21:58:49 +0000180
181 if (IncludeLoc.isValid())
Christof Doumafb4a0452017-06-27 09:50:38 +0000182 emitIncludeStackRecursively(IncludeLoc);
Douglas Gregor22103e32012-11-30 21:58:49 +0000183 else {
Christof Doumafb4a0452017-06-27 09:50:38 +0000184 emitModuleBuildStack(Loc.getManager());
185 emitImportStack(Loc);
Douglas Gregor22103e32012-11-30 21:58:49 +0000186 }
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000187}
188
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000189/// Helper to recursively walk up the include stack and print each layer
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000190/// on the way back down.
Christof Doumafb4a0452017-06-27 09:50:38 +0000191void DiagnosticRenderer::emitIncludeStackRecursively(FullSourceLoc Loc) {
Douglas Gregoraf8f0262012-11-30 18:38:50 +0000192 if (Loc.isInvalid()) {
Christof Doumafb4a0452017-06-27 09:50:38 +0000193 emitModuleBuildStack(Loc.getManager());
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000194 return;
Douglas Gregoraf8f0262012-11-30 18:38:50 +0000195 }
Christof Doumafb4a0452017-06-27 09:50:38 +0000196
197 PresumedLoc PLoc = Loc.getPresumedLoc(DiagOpts->ShowPresumedLoc);
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000198 if (PLoc.isInvalid())
199 return;
Douglas Gregor22103e32012-11-30 21:58:49 +0000200
201 // If this source location was imported from a module, print the module
Fangrui Song6907ce22018-07-30 19:24:48 +0000202 // import stack rather than the
Douglas Gregor22103e32012-11-30 21:58:49 +0000203 // FIXME: We want submodule granularity here.
Christof Doumafb4a0452017-06-27 09:50:38 +0000204 std::pair<FullSourceLoc, StringRef> Imported = Loc.getModuleImportLoc();
Richard Smitha24ff552015-08-11 00:05:21 +0000205 if (!Imported.second.empty()) {
Douglas Gregor22103e32012-11-30 21:58:49 +0000206 // This location was imported by a module. Emit the module import stack.
Christof Doumafb4a0452017-06-27 09:50:38 +0000207 emitImportStackRecursively(Imported.first, Imported.second);
Douglas Gregor22103e32012-11-30 21:58:49 +0000208 return;
209 }
210
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000211 // Emit the other include frames first.
Christof Doumafb4a0452017-06-27 09:50:38 +0000212 emitIncludeStackRecursively(
213 FullSourceLoc(PLoc.getIncludeLoc(), Loc.getManager()));
214
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000215 // Emit the inclusion text/note.
Christof Doumafb4a0452017-06-27 09:50:38 +0000216 emitIncludeLocation(Loc, PLoc);
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000217}
218
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000219/// Emit the module import stack associated with the current location.
Christof Doumafb4a0452017-06-27 09:50:38 +0000220void DiagnosticRenderer::emitImportStack(FullSourceLoc Loc) {
Douglas Gregor22103e32012-11-30 21:58:49 +0000221 if (Loc.isInvalid()) {
Christof Doumafb4a0452017-06-27 09:50:38 +0000222 emitModuleBuildStack(Loc.getManager());
Douglas Gregor22103e32012-11-30 21:58:49 +0000223 return;
224 }
225
Christof Doumafb4a0452017-06-27 09:50:38 +0000226 std::pair<FullSourceLoc, StringRef> NextImportLoc = Loc.getModuleImportLoc();
227 emitImportStackRecursively(NextImportLoc.first, NextImportLoc.second);
Douglas Gregor22103e32012-11-30 21:58:49 +0000228}
229
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000230/// Helper to recursively walk up the import stack and print each layer
Douglas Gregor22103e32012-11-30 21:58:49 +0000231/// on the way back down.
Christof Doumafb4a0452017-06-27 09:50:38 +0000232void DiagnosticRenderer::emitImportStackRecursively(FullSourceLoc Loc,
233 StringRef ModuleName) {
Richard Smitha24ff552015-08-11 00:05:21 +0000234 if (ModuleName.empty()) {
Douglas Gregor22103e32012-11-30 21:58:49 +0000235 return;
236 }
237
Christof Doumafb4a0452017-06-27 09:50:38 +0000238 PresumedLoc PLoc = Loc.getPresumedLoc(DiagOpts->ShowPresumedLoc);
Douglas Gregor22103e32012-11-30 21:58:49 +0000239
240 // Emit the other import frames first.
Christof Doumafb4a0452017-06-27 09:50:38 +0000241 std::pair<FullSourceLoc, StringRef> NextImportLoc = Loc.getModuleImportLoc();
242 emitImportStackRecursively(NextImportLoc.first, NextImportLoc.second);
Douglas Gregor22103e32012-11-30 21:58:49 +0000243
244 // Emit the inclusion text/note.
Christof Doumafb4a0452017-06-27 09:50:38 +0000245 emitImportLocation(Loc, PLoc, ModuleName);
Douglas Gregor22103e32012-11-30 21:58:49 +0000246}
247
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000248/// Emit the module build stack, for cases where a module is (re-)built
Douglas Gregoraf8f0262012-11-30 18:38:50 +0000249/// on demand.
Douglas Gregor63365432012-11-30 22:11:57 +0000250void DiagnosticRenderer::emitModuleBuildStack(const SourceManager &SM) {
251 ModuleBuildStack Stack = SM.getModuleBuildStack();
Eugene Zelenko4f233182018-03-22 00:53:26 +0000252 for (const auto &I : Stack) {
253 emitBuildingModuleLocation(I.second, I.second.getPresumedLoc(
254 DiagOpts->ShowPresumedLoc),
255 I.first);
Douglas Gregoraf8f0262012-11-30 18:38:50 +0000256 }
257}
258
Richard Trieuc3096242015-09-24 01:21:01 +0000259/// A recursive function to trace all possible backtrace locations
260/// to match the \p CaretLocFileID.
Reid Klecknerda30cff2015-12-08 01:08:09 +0000261static SourceLocation
262retrieveMacroLocation(SourceLocation Loc, FileID MacroFileID,
263 FileID CaretFileID,
264 const SmallVectorImpl<FileID> &CommonArgExpansions,
Richard Smithb5f81712018-04-30 05:25:48 +0000265 bool IsBegin, const SourceManager *SM,
266 bool &IsTokenRange) {
Reid Klecknerda30cff2015-12-08 01:08:09 +0000267 assert(SM->getFileID(Loc) == MacroFileID);
268 if (MacroFileID == CaretFileID)
269 return Loc;
270 if (!Loc.isMacroID())
Eugene Zelenko4f233182018-03-22 00:53:26 +0000271 return {};
Richard Trieuc3096242015-09-24 01:21:01 +0000272
Richard Smithb5f81712018-04-30 05:25:48 +0000273 CharSourceRange MacroRange, MacroArgRange;
Richard Trieuc3096242015-09-24 01:21:01 +0000274
275 if (SM->isMacroArgExpansion(Loc)) {
Reid Klecknerda30cff2015-12-08 01:08:09 +0000276 // Only look at the immediate spelling location of this macro argument if
277 // the other location in the source range is also present in that expansion.
278 if (std::binary_search(CommonArgExpansions.begin(),
279 CommonArgExpansions.end(), MacroFileID))
Richard Smithb5f81712018-04-30 05:25:48 +0000280 MacroRange =
281 CharSourceRange(SM->getImmediateSpellingLoc(Loc), IsTokenRange);
282 MacroArgRange = SM->getImmediateExpansionRange(Loc);
Richard Trieuc3096242015-09-24 01:21:01 +0000283 } else {
Richard Smithb5f81712018-04-30 05:25:48 +0000284 MacroRange = SM->getImmediateExpansionRange(Loc);
285 MacroArgRange =
286 CharSourceRange(SM->getImmediateSpellingLoc(Loc), IsTokenRange);
Richard Trieuc3096242015-09-24 01:21:01 +0000287 }
288
Richard Smithb5f81712018-04-30 05:25:48 +0000289 SourceLocation MacroLocation =
290 IsBegin ? MacroRange.getBegin() : MacroRange.getEnd();
Reid Klecknerda30cff2015-12-08 01:08:09 +0000291 if (MacroLocation.isValid()) {
292 MacroFileID = SM->getFileID(MacroLocation);
Richard Smithb5f81712018-04-30 05:25:48 +0000293 bool TokenRange = IsBegin ? IsTokenRange : MacroRange.isTokenRange();
Reid Klecknerda30cff2015-12-08 01:08:09 +0000294 MacroLocation =
295 retrieveMacroLocation(MacroLocation, MacroFileID, CaretFileID,
Richard Smithb5f81712018-04-30 05:25:48 +0000296 CommonArgExpansions, IsBegin, SM, TokenRange);
297 if (MacroLocation.isValid()) {
298 IsTokenRange = TokenRange;
Reid Klecknerda30cff2015-12-08 01:08:09 +0000299 return MacroLocation;
Richard Smithb5f81712018-04-30 05:25:48 +0000300 }
Reid Klecknerda30cff2015-12-08 01:08:09 +0000301 }
Richard Trieuc3096242015-09-24 01:21:01 +0000302
Richard Smithb5f81712018-04-30 05:25:48 +0000303 // If we moved the end of the range to an expansion location, we now have
304 // a range of the same kind as the expansion range.
305 if (!IsBegin)
306 IsTokenRange = MacroArgRange.isTokenRange();
307
308 SourceLocation MacroArgLocation =
309 IsBegin ? MacroArgRange.getBegin() : MacroArgRange.getEnd();
Richard Trieuc3096242015-09-24 01:21:01 +0000310 MacroFileID = SM->getFileID(MacroArgLocation);
311 return retrieveMacroLocation(MacroArgLocation, MacroFileID, CaretFileID,
Richard Smithb5f81712018-04-30 05:25:48 +0000312 CommonArgExpansions, IsBegin, SM, IsTokenRange);
Reid Klecknerda30cff2015-12-08 01:08:09 +0000313}
314
315/// Walk up the chain of macro expansions and collect the FileIDs identifying the
316/// expansions.
317static void getMacroArgExpansionFileIDs(SourceLocation Loc,
318 SmallVectorImpl<FileID> &IDs,
319 bool IsBegin, const SourceManager *SM) {
320 while (Loc.isMacroID()) {
321 if (SM->isMacroArgExpansion(Loc)) {
322 IDs.push_back(SM->getFileID(Loc));
323 Loc = SM->getImmediateSpellingLoc(Loc);
324 } else {
325 auto ExpRange = SM->getImmediateExpansionRange(Loc);
Richard Smithb5f81712018-04-30 05:25:48 +0000326 Loc = IsBegin ? ExpRange.getBegin() : ExpRange.getEnd();
Reid Klecknerda30cff2015-12-08 01:08:09 +0000327 }
328 }
329}
330
331/// Collect the expansions of the begin and end locations and compute the set
332/// intersection. Produces a sorted vector of FileIDs in CommonArgExpansions.
333static void computeCommonMacroArgExpansionFileIDs(
334 SourceLocation Begin, SourceLocation End, const SourceManager *SM,
335 SmallVectorImpl<FileID> &CommonArgExpansions) {
336 SmallVector<FileID, 4> BeginArgExpansions;
337 SmallVector<FileID, 4> EndArgExpansions;
338 getMacroArgExpansionFileIDs(Begin, BeginArgExpansions, /*IsBegin=*/true, SM);
339 getMacroArgExpansionFileIDs(End, EndArgExpansions, /*IsBegin=*/false, SM);
Mandeep Singh Grangc205d8c2018-03-27 16:50:00 +0000340 llvm::sort(BeginArgExpansions.begin(), BeginArgExpansions.end());
341 llvm::sort(EndArgExpansions.begin(), EndArgExpansions.end());
Reid Klecknerda30cff2015-12-08 01:08:09 +0000342 std::set_intersection(BeginArgExpansions.begin(), BeginArgExpansions.end(),
343 EndArgExpansions.begin(), EndArgExpansions.end(),
344 std::back_inserter(CommonArgExpansions));
Richard Trieuc3096242015-09-24 01:21:01 +0000345}
346
Eli Friedman34ff0ea2012-11-03 03:36:51 +0000347// Helper function to fix up source ranges. It takes in an array of ranges,
348// and outputs an array of ranges where we want to draw the range highlighting
349// around the location specified by CaretLoc.
350//
351// To find locations which correspond to the caret, we crawl the macro caller
352// chain for the beginning and end of each range. If the caret location
353// is in a macro expansion, we search each chain for a location
354// in the same expansion as the caret; otherwise, we crawl to the top of
355// each chain. Two locations are part of the same macro expansion
356// iff the FileID is the same.
Christof Doumafb4a0452017-06-27 09:50:38 +0000357static void
358mapDiagnosticRanges(FullSourceLoc CaretLoc, ArrayRef<CharSourceRange> Ranges,
359 SmallVectorImpl<CharSourceRange> &SpellingRanges) {
360 FileID CaretLocFileID = CaretLoc.getFileID();
361
362 const SourceManager *SM = &CaretLoc.getManager();
Eli Friedman34ff0ea2012-11-03 03:36:51 +0000363
Eugene Zelenko4f233182018-03-22 00:53:26 +0000364 for (const auto &Range : Ranges) {
365 if (Range.isInvalid())
366 continue;
Richard Trieuc3096242015-09-24 01:21:01 +0000367
Eugene Zelenko4f233182018-03-22 00:53:26 +0000368 SourceLocation Begin = Range.getBegin(), End = Range.getEnd();
369 bool IsTokenRange = Range.isTokenRange();
Eli Friedman34ff0ea2012-11-03 03:36:51 +0000370
Eli Friedmandea98de2012-11-30 06:19:40 +0000371 FileID BeginFileID = SM->getFileID(Begin);
Nadav Rotemb8937342012-12-13 19:58:10 +0000372 FileID EndFileID = SM->getFileID(End);
Eli Friedmandea98de2012-11-30 06:19:40 +0000373
Nadav Rotemb8937342012-12-13 19:58:10 +0000374 // Find the common parent for the beginning and end of the range.
375
376 // First, crawl the expansion chain for the beginning of the range.
377 llvm::SmallDenseMap<FileID, SourceLocation> BeginLocsMap;
378 while (Begin.isMacroID() && BeginFileID != EndFileID) {
379 BeginLocsMap[BeginFileID] = Begin;
Richard Smithb5f81712018-04-30 05:25:48 +0000380 Begin = SM->getImmediateExpansionRange(Begin).getBegin();
Nadav Rotemb8937342012-12-13 19:58:10 +0000381 BeginFileID = SM->getFileID(Begin);
382 }
383
384 // Then, crawl the expansion chain for the end of the range.
385 if (BeginFileID != EndFileID) {
386 while (End.isMacroID() && !BeginLocsMap.count(EndFileID)) {
Richard Smithb5f81712018-04-30 05:25:48 +0000387 auto Exp = SM->getImmediateExpansionRange(End);
388 IsTokenRange = Exp.isTokenRange();
389 End = Exp.getEnd();
Nadav Rotemb8937342012-12-13 19:58:10 +0000390 EndFileID = SM->getFileID(End);
391 }
392 if (End.isMacroID()) {
393 Begin = BeginLocsMap[EndFileID];
394 BeginFileID = EndFileID;
Eli Friedman34ff0ea2012-11-03 03:36:51 +0000395 }
Eli Friedmancdb135a2012-12-13 00:14:59 +0000396 }
397
Richard Trieuc3096242015-09-24 01:21:01 +0000398 // Do the backtracking.
Reid Klecknerda30cff2015-12-08 01:08:09 +0000399 SmallVector<FileID, 4> CommonArgExpansions;
400 computeCommonMacroArgExpansionFileIDs(Begin, End, SM, CommonArgExpansions);
Richard Trieuc3096242015-09-24 01:21:01 +0000401 Begin = retrieveMacroLocation(Begin, BeginFileID, CaretLocFileID,
Richard Smithb5f81712018-04-30 05:25:48 +0000402 CommonArgExpansions, /*IsBegin=*/true, SM,
403 IsTokenRange);
Richard Trieuc3096242015-09-24 01:21:01 +0000404 End = retrieveMacroLocation(End, BeginFileID, CaretLocFileID,
Richard Smithb5f81712018-04-30 05:25:48 +0000405 CommonArgExpansions, /*IsBegin=*/false, SM,
406 IsTokenRange);
Richard Trieuc3096242015-09-24 01:21:01 +0000407 if (Begin.isInvalid() || End.isInvalid()) continue;
Eli Friedman34ff0ea2012-11-03 03:36:51 +0000408
409 // Return the spelling location of the beginning and end of the range.
410 Begin = SM->getSpellingLoc(Begin);
411 End = SM->getSpellingLoc(End);
Richard Trieuc3096242015-09-24 01:21:01 +0000412
Eli Friedman34ff0ea2012-11-03 03:36:51 +0000413 SpellingRanges.push_back(CharSourceRange(SourceRange(Begin, End),
414 IsTokenRange));
415 }
416}
417
Christof Doumafb4a0452017-06-27 09:50:38 +0000418void DiagnosticRenderer::emitCaret(FullSourceLoc Loc,
Richard Smithaebee682012-12-05 06:20:58 +0000419 DiagnosticsEngine::Level Level,
420 ArrayRef<CharSourceRange> Ranges,
Christof Doumafb4a0452017-06-27 09:50:38 +0000421 ArrayRef<FixItHint> Hints) {
Richard Smithaebee682012-12-05 06:20:58 +0000422 SmallVector<CharSourceRange, 4> SpellingRanges;
Christof Doumafb4a0452017-06-27 09:50:38 +0000423 mapDiagnosticRanges(Loc, Ranges, SpellingRanges);
424 emitCodeContext(Loc, Level, SpellingRanges, Hints);
Richard Smithaebee682012-12-05 06:20:58 +0000425}
426
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000427/// A helper function for emitMacroExpansion to print the
Richard Trieu97c45b62015-07-28 20:53:46 +0000428/// macro expansion message
429void DiagnosticRenderer::emitSingleMacroExpansion(
Christof Doumafb4a0452017-06-27 09:50:38 +0000430 FullSourceLoc Loc, DiagnosticsEngine::Level Level,
431 ArrayRef<CharSourceRange> Ranges) {
Richard Smith7a2d40d2012-12-05 03:18:16 +0000432 // Find the spelling location for the macro definition. We must use the
Richard Trieu97c45b62015-07-28 20:53:46 +0000433 // spelling location here to avoid emitting a macro backtrace for the note.
Christof Doumafb4a0452017-06-27 09:50:38 +0000434 FullSourceLoc SpellingLoc = Loc.getSpellingLoc();
Richard Smith7a2d40d2012-12-05 03:18:16 +0000435
436 // Map the ranges into the FileID of the diagnostic location.
Eli Friedman34ff0ea2012-11-03 03:36:51 +0000437 SmallVector<CharSourceRange, 4> SpellingRanges;
Christof Doumafb4a0452017-06-27 09:50:38 +0000438 mapDiagnosticRanges(Loc, Ranges, SpellingRanges);
Eli Friedman34ff0ea2012-11-03 03:36:51 +0000439
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000440 SmallString<100> MessageStorage;
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000441 llvm::raw_svector_ostream Message(MessageStorage);
Christof Doumafb4a0452017-06-27 09:50:38 +0000442 StringRef MacroName = Lexer::getImmediateMacroNameForDiagnostics(
443 Loc, Loc.getManager(), LangOpts);
Richard Smithf89e2e22012-12-05 11:04:55 +0000444 if (MacroName.empty())
445 Message << "expanded from here";
446 else
447 Message << "expanded from macro '" << MacroName << "'";
Richard Trieu97c45b62015-07-28 20:53:46 +0000448
Dmitri Gribenko44ebbd52013-05-05 00:41:58 +0000449 emitDiagnostic(SpellingLoc, DiagnosticsEngine::Note, Message.str(),
Christof Doumafb4a0452017-06-27 09:50:38 +0000450 SpellingRanges, None);
Ted Kremenekc4bbd852011-12-17 05:26:04 +0000451}
452
Richard Trieuc3096242015-09-24 01:21:01 +0000453/// Check that the macro argument location of Loc starts with ArgumentLoc.
454/// The starting location of the macro expansions is used to differeniate
455/// different macro expansions.
456static bool checkLocForMacroArgExpansion(SourceLocation Loc,
457 const SourceManager &SM,
458 SourceLocation ArgumentLoc) {
459 SourceLocation MacroLoc;
460 if (SM.isMacroArgExpansion(Loc, &MacroLoc)) {
461 if (ArgumentLoc == MacroLoc) return true;
462 }
463
464 return false;
465}
466
467/// Check if all the locations in the range have the same macro argument
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +0000468/// expansion, and that the expansion starts with ArgumentLoc.
Richard Trieuecd36ee2015-08-12 18:24:59 +0000469static bool checkRangeForMacroArgExpansion(CharSourceRange Range,
Richard Trieuc3096242015-09-24 01:21:01 +0000470 const SourceManager &SM,
471 SourceLocation ArgumentLoc) {
Richard Trieuecd36ee2015-08-12 18:24:59 +0000472 SourceLocation BegLoc = Range.getBegin(), EndLoc = Range.getEnd();
473 while (BegLoc != EndLoc) {
Richard Trieuc3096242015-09-24 01:21:01 +0000474 if (!checkLocForMacroArgExpansion(BegLoc, SM, ArgumentLoc))
Richard Trieuecd36ee2015-08-12 18:24:59 +0000475 return false;
476 BegLoc.getLocWithOffset(1);
477 }
478
Richard Trieuc3096242015-09-24 01:21:01 +0000479 return checkLocForMacroArgExpansion(BegLoc, SM, ArgumentLoc);
Richard Trieuecd36ee2015-08-12 18:24:59 +0000480}
481
Richard Trieuc3096242015-09-24 01:21:01 +0000482/// A helper function to check if the current ranges are all inside the same
483/// macro argument expansion as Loc.
Christof Doumafb4a0452017-06-27 09:50:38 +0000484static bool checkRangesForMacroArgExpansion(FullSourceLoc Loc,
485 ArrayRef<CharSourceRange> Ranges) {
Richard Trieuecd36ee2015-08-12 18:24:59 +0000486 assert(Loc.isMacroID() && "Must be a macro expansion!");
487
488 SmallVector<CharSourceRange, 4> SpellingRanges;
Christof Doumafb4a0452017-06-27 09:50:38 +0000489 mapDiagnosticRanges(Loc, Ranges, SpellingRanges);
Richard Trieuecd36ee2015-08-12 18:24:59 +0000490
Richard Trieuc3096242015-09-24 01:21:01 +0000491 /// Count all valid ranges.
492 unsigned ValidCount = 0;
Eugene Zelenko4f233182018-03-22 00:53:26 +0000493 for (const auto &Range : Ranges)
494 if (Range.isValid())
495 ValidCount++;
Richard Trieuc3096242015-09-24 01:21:01 +0000496
497 if (ValidCount > SpellingRanges.size())
Richard Trieuecd36ee2015-08-12 18:24:59 +0000498 return false;
499
Richard Trieuc3096242015-09-24 01:21:01 +0000500 /// To store the source location of the argument location.
Christof Doumafb4a0452017-06-27 09:50:38 +0000501 FullSourceLoc ArgumentLoc;
Richard Trieuc3096242015-09-24 01:21:01 +0000502
503 /// Set the ArgumentLoc to the beginning location of the expansion of Loc
504 /// so to check if the ranges expands to the same beginning location.
Christof Doumafb4a0452017-06-27 09:50:38 +0000505 if (!Loc.isMacroArgExpansion(&ArgumentLoc))
Richard Trieuc3096242015-09-24 01:21:01 +0000506 return false;
507
Eugene Zelenko4f233182018-03-22 00:53:26 +0000508 for (const auto &Range : SpellingRanges)
509 if (!checkRangeForMacroArgExpansion(Range, Loc.getManager(), ArgumentLoc))
Richard Trieuecd36ee2015-08-12 18:24:59 +0000510 return false;
511
512 return true;
513}
514
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000515/// Recursively emit notes for each macro expansion and caret
Richard Trieu97c45b62015-07-28 20:53:46 +0000516/// diagnostics where appropriate.
517///
518/// Walks up the macro expansion stack printing expansion notes, the code
519/// snippet, caret, underlines and FixItHint display as appropriate at each
520/// level.
521///
522/// \param Loc The location for this caret.
523/// \param Level The diagnostic level currently being emitted.
524/// \param Ranges The underlined ranges for this code snippet.
525/// \param Hints The FixIt hints active for this diagnostic.
Christof Doumafb4a0452017-06-27 09:50:38 +0000526void DiagnosticRenderer::emitMacroExpansions(FullSourceLoc Loc,
Richard Trieu97c45b62015-07-28 20:53:46 +0000527 DiagnosticsEngine::Level Level,
528 ArrayRef<CharSourceRange> Ranges,
Christof Doumafb4a0452017-06-27 09:50:38 +0000529 ArrayRef<FixItHint> Hints) {
Yaron Kerened1fe5d2015-10-03 05:15:57 +0000530 assert(Loc.isValid() && "must have a valid source location here");
Richard Smithb5f81712018-04-30 05:25:48 +0000531 const SourceManager &SM = Loc.getManager();
532 SourceLocation L = Loc;
Richard Trieu97c45b62015-07-28 20:53:46 +0000533
534 // Produce a stack of macro backtraces.
Richard Smithb5f81712018-04-30 05:25:48 +0000535 SmallVector<SourceLocation, 8> LocationStack;
Richard Trieuecd36ee2015-08-12 18:24:59 +0000536 unsigned IgnoredEnd = 0;
Richard Smithb5f81712018-04-30 05:25:48 +0000537 while (L.isMacroID()) {
Richard Trieua1d7ece2015-08-27 23:38:45 +0000538 // If this is the expansion of a macro argument, point the caret at the
539 // use of the argument in the definition of the macro, not the expansion.
Richard Smithb5f81712018-04-30 05:25:48 +0000540 if (SM.isMacroArgExpansion(L))
541 LocationStack.push_back(SM.getImmediateExpansionRange(L).getBegin());
Richard Trieua1d7ece2015-08-27 23:38:45 +0000542 else
Richard Smithb5f81712018-04-30 05:25:48 +0000543 LocationStack.push_back(L);
Richard Trieua1d7ece2015-08-27 23:38:45 +0000544
Richard Smithb5f81712018-04-30 05:25:48 +0000545 if (checkRangesForMacroArgExpansion(FullSourceLoc(L, SM), Ranges))
Richard Trieuecd36ee2015-08-12 18:24:59 +0000546 IgnoredEnd = LocationStack.size();
547
Richard Smithb5f81712018-04-30 05:25:48 +0000548 L = SM.getImmediateMacroCallerLoc(L);
Richard Trieua1d7ece2015-08-27 23:38:45 +0000549
550 // Once the location no longer points into a macro, try stepping through
551 // the last found location. This sometimes produces additional useful
552 // backtraces.
Richard Smithb5f81712018-04-30 05:25:48 +0000553 if (L.isFileID())
554 L = SM.getImmediateMacroCallerLoc(LocationStack.back());
555 assert(L.isValid() && "must have a valid source location here");
Richard Trieu97c45b62015-07-28 20:53:46 +0000556 }
557
Richard Trieuecd36ee2015-08-12 18:24:59 +0000558 LocationStack.erase(LocationStack.begin(),
559 LocationStack.begin() + IgnoredEnd);
560
Richard Trieu97c45b62015-07-28 20:53:46 +0000561 unsigned MacroDepth = LocationStack.size();
562 unsigned MacroLimit = DiagOpts->MacroBacktraceLimit;
563 if (MacroDepth <= MacroLimit || MacroLimit == 0) {
564 for (auto I = LocationStack.rbegin(), E = LocationStack.rend();
565 I != E; ++I)
Richard Smithb5f81712018-04-30 05:25:48 +0000566 emitSingleMacroExpansion(FullSourceLoc(*I, SM), Level, Ranges);
Richard Trieu97c45b62015-07-28 20:53:46 +0000567 return;
568 }
569
570 unsigned MacroStartMessages = MacroLimit / 2;
571 unsigned MacroEndMessages = MacroLimit / 2 + MacroLimit % 2;
572
573 for (auto I = LocationStack.rbegin(),
574 E = LocationStack.rbegin() + MacroStartMessages;
575 I != E; ++I)
Richard Smithb5f81712018-04-30 05:25:48 +0000576 emitSingleMacroExpansion(FullSourceLoc(*I, SM), Level, Ranges);
Richard Trieu97c45b62015-07-28 20:53:46 +0000577
578 SmallString<200> MessageStorage;
579 llvm::raw_svector_ostream Message(MessageStorage);
580 Message << "(skipping " << (MacroDepth - MacroLimit)
581 << " expansions in backtrace; use -fmacro-backtrace-limit=0 to "
582 "see all)";
583 emitBasicNote(Message.str());
584
585 for (auto I = LocationStack.rend() - MacroEndMessages,
586 E = LocationStack.rend();
587 I != E; ++I)
Richard Smithb5f81712018-04-30 05:25:48 +0000588 emitSingleMacroExpansion(FullSourceLoc(*I, SM), Level, Ranges);
Richard Trieu97c45b62015-07-28 20:53:46 +0000589}
590
Eugene Zelenko4f233182018-03-22 00:53:26 +0000591DiagnosticNoteRenderer::~DiagnosticNoteRenderer() = default;
Ted Kremenek0964cca2012-02-14 02:46:00 +0000592
Christof Doumafb4a0452017-06-27 09:50:38 +0000593void DiagnosticNoteRenderer::emitIncludeLocation(FullSourceLoc Loc,
594 PresumedLoc PLoc) {
Ted Kremenek0964cca2012-02-14 02:46:00 +0000595 // Generate a note indicating the include location.
596 SmallString<200> MessageStorage;
597 llvm::raw_svector_ostream Message(MessageStorage);
598 Message << "in file included from " << PLoc.getFilename() << ':'
599 << PLoc.getLine() << ":";
Christof Doumafb4a0452017-06-27 09:50:38 +0000600 emitNote(Loc, Message.str());
Ted Kremenek0964cca2012-02-14 02:46:00 +0000601}
602
Christof Doumafb4a0452017-06-27 09:50:38 +0000603void DiagnosticNoteRenderer::emitImportLocation(FullSourceLoc Loc,
Douglas Gregor22103e32012-11-30 21:58:49 +0000604 PresumedLoc PLoc,
Christof Doumafb4a0452017-06-27 09:50:38 +0000605 StringRef ModuleName) {
Douglas Gregor22103e32012-11-30 21:58:49 +0000606 // Generate a note indicating the include location.
607 SmallString<200> MessageStorage;
608 llvm::raw_svector_ostream Message(MessageStorage);
Richard Smitha24ff552015-08-11 00:05:21 +0000609 Message << "in module '" << ModuleName;
Yaron Kerened1fe5d2015-10-03 05:15:57 +0000610 if (PLoc.isValid())
Richard Smitha24ff552015-08-11 00:05:21 +0000611 Message << "' imported from " << PLoc.getFilename() << ':'
612 << PLoc.getLine();
613 Message << ":";
Christof Doumafb4a0452017-06-27 09:50:38 +0000614 emitNote(Loc, Message.str());
Douglas Gregor22103e32012-11-30 21:58:49 +0000615}
616
Christof Doumafb4a0452017-06-27 09:50:38 +0000617void DiagnosticNoteRenderer::emitBuildingModuleLocation(FullSourceLoc Loc,
618 PresumedLoc PLoc,
619 StringRef ModuleName) {
Douglas Gregoraf8f0262012-11-30 18:38:50 +0000620 // Generate a note indicating the include location.
621 SmallString<200> MessageStorage;
622 llvm::raw_svector_ostream Message(MessageStorage);
Jordan Rose602ac142016-06-28 01:02:31 +0000623 if (PLoc.isValid())
Richard Smith7bea1d42014-03-05 20:55:36 +0000624 Message << "while building module '" << ModuleName << "' imported from "
625 << PLoc.getFilename() << ':' << PLoc.getLine() << ":";
626 else
Jordan Rose6dcdaa62014-07-26 01:22:02 +0000627 Message << "while building module '" << ModuleName << "':";
Christof Doumafb4a0452017-06-27 09:50:38 +0000628 emitNote(Loc, Message.str());
Douglas Gregoraf8f0262012-11-30 18:38:50 +0000629}