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