clang 8.0.0

TextDiagnostic.cpp
Go to the documentation of this file.
1 //===--- TextDiagnostic.cpp - Text 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/TextDiagnostic.h"
11 #include "clang/Basic/CharInfo.h"
12 #include "clang/Basic/DiagnosticOptions.h"
13 #include "clang/Basic/FileManager.h"
14 #include "clang/Basic/SourceManager.h"
15 #include "clang/Lex/Lexer.h"
16 #include "llvm/ADT/SmallString.h"
17 #include "llvm/ADT/StringExtras.h"
18 #include "llvm/Support/ConvertUTF.h"
19 #include "llvm/Support/ErrorHandling.h"
20 #include "llvm/Support/Locale.h"
21 #include "llvm/Support/Path.h"
22 #include "llvm/Support/raw_ostream.h"
23 #include <algorithm>
24
25 using namespace clang;
26
27 static const enum raw_ostream::Colors noteColor =
28 raw_ostream::BLACK;
29 static const enum raw_ostream::Colors remarkColor =
30 raw_ostream::BLUE;
31 static const enum raw_ostream::Colors fixitColor =
32 raw_ostream::GREEN;
33 static const enum raw_ostream::Colors caretColor =
34 raw_ostream::GREEN;
35 static const enum raw_ostream::Colors warningColor =
36 raw_ostream::MAGENTA;
37 static const enum raw_ostream::Colors templateColor =
38 raw_ostream::CYAN;
39 static const enum raw_ostream::Colors errorColor = raw_ostream::RED;
40 static const enum raw_ostream::Colors fatalColor = raw_ostream::RED;
41 // Used for changing only the bold attribute.
42 static const enum raw_ostream::Colors savedColor =
43 raw_ostream::SAVEDCOLOR;
44
45 /// Add highlights to differences in template strings.
46 static void applyTemplateHighlighting(raw_ostream &OS, StringRef Str,
47 bool &Normal, bool Bold) {
48 while (1) {
49 size_t Pos = Str.find(ToggleHighlight);
50 OS << Str.slice(0, Pos);
51 if (Pos == StringRef::npos)
52 break;
53
54 Str = Str.substr(Pos + 1);
55 if (Normal)
56 OS.changeColor(templateColor, true);
57 else {
58 OS.resetColor();
59 if (Bold)
60 OS.changeColor(savedColor, true);
61 }
62 Normal = !Normal;
63 }
64 }
65
66 /// Number of spaces to indent when word-wrapping.
67 const unsigned WordWrapIndentation = 6;
68
69 static int bytesSincePreviousTabOrLineBegin(StringRef SourceLine, size_t i) {
70 int bytes = 0;
71 while (0<i) {
72 if (SourceLine[--i]=='\t')
73 break;
74 ++bytes;
75 }
76 return bytes;
77 }
78
79 /// returns a printable representation of first item from input range
80 ///
81 /// This function returns a printable representation of the next item in a line
82 /// of source. If the next byte begins a valid and printable character, that
83 /// character is returned along with 'true'.
84 ///
85 /// Otherwise, if the next byte begins a valid, but unprintable character, a
86 /// printable, escaped representation of the character is returned, along with
87 /// 'false'. Otherwise a printable, escaped representation of the next byte
88 /// is returned along with 'false'.
89 ///
90 /// \note The index is updated to be used with a subsequent call to
91 /// printableTextForNextCharacter.
92 ///
93 /// \param SourceLine The line of source
94 /// \param i Pointer to byte index,
95 /// \param TabStop used to expand tabs
96 /// \return pair(printable text, 'true' iff original text was printable)
97 ///
98 static std::pair<SmallString<16>, bool>
99 printableTextForNextCharacter(StringRef SourceLine, size_t *i,
100 unsigned TabStop) {
101 assert(i && "i must not be null");
102 assert(*i<SourceLine.size() && "must point to a valid index");
103
104 if (SourceLine[*i]=='\t') {
105 assert(0 < TabStop && TabStop <= DiagnosticOptions::MaxTabStop &&
106 "Invalid -ftabstop value");
107 unsigned col = bytesSincePreviousTabOrLineBegin(SourceLine, *i);
108 unsigned NumSpaces = TabStop - col%TabStop;
109 assert(0 < NumSpaces && NumSpaces <= TabStop
110 && "Invalid computation of space amt");
111 ++(*i);
112
113 SmallString<16> expandedTab;
114 expandedTab.assign(NumSpaces, ' ');
115 return std::make_pair(expandedTab, true);
116 }
117
118 unsigned char const *begin, *end;
119 begin = reinterpret_cast<unsigned char const *>(&*(SourceLine.begin() + *i));
120 end = begin + (SourceLine.size() - *i);
121
122 if (llvm::isLegalUTF8Sequence(begin, end)) {
123 llvm::UTF32 c;
124 llvm::UTF32 *cptr = &c;
125 unsigned char const *original_begin = begin;
126 unsigned char const *cp_end =
127 begin + llvm::getNumBytesForUTF8(SourceLine[*i]);
128
129 llvm::ConversionResult res = llvm::ConvertUTF8toUTF32(
130 &begin, cp_end, &cptr, cptr + 1, llvm::strictConversion);
131 (void)res;
132 assert(llvm::conversionOK == res);
133 assert(0 < begin-original_begin
134 && "we must be further along in the string now");
135 *i += begin-original_begin;
136
137 if (!llvm::sys::locale::isPrint(c)) {
138 // If next character is valid UTF-8, but not printable
139 SmallString<16> expandedCP("<U+>");
140 while (c) {
141 expandedCP.insert(expandedCP.begin()+3, llvm::hexdigit(c%16));
142 c/=16;
143 }
144 while (expandedCP.size() < 8)
145 expandedCP.insert(expandedCP.begin()+3, llvm::hexdigit(0));
146 return std::make_pair(expandedCP, false);
147 }
148
149 // If next character is valid UTF-8, and printable
150 return std::make_pair(SmallString<16>(original_begin, cp_end), true);
151
152 }
153
154 // If next byte is not valid UTF-8 (and therefore not printable)
155 SmallString<16> expandedByte("<XX>");
156 unsigned char byte = SourceLine[*i];
157 expandedByte[1] = llvm::hexdigit(byte / 16);
158 expandedByte[2] = llvm::hexdigit(byte % 16);
159 ++(*i);
160 return std::make_pair(expandedByte, false);
161 }
162
163 static void expandTabs(std::string &SourceLine, unsigned TabStop) {
164 size_t i = SourceLine.size();
165 while (i>0) {
166 i--;
167 if (SourceLine[i]!='\t')
168 continue;
169 size_t tmp_i = i;
170 std::pair<SmallString<16>,bool> res
171 = printableTextForNextCharacter(SourceLine, &tmp_i, TabStop);
172 SourceLine.replace(i, 1, res.first.c_str());
173 }
174 }
175
176 /// This function takes a raw source line and produces a mapping from the bytes
177 /// of the printable representation of the line to the columns those printable
178 /// characters will appear at (numbering the first column as 0).
179 ///
180 /// If a byte 'i' corresponds to multiple columns (e.g. the byte contains a tab
181 /// character) then the array will map that byte to the first column the
182 /// tab appears at and the next value in the map will have been incremented
183 /// more than once.
184 ///
185 /// If a byte is the first in a sequence of bytes that together map to a single
186 /// entity in the output, then the array will map that byte to the appropriate
187 /// column while the subsequent bytes will be -1.
188 ///
189 /// The last element in the array does not correspond to any byte in the input
190 /// and instead is the number of columns needed to display the source
191 ///
192 /// example: (given a tabstop of 8)
193 ///
194 /// "a \t \u3042" -> {0,1,2,8,9,-1,-1,11}
195 ///
196 /// (\\u3042 is represented in UTF-8 by three bytes and takes two columns to
197 /// display)
198 static void byteToColumn(StringRef SourceLine, unsigned TabStop,
199 SmallVectorImpl<int> &out) {
200 out.clear();
201
202 if (SourceLine.empty()) {
203 out.resize(1u,0);
204 return;
205 }
206
207 out.resize(SourceLine.size()+1, -1);
208
209 int columns = 0;
210 size_t i = 0;
211 while (i<SourceLine.size()) {
212 out[i] = columns;
213 std::pair<SmallString<16>,bool> res
214 = printableTextForNextCharacter(SourceLine, &i, TabStop);
215 columns += llvm::sys::locale::columnWidth(res.first);
216 }
217 out.back() = columns;
218 }
219
220 /// This function takes a raw source line and produces a mapping from columns
221 /// to the byte of the source line that produced the character displaying at
222 /// that column. This is the inverse of the mapping produced by byteToColumn()
223 ///
224 /// The last element in the array is the number of bytes in the source string
225 ///
226 /// example: (given a tabstop of 8)
227 ///
228 /// "a \t \u3042" -> {0,1,2,-1,-1,-1,-1,-1,3,4,-1,7}
229 ///
230 /// (\\u3042 is represented in UTF-8 by three bytes and takes two columns to
231 /// display)
232 static void columnToByte(StringRef SourceLine, unsigned TabStop,
233 SmallVectorImpl<int> &out) {
234 out.clear();
235
236 if (SourceLine.empty()) {
237 out.resize(1u, 0);
238 return;
239 }
240
241 int columns = 0;
242 size_t i = 0;
243 while (i<SourceLine.size()) {
244 out.resize(columns+1, -1);
245 out.back() = i;
246 std::pair<SmallString<16>,bool> res
247 = printableTextForNextCharacter(SourceLine, &i, TabStop);
248 columns += llvm::sys::locale::columnWidth(res.first);
249 }
250 out.resize(columns+1, -1);
251 out.back() = i;
252 }
253
254 namespace {
255 struct SourceColumnMap {
256 SourceColumnMap(StringRef SourceLine, unsigned TabStop)
257 : m_SourceLine(SourceLine) {
258
259 ::byteToColumn(SourceLine, TabStop, m_byteToColumn);
260 ::columnToByte(SourceLine, TabStop, m_columnToByte);
261
262 assert(m_byteToColumn.size()==SourceLine.size()+1);
263 assert(0 < m_byteToColumn.size() && 0 < m_columnToByte.size());
264 assert(m_byteToColumn.size()
265 == static_cast<unsigned>(m_columnToByte.back()+1));
266 assert(static_cast<unsigned>(m_byteToColumn.back()+1)
267 == m_columnToByte.size());
268 }
269 int columns() const { return m_byteToColumn.back(); }
270 int bytes() const { return m_columnToByte.back(); }
271
272 /// Map a byte to the column which it is at the start of, or return -1
273 /// if it is not at the start of a column (for a UTF-8 trailing byte).
274 int byteToColumn(int n) const {
275 assert(0<=n && n<static_cast<int>(m_byteToColumn.size()));
276 return m_byteToColumn[n];
277 }
278
279 /// Map a byte to the first column which contains it.
280 int byteToContainingColumn(int N) const {
281 assert(0 <= N && N < static_cast<int>(m_byteToColumn.size()));
282 while (m_byteToColumn[N] == -1)
283 --N;
284 return m_byteToColumn[N];
285 }
286
287 /// Map a column to the byte which starts the column, or return -1 if
288 /// the column the second or subsequent column of an expanded tab or similar
289 /// multi-column entity.
290 int columnToByte(int n) const {
291 assert(0<=n && n<static_cast<int>(m_columnToByte.size()));
292 return m_columnToByte[n];
293 }
294
295 /// Map from a byte index to the next byte which starts a column.
296 int startOfNextColumn(int N) const {
297 assert(0 <= N && N < static_cast<int>(m_byteToColumn.size() - 1));
298 while (byteToColumn(++N) == -1) {}
299 return N;
300 }
301
302 /// Map from a byte index to the previous byte which starts a column.
303 int startOfPreviousColumn(int N) const {
304 assert(0 < N && N < static_cast<int>(m_byteToColumn.size()));
305 while (byteToColumn(--N) == -1) {}
306 return N;
307 }
308
309 StringRef getSourceLine() const {
310 return m_SourceLine;
311 }
312
313 private:
314 const std::string m_SourceLine;
315 SmallVector<int,200> m_byteToColumn;
316 SmallVector<int,200> m_columnToByte;
317 };
318 } // end anonymous namespace
319
320 /// When the source code line we want to print is too long for
321 /// the terminal, select the "interesting" region.
322 static void selectInterestingSourceRegion(std::string &SourceLine,
323 std::string &CaretLine,
324 std::string &FixItInsertionLine,
325 unsigned Columns,
326 const SourceColumnMap &map) {
327 unsigned CaretColumns = CaretLine.size();
328 unsigned FixItColumns = llvm::sys::locale::columnWidth(FixItInsertionLine);
329 unsigned MaxColumns = std::max(static_cast<unsigned>(map.columns()),
330 std::max(CaretColumns, FixItColumns));
331 // if the number of columns is less than the desired number we're done
332 if (MaxColumns <= Columns)
333 return;
334
335 // No special characters are allowed in CaretLine.
336 assert(CaretLine.end() ==
337 std::find_if(CaretLine.begin(), CaretLine.end(),
338 [](char c) { return c < ' ' || '~' < c; }));
339
340 // Find the slice that we need to display the full caret line
341 // correctly.
342 unsigned CaretStart = 0, CaretEnd = CaretLine.size();
343 for (; CaretStart != CaretEnd; ++CaretStart)
344 if (!isWhitespace(CaretLine[CaretStart]))
345 break;
346
347 for (; CaretEnd != CaretStart; --CaretEnd)
348 if (!isWhitespace(CaretLine[CaretEnd - 1]))
349 break;
350
351 // caret has already been inserted into CaretLine so the above whitespace
352 // check is guaranteed to include the caret
353
354 // If we have a fix-it line, make sure the slice includes all of the
355 // fix-it information.
356 if (!FixItInsertionLine.empty()) {
357 unsigned FixItStart = 0, FixItEnd = FixItInsertionLine.size();
358 for (; FixItStart != FixItEnd; ++FixItStart)
359 if (!isWhitespace(FixItInsertionLine[FixItStart]))
360 break;
361
362 for (; FixItEnd != FixItStart; --FixItEnd)
363 if (!isWhitespace(FixItInsertionLine[FixItEnd - 1]))
364 break;
365
366 // We can safely use the byte offset FixItStart as the column offset
367 // because the characters up until FixItStart are all ASCII whitespace
368 // characters.
369 unsigned FixItStartCol = FixItStart;
370 unsigned FixItEndCol
371 = llvm::sys::locale::columnWidth(FixItInsertionLine.substr(0, FixItEnd));
372
373 CaretStart = std::min(FixItStartCol, CaretStart);
374 CaretEnd = std::max(FixItEndCol, CaretEnd);
375 }
376
377 // CaretEnd may have been set at the middle of a character
378 // If it's not at a character's first column then advance it past the current
379 // character.
380 while (static_cast<int>(CaretEnd) < map.columns() &&
381 -1 == map.columnToByte(CaretEnd))
382 ++CaretEnd;
383
384 assert((static_cast<int>(CaretStart) > map.columns() ||
385 -1!=map.columnToByte(CaretStart)) &&
386 "CaretStart must not point to a column in the middle of a source"
387 " line character");
388 assert((static_cast<int>(CaretEnd) > map.columns() ||
389 -1!=map.columnToByte(CaretEnd)) &&
390 "CaretEnd must not point to a column in the middle of a source line"
391 " character");
392
393 // CaretLine[CaretStart, CaretEnd) contains all of the interesting
394 // parts of the caret line. While this slice is smaller than the
395 // number of columns we have, try to grow the slice to encompass
396 // more context.
397
398 unsigned SourceStart = map.columnToByte(std::min<unsigned>(CaretStart,
399 map.columns()));
400 unsigned SourceEnd = map.columnToByte(std::min<unsigned>(CaretEnd,
401 map.columns()));
402
403 unsigned CaretColumnsOutsideSource = CaretEnd-CaretStart
404 - (map.byteToColumn(SourceEnd)-map.byteToColumn(SourceStart));
405
406 char const *front_ellipse = " ...";
407 char const *front_space = " ";
408 char const *back_ellipse = "...";
409 unsigned ellipses_space = strlen(front_ellipse) + strlen(back_ellipse);
410
411 unsigned TargetColumns = Columns;
412 // Give us extra room for the ellipses
413 // and any of the caret line that extends past the source
414 if (TargetColumns > ellipses_space+CaretColumnsOutsideSource)
415 TargetColumns -= ellipses_space+CaretColumnsOutsideSource;
416
417 while (SourceStart>0 || SourceEnd<SourceLine.size()) {
418 bool ExpandedRegion = false;
419
420 if (SourceStart>0) {
421 unsigned NewStart = map.startOfPreviousColumn(SourceStart);
422
423 // Skip over any whitespace we see here; we're looking for
424 // another bit of interesting text.
425 // FIXME: Detect non-ASCII whitespace characters too.
426 while (NewStart && isWhitespace(SourceLine[NewStart]))
427 NewStart = map.startOfPreviousColumn(NewStart);
428
429 // Skip over this bit of "interesting" text.
430 while (NewStart) {
431 unsigned Prev = map.startOfPreviousColumn(NewStart);
432 if (isWhitespace(SourceLine[Prev]))
433 break;
434 NewStart = Prev;
435 }
436
437 assert(map.byteToColumn(NewStart) != -1);
438 unsigned NewColumns = map.byteToColumn(SourceEnd) -
439 map.byteToColumn(NewStart);
440 if (NewColumns <= TargetColumns) {
441 SourceStart = NewStart;
442 ExpandedRegion = true;
443 }
444 }
445
446 if (SourceEnd<SourceLine.size()) {
447 unsigned NewEnd = map.startOfNextColumn(SourceEnd);
448
449 // Skip over any whitespace we see here; we're looking for
450 // another bit of interesting text.
451 // FIXME: Detect non-ASCII whitespace characters too.
452 while (NewEnd < SourceLine.size() && isWhitespace(SourceLine[NewEnd]))
453 NewEnd = map.startOfNextColumn(NewEnd);
454
455 // Skip over this bit of "interesting" text.
456 while (NewEnd < SourceLine.size() && isWhitespace(SourceLine[NewEnd]))
457 NewEnd = map.startOfNextColumn(NewEnd);
458
459 assert(map.byteToColumn(NewEnd) != -1);
460 unsigned NewColumns = map.byteToColumn(NewEnd) -
461 map.byteToColumn(SourceStart);
462 if (NewColumns <= TargetColumns) {
463 SourceEnd = NewEnd;
464 ExpandedRegion = true;
465 }
466 }
467
468 if (!ExpandedRegion)
469 break;
470 }
471
472 CaretStart = map.byteToColumn(SourceStart);
473 CaretEnd = map.byteToColumn(SourceEnd) + CaretColumnsOutsideSource;
474
475 // [CaretStart, CaretEnd) is the slice we want. Update the various
476 // output lines to show only this slice, with two-space padding
477 // before the lines so that it looks nicer.
478
479 assert(CaretStart!=(unsigned)-1 && CaretEnd!=(unsigned)-1 &&
480 SourceStart!=(unsigned)-1 && SourceEnd!=(unsigned)-1);
481 assert(SourceStart <= SourceEnd);
482 assert(CaretStart <= CaretEnd);
483
484 unsigned BackColumnsRemoved
485 = map.byteToColumn(SourceLine.size())-map.byteToColumn(SourceEnd);
486 unsigned FrontColumnsRemoved = CaretStart;
487 unsigned ColumnsKept = CaretEnd-CaretStart;
488
489 // We checked up front that the line needed truncation
490 assert(FrontColumnsRemoved+ColumnsKept+BackColumnsRemoved > Columns);
491
492 // The line needs some truncation, and we'd prefer to keep the front
493 // if possible, so remove the back
494 if (BackColumnsRemoved > strlen(back_ellipse))
495 SourceLine.replace(SourceEnd, std::string::npos, back_ellipse);
496
497 // If that's enough then we're done
498 if (FrontColumnsRemoved+ColumnsKept <= Columns)
499 return;
500
501 // Otherwise remove the front as well
502 if (FrontColumnsRemoved > strlen(front_ellipse)) {
503 SourceLine.replace(0, SourceStart, front_ellipse);
504 CaretLine.replace(0, CaretStart, front_space);
505 if (!FixItInsertionLine.empty())
506 FixItInsertionLine.replace(0, CaretStart, front_space);
507 }
508 }
509
510 /// Skip over whitespace in the string, starting at the given
511 /// index.
512 ///
513 /// \returns The index of the first non-whitespace character that is
514 /// greater than or equal to Idx or, if no such character exists,
515 /// returns the end of the string.
516 static unsigned skipWhitespace(unsigned Idx, StringRef Str, unsigned Length) {
517 while (Idx < Length && isWhitespace(Str[Idx]))
518 ++Idx;
519 return Idx;
520 }
521
522 /// If the given character is the start of some kind of
523 /// balanced punctuation (e.g., quotes or parentheses), return the
524 /// character that will terminate the punctuation.
525 ///
526 /// \returns The ending punctuation character, if any, or the NULL
527 /// character if the input character does not start any punctuation.
528 static inline char findMatchingPunctuation(char c) {
529 switch (c) {
530 case '\'': return '\'';
531 case '`': return '\'';
532 case '"': return '"';
533 case '(': return ')';
534 case '[': return ']';
535 case '{': return '}';
536 default: break;
537 }
538
539 return 0;
540 }
541
542 /// Find the end of the word starting at the given offset
543 /// within a string.
544 ///
545 /// \returns the index pointing one character past the end of the
546 /// word.
547 static unsigned findEndOfWord(unsigned Start, StringRef Str,
548 unsigned Length, unsigned Column,
549 unsigned Columns) {
550 assert(Start < Str.size() && "Invalid start position!");
551 unsigned End = Start + 1;
552
553 // If we are already at the end of the string, take that as the word.
554 if (End == Str.size())
555 return End;
556
557 // Determine if the start of the string is actually opening
558 // punctuation, e.g., a quote or parentheses.
559 char EndPunct = findMatchingPunctuation(Str[Start]);
560 if (!EndPunct) {
561 // This is a normal word. Just find the first space character.
562 while (End < Length && !isWhitespace(Str[End]))
563 ++End;
564 return End;
565 }
566
567 // We have the start of a balanced punctuation sequence (quotes,
568 // parentheses, etc.). Determine the full sequence is.
569 SmallString<16> PunctuationEndStack;
570 PunctuationEndStack.push_back(EndPunct);
571 while (End < Length && !PunctuationEndStack.empty()) {
572 if (Str[End] == PunctuationEndStack.back())
573 PunctuationEndStack.pop_back();
574 else if (char SubEndPunct = findMatchingPunctuation(Str[End]))
575 PunctuationEndStack.push_back(SubEndPunct);
576
577 ++End;
578 }
579
580 // Find the first space character after the punctuation ended.
581 while (End < Length && !isWhitespace(Str[End]))
582 ++End;
583
584 unsigned PunctWordLength = End - Start;
585 if (// If the word fits on this line
586 Column + PunctWordLength <= Columns ||
587 // ... or the word is "short enough" to take up the next line
588 // without too much ugly white space
589 PunctWordLength < Columns/3)
590 return End; // Take the whole thing as a single "word".
591
592 // The whole quoted/parenthesized string is too long to print as a
593 // single "word". Instead, find the "word" that starts just after
594 // the punctuation and use that end-point instead. This will recurse
595 // until it finds something small enough to consider a word.
596 return findEndOfWord(Start + 1, Str, Length, Column + 1, Columns);
597 }
598
599 /// Print the given string to a stream, word-wrapping it to
600 /// some number of columns in the process.
601 ///
602 /// \param OS the stream to which the word-wrapping string will be
603 /// emitted.
604 /// \param Str the string to word-wrap and output.
605 /// \param Columns the number of columns to word-wrap to.
606 /// \param Column the column number at which the first character of \p
607 /// Str will be printed. This will be non-zero when part of the first
608 /// line has already been printed.
609 /// \param Bold if the current text should be bold
610 /// \param Indentation the number of spaces to indent any lines beyond
611 /// the first line.
612 /// \returns true if word-wrapping was required, or false if the
613 /// string fit on the first line.
614 static bool printWordWrapped(raw_ostream &OS, StringRef Str,
615 unsigned Columns,
616 unsigned Column = 0,
617 bool Bold = false,
618 unsigned Indentation = WordWrapIndentation) {
619 const unsigned Length = std::min(Str.find('\n'), Str.size());
620 bool TextNormal = true;
621
622 // The string used to indent each line.
623 SmallString<16> IndentStr;
624 IndentStr.assign(Indentation, ' ');
625 bool Wrapped = false;
626 for (unsigned WordStart = 0, WordEnd; WordStart < Length;
627 WordStart = WordEnd) {
628 // Find the beginning of the next word.
629 WordStart = skipWhitespace(WordStart, Str, Length);
630 if (WordStart == Length)
631 break;
632
633 // Find the end of this word.
634 WordEnd = findEndOfWord(WordStart, Str, Length, Column, Columns);
635
636 // Does this word fit on the current line?
637 unsigned WordLength = WordEnd - WordStart;
638 if (Column + WordLength < Columns) {
639 // This word fits on the current line; print it there.
640 if (WordStart) {
641 OS << ' ';
642 Column += 1;
643 }
644 applyTemplateHighlighting(OS, Str.substr(WordStart, WordLength),
645 TextNormal, Bold);
646 Column += WordLength;
647 continue;
648 }
649
650 // This word does not fit on the current line, so wrap to the next
651 // line.
652 OS << '\n';
653 OS.write(&IndentStr[0], Indentation);
654 applyTemplateHighlighting(OS, Str.substr(WordStart, WordLength),
655 TextNormal, Bold);
656 Column = Indentation + WordLength;
657 Wrapped = true;
658 }
659
660 // Append any remaning text from the message with its existing formatting.
661 applyTemplateHighlighting(OS, Str.substr(Length), TextNormal, Bold);
662
663 assert(TextNormal && "Text highlighted at end of diagnostic message.");
664
665 return Wrapped;
666 }
667
668 TextDiagnostic::TextDiagnostic(raw_ostream &OS,
669 const LangOptions &LangOpts,
670 DiagnosticOptions *DiagOpts)
671 : DiagnosticRenderer(LangOpts, DiagOpts), OS(OS) {}
672
673 TextDiagnostic::~TextDiagnostic() {}
674
675 void TextDiagnostic::emitDiagnosticMessage(
676 FullSourceLoc Loc, PresumedLoc PLoc, DiagnosticsEngine::Level Level,
677 StringRef Message, ArrayRef<clang::CharSourceRange> Ranges,
678 DiagOrStoredDiag D) {
679 uint64_t StartOfLocationInfo = OS.tell();
680
681 // Emit the location of this particular diagnostic.
682 if (Loc.isValid())
683 emitDiagnosticLoc(Loc, PLoc, Level, Ranges);
684
685 if (DiagOpts->ShowColors)
686 OS.resetColor();
687
688 printDiagnosticLevel(OS, Level, DiagOpts->ShowColors,
689 DiagOpts->CLFallbackMode);
690 printDiagnosticMessage(OS,
691 /*IsSupplemental*/ Level == DiagnosticsEngine::Note,
692 Message, OS.tell() - StartOfLocationInfo,
693 DiagOpts->MessageLength, DiagOpts->ShowColors);
694 }
695
696 /*static*/ void
697 TextDiagnostic::printDiagnosticLevel(raw_ostream &OS,
698 DiagnosticsEngine::Level Level,
699 bool ShowColors,
700 bool CLFallbackMode) {
701 if (ShowColors) {
702 // Print diagnostic category in bold and color
703 switch (Level) {
704 case DiagnosticsEngine::Ignored:
705 llvm_unreachable("Invalid diagnostic type");
706 case DiagnosticsEngine::Note: OS.changeColor(noteColor, true); break;
707 case DiagnosticsEngine::Remark: OS.changeColor(remarkColor, true); break;
708 case DiagnosticsEngine::Warning: OS.changeColor(warningColor, true); break;
709 case DiagnosticsEngine::Error: OS.changeColor(errorColor, true); break;
710 case DiagnosticsEngine::Fatal: OS.changeColor(fatalColor, true); break;
711 }
712 }
713
714 switch (Level) {
715 case DiagnosticsEngine::Ignored:
716 llvm_unreachable("Invalid diagnostic type");
717 case DiagnosticsEngine::Note: OS << "note"; break;
718 case DiagnosticsEngine::Remark: OS << "remark"; break;
719 case DiagnosticsEngine::Warning: OS << "warning"; break;
720 case DiagnosticsEngine::Error: OS << "error"; break;
721 case DiagnosticsEngine::Fatal: OS << "fatal error"; break;
722 }
723
724 // In clang-cl /fallback mode, print diagnostics as "error(clang):". This
725 // makes it more clear whether a message is coming from clang or cl.exe,
726 // and it prevents MSBuild from concluding that the build failed just because
727 // there is an "error:" in the output.
728 if (CLFallbackMode)
729 OS << "(clang)";
730
731 OS << ": ";
732
733 if (ShowColors)
734 OS.resetColor();
735 }
736
737 /*static*/
738 void TextDiagnostic::printDiagnosticMessage(raw_ostream &OS,
739 bool IsSupplemental,
740 StringRef Message,
741 unsigned CurrentColumn,
742 unsigned Columns, bool ShowColors) {
743 bool Bold = false;
744 if (ShowColors && !IsSupplemental) {
745 // Print primary diagnostic messages in bold and without color, to visually
746 // indicate the transition from continuation notes and other output.
747 OS.changeColor(savedColor, true);
748 Bold = true;
749 }
750
751 if (Columns)
752 printWordWrapped(OS, Message, Columns, CurrentColumn, Bold);
753 else {
754 bool Normal = true;
755 applyTemplateHighlighting(OS, Message, Normal, Bold);
756 assert(Normal && "Formatting should have returned to normal");
757 }
758
759 if (ShowColors)
760 OS.resetColor();
761 OS << '\n';
762 }
763
764 void TextDiagnostic::emitFilename(StringRef Filename, const SourceManager &SM) {
765 SmallVector<char, 128> AbsoluteFilename;
766 if (DiagOpts->AbsolutePath) {
767 const DirectoryEntry *Dir = SM.getFileManager().getDirectory(
768 llvm::sys::path::parent_path(Filename));
769 if (Dir) {
770 StringRef DirName = SM.getFileManager().getCanonicalName(Dir);
771 llvm::sys::path::append(AbsoluteFilename, DirName,
772 llvm::sys::path::filename(Filename));
773 Filename = StringRef(AbsoluteFilename.data(), AbsoluteFilename.size());
774 }
775 }
776
777 OS << Filename;
778 }
779
780 /// Print out the file/line/column information and include trace.
781 ///
782 /// This method handlen the emission of the diagnostic location information.
783 /// This includes extracting as much location information as is present for
784 /// the diagnostic and printing it, as well as any include stack or source
785 /// ranges necessary.
786 void TextDiagnostic::emitDiagnosticLoc(FullSourceLoc Loc, PresumedLoc PLoc,
787 DiagnosticsEngine::Level Level,
788 ArrayRef<CharSourceRange> Ranges) {
789 if (PLoc.isInvalid()) {
790 // At least print the file name if available:
791 FileID FID = Loc.getFileID();
792 if (FID.isValid()) {
793 const FileEntry *FE = Loc.getFileEntry();
794 if (FE && FE->isValid()) {
795 emitFilename(FE->getName(), Loc.getManager());
796 if (FE->isInPCH())
797 OS << " (in PCH)";
798 OS << ": ";
799 }
800 }
801 return;
802 }
803 unsigned LineNo = PLoc.getLine();
804
805 if (!DiagOpts->ShowLocation)
806 return;
807
808 if (DiagOpts->ShowColors)
809 OS.changeColor(savedColor, true);
810
811 emitFilename(PLoc.getFilename(), Loc.getManager());
812 switch (DiagOpts->getFormat()) {
813 case DiagnosticOptions::Clang: OS << ':' << LineNo; break;
814 case DiagnosticOptions::MSVC: OS << '(' << LineNo; break;
815 case DiagnosticOptions::Vi: OS << " +" << LineNo; break;
816 }
817
818 if (DiagOpts->ShowColumn)
819 // Compute the column number.
820 if (unsigned ColNo = PLoc.getColumn()) {
821 if (DiagOpts->getFormat() == DiagnosticOptions::MSVC) {
822 OS << ',';
823 // Visual Studio 2010 or earlier expects column number to be off by one
824 if (LangOpts.MSCompatibilityVersion &&
825 !LangOpts.isCompatibleWithMSVC(LangOptions::MSVC2012))
826 ColNo--;
827 } else
828 OS << ':';
829 OS << ColNo;
830 }
831 switch (DiagOpts->getFormat()) {
832 case DiagnosticOptions::Clang:
833 case DiagnosticOptions::Vi: OS << ':'; break;
834 case DiagnosticOptions::MSVC:
835 // MSVC2013 and before print 'file(4) : error'. MSVC2015 gets rid of the
836 // space and prints 'file(4): error'.
837 OS << ')';
838 if (LangOpts.MSCompatibilityVersion &&
839 !LangOpts.isCompatibleWithMSVC(LangOptions::MSVC2015))
840 OS << ' ';
841 OS << ": ";
842 break;
843 }
844
845 if (DiagOpts->ShowSourceRanges && !Ranges.empty()) {
846 FileID CaretFileID = Loc.getExpansionLoc().getFileID();
847 bool PrintedRange = false;
848
849 for (ArrayRef<CharSourceRange>::const_iterator RI = Ranges.begin(),
850 RE = Ranges.end();
851 RI != RE; ++RI) {
852 // Ignore invalid ranges.
853 if (!RI->isValid()) continue;
854
855 auto &SM = Loc.getManager();
856 SourceLocation B = SM.getExpansionLoc(RI->getBegin());
857 CharSourceRange ERange = SM.getExpansionRange(RI->getEnd());
858 SourceLocation E = ERange.getEnd();
859 bool IsTokenRange = ERange.isTokenRange();
860
861 std::pair<FileID, unsigned> BInfo = SM.getDecomposedLoc(B);
862 std::pair<FileID, unsigned> EInfo = SM.getDecomposedLoc(E);
863
864 // If the start or end of the range is in another file, just discard
865 // it.
866 if (BInfo.first != CaretFileID || EInfo.first != CaretFileID)
867 continue;
868
869 // Add in the length of the token, so that we cover multi-char
870 // tokens.
871 unsigned TokSize = 0;
872 if (IsTokenRange)
873 TokSize = Lexer::MeasureTokenLength(E, SM, LangOpts);
874
875 FullSourceLoc BF(B, SM), EF(E, SM);
876 OS << '{'
877 << BF.getLineNumber() << ':' << BF.getColumnNumber() << '-'
878 << EF.getLineNumber() << ':' << (EF.getColumnNumber() + TokSize)
879 << '}';
880 PrintedRange = true;
881 }
882
883 if (PrintedRange)
884 OS << ':';
885 }
886 OS << ' ';
887 }
888
889 void TextDiagnostic::emitIncludeLocation(FullSourceLoc Loc, PresumedLoc PLoc) {
890 if (DiagOpts->ShowLocation && PLoc.isValid())
891 OS << "In file included from " << PLoc.getFilename() << ':'
892 << PLoc.getLine() << ":\n";
893 else
894 OS << "In included file:\n";
895 }
896
897 void TextDiagnostic::emitImportLocation(FullSourceLoc Loc, PresumedLoc PLoc,
898 StringRef ModuleName) {
899 if (DiagOpts->ShowLocation && PLoc.isValid())
900 OS << "In module '" << ModuleName << "' imported from "
901 << PLoc.getFilename() << ':' << PLoc.getLine() << ":\n";
902 else
903 OS << "In module '" << ModuleName << "':\n";
904 }
905
906 void TextDiagnostic::emitBuildingModuleLocation(FullSourceLoc Loc,
907 PresumedLoc PLoc,
908 StringRef ModuleName) {
909 if (DiagOpts->ShowLocation && PLoc.isValid())
910 OS << "While building module '" << ModuleName << "' imported from "
911 << PLoc.getFilename() << ':' << PLoc.getLine() << ":\n";
912 else
913 OS << "While building module '" << ModuleName << "':\n";
914 }
915
916 /// Find the suitable set of lines to show to include a set of ranges.
917 static llvm::Optional<std::pair<unsigned, unsigned>>
918 findLinesForRange(const CharSourceRange &R, FileID FID,
919 const SourceManager &SM) {
920 if (!R.isValid()) return None;
921
922 SourceLocation Begin = R.getBegin();
923 SourceLocation End = R.getEnd();
924 if (SM.getFileID(Begin) != FID || SM.getFileID(End) != FID)
925 return None;
926
927 return std::make_pair(SM.getExpansionLineNumber(Begin),
928 SM.getExpansionLineNumber(End));
929 }
930
931 /// Add as much of range B into range A as possible without exceeding a maximum
932 /// size of MaxRange. Ranges are inclusive.
933 static std::pair<unsigned, unsigned>
934 maybeAddRange(std::pair<unsigned, unsigned> A, std::pair<unsigned, unsigned> B,
935 unsigned MaxRange) {
936 // If A is already the maximum size, we're done.
937 unsigned Slack = MaxRange - (A.second - A.first + 1);
938 if (Slack == 0)
939 return A;
940
941 // Easy case: merge succeeds within MaxRange.
942 unsigned Min = std::min(A.first, B.first);
943 unsigned Max = std::max(A.second, B.second);
944 if (Max - Min + 1 <= MaxRange)
945 return {Min, Max};
946
947 // If we can't reach B from A within MaxRange, there's nothing to do.
948 // Don't add lines to the range that contain nothing interesting.
949 if ((B.first > A.first && B.first - A.first + 1 > MaxRange) ||
950 (B.second < A.second && A.second - B.second + 1 > MaxRange))
951 return A;
952
953 // Otherwise, expand A towards B to produce a range of size MaxRange. We
954 // attempt to expand by the same amount in both directions if B strictly
955 // contains A.
956
957 // Expand downwards by up to half the available amount, then upwards as
958 // much as possible, then downwards as much as possible.
959 A.second = std::min(A.second + (Slack + 1) / 2, Max);
960 Slack = MaxRange - (A.second - A.first + 1);
961 A.first = std::max(Min + Slack, A.first) - Slack;
962 A.second = std::min(A.first + MaxRange - 1, Max);
963 return A;
964 }
965
966 /// Highlight a SourceRange (with ~'s) for any characters on LineNo.
967 static void highlightRange(const CharSourceRange &R,
968 unsigned LineNo, FileID FID,
969 const SourceColumnMap &map,
970 std::string &CaretLine,
971 const SourceManager &SM,
972 const LangOptions &LangOpts) {
973 if (!R.isValid()) return;
974
975 SourceLocation Begin = R.getBegin();
976 SourceLocation End = R.getEnd();
977
978 unsigned StartLineNo = SM.getExpansionLineNumber(Begin);
979 if (StartLineNo > LineNo || SM.getFileID(Begin) != FID)
980 return; // No intersection.
981
982 unsigned EndLineNo = SM.getExpansionLineNumber(End);
983 if (EndLineNo < LineNo || SM.getFileID(End) != FID)
984 return; // No intersection.
985
986 // Compute the column number of the start.
987 unsigned StartColNo = 0;
988 if (StartLineNo == LineNo) {
989 StartColNo = SM.getExpansionColumnNumber(Begin);
990 if (StartColNo) --StartColNo; // Zero base the col #.
991 }
992
993 // Compute the column number of the end.
994 unsigned EndColNo = map.getSourceLine().size();
995 if (EndLineNo == LineNo) {
996 EndColNo = SM.getExpansionColumnNumber(End);
997 if (EndColNo) {
998 --EndColNo; // Zero base the col #.
999
1000 // Add in the length of the token, so that we cover multi-char tokens if
1001 // this is a token range.
1002 if (R.isTokenRange())
1003 EndColNo += Lexer::MeasureTokenLength(End, SM, LangOpts);
1004 } else {
1005 EndColNo = CaretLine.size();
1006 }
1007 }
1008
1009 assert(StartColNo <= EndColNo && "Invalid range!");
1010
1011 // Check that a token range does not highlight only whitespace.
1012 if (R.isTokenRange()) {
1013 // Pick the first non-whitespace column.
1014 while (StartColNo < map.getSourceLine().size() &&
1015 (map.getSourceLine()[StartColNo] == ' ' ||
1016 map.getSourceLine()[StartColNo] == '\t'))
1017 StartColNo = map.startOfNextColumn(StartColNo);
1018
1019 // Pick the last non-whitespace column.
1020 if (EndColNo > map.getSourceLine().size())
1021 EndColNo = map.getSourceLine().size();
1022 while (EndColNo &&
1023 (map.getSourceLine()[EndColNo-1] == ' ' ||
1024 map.getSourceLine()[EndColNo-1] == '\t'))
1025 EndColNo = map.startOfPreviousColumn(EndColNo);
1026
1027 // If the start/end passed each other, then we are trying to highlight a
1028 // range that just exists in whitespace. That most likely means we have
1029 // a multi-line highlighting range that covers a blank line.
1030 if (StartColNo > EndColNo) {
1031 assert(StartLineNo != EndLineNo && "trying to highlight whitespace");
1032 StartColNo = EndColNo;
1033 }
1034 }
1035
1036 assert(StartColNo <= map.getSourceLine().size() && "Invalid range!");
1037 assert(EndColNo <= map.getSourceLine().size() && "Invalid range!");
1038
1039 // Fill the range with ~'s.
1040 StartColNo = map.byteToContainingColumn(StartColNo);
1041 EndColNo = map.byteToContainingColumn(EndColNo);
1042
1043 assert(StartColNo <= EndColNo && "Invalid range!");
1044 if (CaretLine.size() < EndColNo)
1045 CaretLine.resize(EndColNo,' ');
1046 std::fill(CaretLine.begin()+StartColNo,CaretLine.begin()+EndColNo,'~');
1047 }
1048
1049 static std::string buildFixItInsertionLine(FileID FID,
1050 unsigned LineNo,
1051 const SourceColumnMap &map,
1052 ArrayRef<FixItHint> Hints,
1053 const SourceManager &SM,
1054 const DiagnosticOptions *DiagOpts) {
1055 std::string FixItInsertionLine;
1056 if (Hints.empty() || !DiagOpts->ShowFixits)
1057 return FixItInsertionLine;
1058 unsigned PrevHintEndCol = 0;
1059
1060 for (ArrayRef<FixItHint>::iterator I = Hints.begin(), E = Hints.end();
1061 I != E; ++I) {
1062 if (!I->CodeToInsert.empty()) {
1063 // We have an insertion hint. Determine whether the inserted
1064 // code contains no newlines and is on the same line as the caret.
1065 std::pair<FileID, unsigned> HintLocInfo
1066 = SM.getDecomposedExpansionLoc(I->RemoveRange.getBegin());
1067 if (FID == HintLocInfo.first &&
1068 LineNo == SM.getLineNumber(HintLocInfo.first, HintLocInfo.second) &&
1069 StringRef(I->CodeToInsert).find_first_of("\n\r") == StringRef::npos) {
1070 // Insert the new code into the line just below the code
1071 // that the user wrote.
1072 // Note: When modifying this function, be very careful about what is a
1073 // "column" (printed width, platform-dependent) and what is a
1074 // "byte offset" (SourceManager "column").
1075 unsigned HintByteOffset
1076 = SM.getColumnNumber(HintLocInfo.first, HintLocInfo.second) - 1;
1077
1078 // The hint must start inside the source or right at the end
1079 assert(HintByteOffset < static_cast<unsigned>(map.bytes())+1);
1080 unsigned HintCol = map.byteToContainingColumn(HintByteOffset);
1081
1082 // If we inserted a long previous hint, push this one forwards, and add
1083 // an extra space to show that this is not part of the previous
1084 // completion. This is sort of the best we can do when two hints appear
1085 // to overlap.
1086 //
1087 // Note that if this hint is located immediately after the previous
1088 // hint, no space will be added, since the location is more important.
1089 if (HintCol < PrevHintEndCol)
1090 HintCol = PrevHintEndCol + 1;
1091
1092 // This should NOT use HintByteOffset, because the source might have
1093 // Unicode characters in earlier columns.
1094 unsigned NewFixItLineSize = FixItInsertionLine.size() +
1095 (HintCol - PrevHintEndCol) + I->CodeToInsert.size();
1096 if (NewFixItLineSize > FixItInsertionLine.size())
1097 FixItInsertionLine.resize(NewFixItLineSize, ' ');
1098
1099 std::copy(I->CodeToInsert.begin(), I->CodeToInsert.end(),
1100 FixItInsertionLine.end() - I->CodeToInsert.size());
1101
1102 PrevHintEndCol =
1103 HintCol + llvm::sys::locale::columnWidth(I->CodeToInsert);
1104 }
1105 }
1106 }
1107
1108 expandTabs(FixItInsertionLine, DiagOpts->TabStop);
1109
1110 return FixItInsertionLine;
1111 }
1112
1113 /// Emit a code snippet and caret line.
1114 ///
1115 /// This routine emits a single line's code snippet and caret line..
1116 ///
1117 /// \param Loc The location for the caret.
1118 /// \param Ranges The underlined ranges for this code snippet.
1119 /// \param Hints The FixIt hints active for this diagnostic.
1120 void TextDiagnostic::emitSnippetAndCaret(
1121 FullSourceLoc Loc, DiagnosticsEngine::Level Level,
1122 SmallVectorImpl<CharSourceRange> &Ranges, ArrayRef<FixItHint> Hints) {
1123 assert(Loc.isValid() && "must have a valid source location here");
1124 assert(Loc.isFileID() && "must have a file location here");
1125
1126 // If caret diagnostics are enabled and we have location, we want to
1127 // emit the caret. However, we only do this if the location moved
1128 // from the last diagnostic, if the last diagnostic was a note that
1129 // was part of a different warning or error diagnostic, or if the
1130 // diagnostic has ranges. We don't want to emit the same caret
1131 // multiple times if one loc has multiple diagnostics.
1132 if (!DiagOpts->ShowCarets)
1133 return;
1134 if (Loc == LastLoc && Ranges.empty() && Hints.empty() &&
1135 (LastLevel != DiagnosticsEngine::Note || Level == LastLevel))
1136 return;
1137
1138 // Decompose the location into a FID/Offset pair.
1139 std::pair<FileID, unsigned> LocInfo = Loc.getDecomposedLoc();
1140 FileID FID = LocInfo.first;
1141 const SourceManager &SM = Loc.getManager();
1142
1143 // Get information about the buffer it points into.
1144 bool Invalid = false;
1145 StringRef BufData = Loc.getBufferData(&Invalid);
1146 if (Invalid)
1147 return;
1148
1149 unsigned CaretLineNo = Loc.getLineNumber();
1150 unsigned CaretColNo = Loc.getColumnNumber();
1151
1152 // Arbitrarily stop showing snippets when the line is too long.
1153 static const size_t MaxLineLengthToPrint = 4096;
1154 if (CaretColNo > MaxLineLengthToPrint)
1155 return;
1156
1157 // Find the set of lines to include.
1158 const unsigned MaxLines = DiagOpts->SnippetLineLimit;
1159 std::pair<unsigned, unsigned> Lines = {CaretLineNo, CaretLineNo};
1160 for (SmallVectorImpl<CharSourceRange>::iterator I = Ranges.begin(),
1161 E = Ranges.end();
1162 I != E; ++I)
1163 if (auto OptionalRange = findLinesForRange(*I, FID, SM))
1164 Lines = maybeAddRange(Lines, *OptionalRange, MaxLines);
1165
1166 for (unsigned LineNo = Lines.first; LineNo != Lines.second + 1; ++LineNo) {
1167 const char *BufStart = BufData.data();
1168 const char *BufEnd = BufStart + BufData.size();
1169
1170 // Rewind from the current position to the start of the line.
1171 const char *LineStart =
1172 BufStart +
1173 SM.getDecomposedLoc(SM.translateLineCol(FID, LineNo, 1)).second;
1174 if (LineStart == BufEnd)
1175 break;
1176
1177 // Compute the line end.
1178 const char *LineEnd = LineStart;
1179 while (*LineEnd != '\n' && *LineEnd != '\r' && LineEnd != BufEnd)
1180 ++LineEnd;
1181
1182 // Arbitrarily stop showing snippets when the line is too long.
1183 // FIXME: Don't print any lines in this case.
1184 if (size_t(LineEnd - LineStart) > MaxLineLengthToPrint)
1185 return;
1186
1187 // Trim trailing null-bytes.
1188 StringRef Line(LineStart, LineEnd - LineStart);
1189 while (!Line.empty() && Line.back() == '\0' &&
1190 (LineNo != CaretLineNo || Line.size() > CaretColNo))
1191 Line = Line.drop_back();
1192
1193 // Copy the line of code into an std::string for ease of manipulation.
1194 std::string SourceLine(Line.begin(), Line.end());
1195
1196 // Build the byte to column map.
1197 const SourceColumnMap sourceColMap(SourceLine, DiagOpts->TabStop);
1198
1199 // Create a line for the caret that is filled with spaces that is the same
1200 // number of columns as the line of source code.
1201 std::string CaretLine(sourceColMap.columns(), ' ');
1202
1203 // Highlight all of the characters covered by Ranges with ~ characters.
1204 for (SmallVectorImpl<CharSourceRange>::iterator I = Ranges.begin(),
1205 E = Ranges.end();
1206 I != E; ++I)
1207 highlightRange(*I, LineNo, FID, sourceColMap, CaretLine, SM, LangOpts);
1208
1209 // Next, insert the caret itself.
1210 if (CaretLineNo == LineNo) {
1211 CaretColNo = sourceColMap.byteToContainingColumn(CaretColNo - 1);
1212 if (CaretLine.size() < CaretColNo + 1)
1213 CaretLine.resize(CaretColNo + 1, ' ');
1214 CaretLine[CaretColNo] = '^';
1215 }
1216
1217 std::string FixItInsertionLine = buildFixItInsertionLine(
1218 FID, LineNo, sourceColMap, Hints, SM, DiagOpts.get());
1219
1220 // If the source line is too long for our terminal, select only the
1221 // "interesting" source region within that line.
1222 unsigned Columns = DiagOpts->MessageLength;
1223 if (Columns)
1224 selectInterestingSourceRegion(SourceLine, CaretLine, FixItInsertionLine,
1225 Columns, sourceColMap);
1226
1227 // If we are in -fdiagnostics-print-source-range-info mode, we are trying
1228 // to produce easily machine parsable output. Add a space before the
1229 // source line and the caret to make it trivial to tell the main diagnostic
1230 // line from what the user is intended to see.
1231 if (DiagOpts->ShowSourceRanges) {
1232 SourceLine = ' ' + SourceLine;
1233 CaretLine = ' ' + CaretLine;
1234 }
1235
1236 // Finally, remove any blank spaces from the end of CaretLine.
1237 while (!CaretLine.empty() && CaretLine[CaretLine.size() - 1] == ' ')
1238 CaretLine.erase(CaretLine.end() - 1);
1239
1240 // Emit what we have computed.
1241 emitSnippet(SourceLine);
1242
1243 if (!CaretLine.empty()) {
1244 if (DiagOpts->ShowColors)
1245 OS.changeColor(caretColor, true);
1246 OS << CaretLine << '\n';
1247 if (DiagOpts->ShowColors)
1248 OS.resetColor();
1249 }
1250
1251 if (!FixItInsertionLine.empty()) {
1252 if (DiagOpts->ShowColors)
1253 // Print fixit line in color
1254 OS.changeColor(fixitColor, false);
1255 if (DiagOpts->ShowSourceRanges)
1256 OS << ' ';
1257 OS << FixItInsertionLine << '\n';
1258 if (DiagOpts->ShowColors)
1259 OS.resetColor();
1260 }
1261 }
1262
1263 // Print out any parseable fixit information requested by the options.
1264 emitParseableFixits(Hints, SM);
1265 }
1266
1267 void TextDiagnostic::emitSnippet(StringRef line) {
1268 if (line.empty())
1269 return;
1270
1271 size_t i = 0;
1272
1273 std::string to_print;
1274 bool print_reversed = false;
1275
1276 while (i<line.size()) {
1277 std::pair<SmallString<16>,bool> res
1278 = printableTextForNextCharacter(line, &i, DiagOpts->TabStop);
1279 bool was_printable = res.second;
1280
1281 if (DiagOpts->ShowColors && was_printable == print_reversed) {
1282 if (print_reversed)
1283 OS.reverseColor();
1284 OS << to_print;
1285 to_print.clear();
1286 if (DiagOpts->ShowColors)
1287 OS.resetColor();
1288 }
1289
1290 print_reversed = !was_printable;
1291 to_print += res.first.str();
1292 }
1293
1294 if (print_reversed && DiagOpts->ShowColors)
1295 OS.reverseColor();
1296 OS << to_print;
1297 if (print_reversed && DiagOpts->ShowColors)
1298 OS.resetColor();
1299
1300 OS << '\n';
1301 }
1302
1303 void TextDiagnostic::emitParseableFixits(ArrayRef<FixItHint> Hints,
1304 const SourceManager &SM) {
1305 if (!DiagOpts->ShowParseableFixits)
1306 return;
1307
1308 // We follow FixItRewriter's example in not (yet) handling
1309 // fix-its in macros.
1310 for (ArrayRef<FixItHint>::iterator I = Hints.begin(), E = Hints.end();
1311 I != E; ++I) {
1312 if (I->RemoveRange.isInvalid() ||
1313 I->RemoveRange.getBegin().isMacroID() ||
1314 I->RemoveRange.getEnd().isMacroID())
1315 return;
1316 }
1317
1318 for (ArrayRef<FixItHint>::iterator I = Hints.begin(), E = Hints.end();
1319 I != E; ++I) {
1320 SourceLocation BLoc = I->RemoveRange.getBegin();
1321 SourceLocation ELoc = I->RemoveRange.getEnd();
1322
1323 std::pair<FileID, unsigned> BInfo = SM.getDecomposedLoc(BLoc);
1324 std::pair<FileID, unsigned> EInfo = SM.getDecomposedLoc(ELoc);
1325
1326 // Adjust for token ranges.
1327 if (I->RemoveRange.isTokenRange())
1328 EInfo.second += Lexer::MeasureTokenLength(ELoc, SM, LangOpts);
1329
1330 // We specifically do not do word-wrapping or tab-expansion here,
1331 // because this is supposed to be easy to parse.
1332 PresumedLoc PLoc = SM.getPresumedLoc(BLoc);
1333 if (PLoc.isInvalid())
1334 break;
1335
1336 OS << "fix-it:\"";
1337 OS.write_escaped(PLoc.getFilename());
1338 OS << "\":{" << SM.getLineNumber(BInfo.first, BInfo.second)
1339 << ':' << SM.getColumnNumber(BInfo.first, BInfo.second)
1340 << '-' << SM.getLineNumber(EInfo.first, EInfo.second)
1341 << ':' << SM.getColumnNumber(EInfo.first, EInfo.second)
1342 << "}:\"";
1343 OS.write_escaped(I->CodeToInsert);
1344 OS << "\"\n";
1345 }
1346 }
clang::LangOptions::isCompatibleWithMSVC
bool isCompatibleWithMSVC(MSVCMajorVersion MajorVersion) const
Definition: LangOptions.h:281
FileManager.h
Defines the clang::FileManager interface and associated types.
clang::FullSourceLoc::getExpansionLoc
FullSourceLoc getExpansionLoc() const
Definition: SourceLocation.cpp:146
SourceManager.h
Defines the SourceManager interface.
fatalColor
static enum raw_ostream::Colors fatalColor
Definition: TextDiagnostic.cpp:40
clang::SourceManager::getColumnNumber
unsigned getColumnNumber(FileID FID, unsigned FilePos, bool *Invalid=nullptr) const
Return the column # for the specified file position.
Definition: SourceManager.cpp:1118
clang::DiagOrStoredDiag
llvm::PointerUnion< const Diagnostic *, const StoredDiagnostic * > DiagOrStoredDiag
Definition: DiagnosticRenderer.h:34
TextDiagnostic.h
clang::LangOptions::MSVC2012
Definition: LangOptions.h:109
clang::DiagnosticRenderer::LangOpts
const LangOptions & LangOpts
Definition: DiagnosticRenderer.h:50
findEndOfWord
static unsigned findEndOfWord(unsigned Start, StringRef Str, unsigned Length, unsigned Column, unsigned Columns)
Find the end of the word starting at the given offset within a string.
Definition: TextDiagnostic.cpp:547
caretColor
static enum raw_ostream::Colors caretColor
Definition: TextDiagnostic.cpp:33
templateColor
static enum raw_ostream::Colors templateColor
Definition: TextDiagnostic.cpp:37
errorColor
static enum raw_ostream::Colors errorColor
Definition: TextDiagnostic.cpp:39
clang::FullSourceLoc::getFileID
FileID getFileID() const
Definition: SourceLocation.cpp:141
bytes
static StringRef bytes(const std::vector< T, Allocator > &v)
Definition: ASTWriter.cpp:120
fixitColor
static enum raw_ostream::Colors fixitColor
Definition: TextDiagnostic.cpp:31
clang::SourceManager::getFileManager
FileManager & getFileManager() const
Definition: SourceManager.h:759
clang::CharSourceRange::getBegin
SourceLocation getBegin() const
Definition: SourceLocation.h:266
printableTextForNextCharacter
static std::pair< SmallString< 16 >, bool > printableTextForNextCharacter(StringRef SourceLine, size_t *i, unsigned TabStop)
returns a printable representation of first item from input range
Definition: TextDiagnostic.cpp:99
llvm::Optional
Definition: LLVM.h:38
clang::DiagnosticsEngine::Note
Definition: Diagnostic.h:154
clang::LangOptions
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:50
llvm::SmallVectorImpl
Definition: LLVM.h:37
clang::CharSourceRange::isValid
bool isValid() const
Definition: SourceLocation.h:274
clang::DiagnosticRenderer
Class to encapsulate the logic for formatting a diagnostic message.
Definition: DiagnosticRenderer.h:48
clang::DiagnosticOptions::Vi
Definition: DiagnosticOptions.h:66
clang::SourceManager::getDecomposedExpansionLoc
std::pair< FileID, unsigned > getDecomposedExpansionLoc(SourceLocation Loc) const
Decompose the specified location into a raw FileID + Offset pair.
Definition: SourceManager.h:1210
clang::isWhitespace
LLVM_READONLY bool isWhitespace(unsigned char c)
Return true if this character is horizontal or vertical ASCII whitespace: &#39; &#39;, &#39;\t&#39;, &#39;\f&#39;, &#39;\v&#39;, &#39;\n&#39;, &#39;\r&#39;.
Definition: CharInfo.h:88
maybeAddRange
static std::pair< unsigned, unsigned > maybeAddRange(std::pair< unsigned, unsigned > A, std::pair< unsigned, unsigned > B, unsigned MaxRange)
Add as much of range B into range A as possible without exceeding a maximum size of MaxRange...
Definition: TextDiagnostic.cpp:934
clang::SourceManager::getExpansionLoc
SourceLocation getExpansionLoc(SourceLocation Loc) const
Given a SourceLocation object Loc, return the expansion location referenced by the ID...
Definition: SourceManager.h:1117
selectInterestingSourceRegion
static void selectInterestingSourceRegion(std::string &SourceLine, std::string &CaretLine, std::string &FixItInsertionLine, unsigned Columns, const SourceColumnMap &map)
When the source code line we want to print is too long for the terminal, select the "interesting" reg...
Definition: TextDiagnostic.cpp:322
clang::TextDiagnostic::emitDiagnosticMessage
void emitDiagnosticMessage(FullSourceLoc Loc, PresumedLoc PLoc, DiagnosticsEngine::Level Level, StringRef Message, ArrayRef< CharSourceRange > Ranges, DiagOrStoredDiag D) override
Definition: TextDiagnostic.cpp:675
printWordWrapped
static bool printWordWrapped(raw_ostream &OS, StringRef Str, unsigned Columns, unsigned Column=0, bool Bold=false, unsigned Indentation=WordWrapIndentation)
Print the given string to a stream, word-wrapping it to some number of columns in the process...
Definition: TextDiagnostic.cpp:614
clang::DiagnosticRenderer::LastLevel
DiagnosticsEngine::Level LastLevel
The level of the last diagnostic emitted.
Definition: DiagnosticRenderer.h:70
clang::SourceLocation::isFileID
bool isFileID() const
Definition: SourceLocation.h:100
clang::TextDiagnostic::TextDiagnostic
TextDiagnostic(raw_ostream &OS, const LangOptions &LangOpts, DiagnosticOptions *DiagOpts)
Definition: TextDiagnostic.cpp:668
llvm::ArrayRef
Definition: LLVM.h:32
clang::TextDiagnostic::emitBuildingModuleLocation
void emitBuildingModuleLocation(FullSourceLoc Loc, PresumedLoc PLoc, StringRef ModuleName) override
Definition: TextDiagnostic.cpp:906
llvm::SmallString
Definition: LLVM.h:35
skipWhitespace
static unsigned skipWhitespace(unsigned Idx, StringRef Str, unsigned Length)
Skip over whitespace in the string, starting at the given index.
Definition: TextDiagnostic.cpp:516
clang::TextDiagnostic::~TextDiagnostic
~TextDiagnostic() override
Definition: TextDiagnostic.cpp:673
clang::TextDiagnostic::emitIncludeLocation
void emitIncludeLocation(FullSourceLoc Loc, PresumedLoc PLoc) override
Definition: TextDiagnostic.cpp:889
CharInfo.h
clang::FullSourceLoc::getColumnNumber
unsigned getColumnNumber(bool *Invalid=nullptr) const
Definition: SourceLocation.cpp:198
clang::FileManager::getDirectory
const DirectoryEntry * getDirectory(StringRef DirName, bool CacheFailure=true)
Lookup, cache, and verify the specified directory (real or virtual).
Definition: FileManager.cpp:119
Filename
StringRef Filename
Definition: Format.cpp:1629
clang::FileID::isValid
bool isValid() const
Definition: SourceLocation.h:46
clang::DiagnosticsEngine::Ignored
Definition: Diagnostic.h:153
clang::PresumedLoc::isValid
bool isValid() const
Definition: SourceLocation.h:300
End
SourceLocation End
Definition: USRLocFinder.cpp:167
clang::CharSourceRange
Represents a character-granular source range.
Definition: SourceLocation.h:236
clang::FullSourceLoc::getFileEntry
const FileEntry * getFileEntry() const
Definition: SourceLocation.cpp:203
clang::PresumedLoc::isInvalid
bool isInvalid() const
Return true if this object is invalid or uninitialized.
Definition: SourceLocation.h:299
clang::FullSourceLoc::getDecomposedLoc
std::pair< FileID, unsigned > getDecomposedLoc() const
Decompose the specified location into a raw FileID + Offset pair.
Definition: SourceLocation.cpp:252
clang::Lexer::MeasureTokenLength
static unsigned MeasureTokenLength(SourceLocation Loc, const SourceManager &SM, const LangOptions &LangOpts)
MeasureTokenLength - Relex the token at the specified location and return its length in bytes in the ...
Definition: Lexer.cpp:436
Line
const AnnotatedLine * Line
Definition: UsingDeclarationsSorter.cpp:69
clang::PresumedLoc::getLine
unsigned getLine() const
Return the presumed line number of this location.
Definition: SourceLocation.h:313
clang::FullSourceLoc::getLineNumber
unsigned getLineNumber(bool *Invalid=nullptr) const
Definition: SourceLocation.cpp:193
findLinesForRange
static llvm::Optional< std::pair< unsigned, unsigned > > findLinesForRange(const CharSourceRange &R, FileID FID, const SourceManager &SM)
Find the suitable set of lines to show to include a set of ranges.
Definition: TextDiagnostic.cpp:918
clang::FullSourceLoc::getManager
const SourceManager & getManager() const
Definition: SourceLocation.h:357
Begin
SourceLocation Begin
Definition: USRLocFinder.cpp:165
Lexer.h
clang::TextDiagnostic::emitDiagnosticLoc
void emitDiagnosticLoc(FullSourceLoc Loc, PresumedLoc PLoc, DiagnosticsEngine::Level Level, ArrayRef< CharSourceRange > Ranges) override
Print out the file/line/column information and include trace.
Definition: TextDiagnostic.cpp:786
clang::format::encoding::columnWidth
unsigned columnWidth(StringRef Text, Encoding Encoding)
Returns the number of columns required to display the Text on a generic Unicode-capable terminal...
Definition: Encoding.h:46
clang::DiagnosticRenderer::DiagOpts
IntrusiveRefCntPtr< DiagnosticOptions > DiagOpts
Definition: DiagnosticRenderer.h:51
clang::PresumedLoc
Represents an unpacked "presumed" location which can be presented to the user.
Definition: SourceLocation.h:285
buildFixItInsertionLine
static std::string buildFixItInsertionLine(FileID FID, unsigned LineNo, const SourceColumnMap &map, ArrayRef< FixItHint > Hints, const SourceManager &SM, const DiagnosticOptions *DiagOpts)
Definition: TextDiagnostic.cpp:1049
clang::SourceManager::getExpansionLineNumber
unsigned getExpansionLineNumber(SourceLocation Loc, bool *Invalid=nullptr) const
Definition: SourceManager.cpp:1348
bytesSincePreviousTabOrLineBegin
static int bytesSincePreviousTabOrLineBegin(StringRef SourceLine, size_t i)
Definition: TextDiagnostic.cpp:69
SM
const SourceManager & SM
Definition: Format.cpp:1490
warningColor
static enum raw_ostream::Colors warningColor
Definition: TextDiagnostic.cpp:35
noteColor
static enum raw_ostream::Colors noteColor
Definition: TextDiagnostic.cpp:27
clang::PresumedLoc::getFilename
const char * getFilename() const
Return the presumed filename of this location.
Definition: SourceLocation.h:305
clang::PresumedLoc::getColumn
unsigned getColumn() const
Return the presumed column number of this location.
Definition: SourceLocation.h:321
clang::SourceLocation
Encodes a location in the source.
Definition: SourceLocation.h:88
clang::FileEntry::getName
StringRef getName() const
Definition: FileManager.h:85
clang::DiagnosticOptions
Options for controlling the compiler diagnostics engine.
Definition: DiagnosticOptions.h:64
highlightRange
static void highlightRange(const CharSourceRange &R, unsigned LineNo, FileID FID, const SourceColumnMap &map, std::string &CaretLine, const SourceManager &SM, const LangOptions &LangOpts)
Highlight a SourceRange (with ~&#39;s) for any characters on LineNo.
Definition: TextDiagnostic.cpp:967
clang::TextDiagnostic::printDiagnosticLevel
static void printDiagnosticLevel(raw_ostream &OS, DiagnosticsEngine::Level Level, bool ShowColors, bool CLFallbackMode=false)
Print the diagonstic level to a raw_ostream.
Definition: TextDiagnostic.cpp:697
clang::FileEntry
Cached information about one file (either on disk or in the virtual file system). ...
Definition: FileManager.h:60
clang::ToggleHighlight
const char ToggleHighlight
Special character that the diagnostic printer will use to toggle the bold attribute.
Definition: Diagnostic.h:1584
clang::TextDiagnostic::printDiagnosticMessage
static void printDiagnosticMessage(raw_ostream &OS, bool IsSupplemental, StringRef Message, unsigned CurrentColumn, unsigned Columns, bool ShowColors)
Pretty-print a diagnostic message to a raw_ostream.
Definition: TextDiagnostic.cpp:738
clang::SourceManager::getLineNumber
unsigned getLineNumber(FileID FID, unsigned FilePos, bool *Invalid=nullptr) const
Given a SourceLocation, return the spelling line number for the position indicated.
Definition: SourceManager.cpp:1248
clang::DiagnosticsEngine::Remark
Definition: Diagnostic.h:155
llvm::SmallVector
Definition: LLVM.h:36
byteToColumn
static void byteToColumn(StringRef SourceLine, unsigned TabStop, SmallVectorImpl< int > &out)
This function takes a raw source line and produces a mapping from the bytes of the printable represen...
Definition: TextDiagnostic.cpp:198
clang::FullSourceLoc::getBufferData
StringRef getBufferData(bool *Invalid=nullptr) const
Return a StringRef to the source buffer data for the specified FileID.
Definition: SourceLocation.cpp:247
WordWrapIndentation
const unsigned WordWrapIndentation
Number of spaces to indent when word-wrapping.
Definition: TextDiagnostic.cpp:67
findMatchingPunctuation
static char findMatchingPunctuation(char c)
If the given character is the start of some kind of balanced punctuation (e.g., quotes or parentheses...
Definition: TextDiagnostic.cpp:528
clang::MultiVersionKind::None
clang::CharSourceRange::isTokenRange
bool isTokenRange() const
Return true if the end of this range specifies the start of the last token.
Definition: SourceLocation.h:263
expandTabs
static void expandTabs(std::string &SourceLine, unsigned TabStop)
Definition: TextDiagnostic.cpp:163
clang::FileID
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
Definition: SourceLocation.h:40
clang::SourceManager::getExpansionColumnNumber
unsigned getExpansionColumnNumber(SourceLocation Loc, bool *Invalid=nullptr) const
Definition: SourceManager.cpp:1180
clang::FileManager::getCanonicalName
StringRef getCanonicalName(const DirectoryEntry *Dir)
Retrieve the canonical name for a given directory.
Definition: FileManager.cpp:510
clang::FileEntry::isValid
bool isValid() const
Definition: FileManager.h:87
clang::DiagnosticRenderer::LastLoc
SourceLocation LastLoc
The location of the previous diagnostic if known.
Definition: DiagnosticRenderer.h:58
clang
Dataflow Directional Tag Classes.
Definition: CFGReachabilityAnalysis.h:22
clang::SourceLocation::isValid
bool isValid() const
Return true if this is a valid SourceLocation object.
Definition: SourceLocation.h:108
applyTemplateHighlighting
static void applyTemplateHighlighting(raw_ostream &OS, StringRef Str, bool &Normal, bool Bold)
Add highlights to differences in template strings.
Definition: TextDiagnostic.cpp:46
clang::FileEntry::isInPCH
bool isInPCH() const
Definition: FileManager.h:91
clang::DiagnosticOptions::MSVC
Definition: DiagnosticOptions.h:66
columnToByte
static void columnToByte(StringRef SourceLine, unsigned TabStop, SmallVectorImpl< int > &out)
This function takes a raw source line and produces a mapping from columns to the byte of the source l...
Definition: TextDiagnostic.cpp:232
clang::SourceManager::getPresumedLoc
PresumedLoc getPresumedLoc(SourceLocation Loc, bool UseLineDirectives=true) const
Returns the "presumed" location of a SourceLocation specifies.
Definition: SourceManager.cpp:1414
clang::SourceManager::translateLineCol
SourceLocation translateLineCol(FileID FID, unsigned Line, unsigned Col) const
Get the source location in FID for the given line:col.
Definition: SourceManager.cpp:1680
clang::DiagnosticsEngine::Warning
Definition: Diagnostic.h:156
clang::SourceManager::getFileID
FileID getFileID(SourceLocation SpellingLoc) const
Return the FileID for a SourceLocation.
Definition: SourceManager.h:1048
clang::DiagnosticsEngine::Error
Definition: Diagnostic.h:157
clang::CharSourceRange::getEnd
SourceLocation getEnd() const
Definition: SourceLocation.h:267
clang::SourceManager::getExpansionRange
CharSourceRange getExpansionRange(SourceLocation Loc) const
Given a SourceLocation object, return the range of tokens covered by the expansion in the ultimate fi...
Definition: SourceManager.cpp:978
clang::DirectoryEntry
Cached information about one directory (either on disk or in the virtual file system).
Definition: FileManager.h:46
clang::DiagnosticsEngine::Level
Level
The level of the diagnostic, after it has been through mapping.
Definition: Diagnostic.h:152
remarkColor
static enum raw_ostream::Colors remarkColor
Definition: TextDiagnostic.cpp:29
clang::FullSourceLoc
A SourceLocation and its associated SourceManager.
Definition: SourceLocation.h:340
DiagnosticOptions.h
max
__DEVICE__ int max(int __a, int __b)
Definition: __clang_cuda_device_functions.h:1611
clang::LangOptions::MSVC2015
Definition: LangOptions.h:111
clang::TextDiagnostic::emitImportLocation
void emitImportLocation(FullSourceLoc Loc, PresumedLoc PLoc, StringRef ModuleName) override
Definition: TextDiagnostic.cpp:897
min
__DEVICE__ int min(int __a, int __b)
Definition: __clang_cuda_device_functions.h:1618
clang::prec::Level
Level
Definition: OperatorPrecedence.h:27
savedColor
static enum raw_ostream::Colors savedColor
Definition: TextDiagnostic.cpp:42
clang::DiagnosticOptions::Clang
Definition: DiagnosticOptions.h:66
clang::SourceManager
This class handles loading and caching of source files into memory.
Definition: SourceManager.h:582
clang::DiagnosticOptions::MaxTabStop
Definition: DiagnosticOptions.h:71
clang::SourceManager::getDecomposedLoc
std::pair< FileID, unsigned > getDecomposedLoc(SourceLocation Loc) const
Decompose the specified location into a raw FileID + Offset pair.
Definition: SourceManager.h:1196
clang::DiagnosticsEngine::Fatal
Definition: Diagnostic.h:158