annotate clang/lib/Frontend/TextDiagnostic.cpp @ 176:de4ac79aef9d

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