]>
Commit | Line | Data |
---|---|---|
dc9dc135 XL |
1 | //! The current rustc diagnostics emitter. |
2 | //! | |
3 | //! An `Emitter` takes care of generating the output from a `DiagnosticBuilder` struct. | |
4 | //! | |
5 | //! There are various `Emitter` implementations that generate different output formats such as | |
6 | //! JSON and human readable output. | |
7 | //! | |
ba9703b0 | 8 | //! The output types are defined in `rustc_session::config::ErrorOutputType`. |
dc9dc135 | 9 | |
9fa01778 | 10 | use Destination::*; |
1a4d82fc | 11 | |
dfeec247 XL |
12 | use rustc_span::source_map::SourceMap; |
13 | use rustc_span::{MultiSpan, SourceFile, Span}; | |
223e47cc | 14 | |
60c5eb7d XL |
15 | use crate::snippet::{Annotation, AnnotationType, Line, MultilineAnnotation, Style, StyledString}; |
16 | use crate::styled_buffer::StyledBuffer; | |
9fa01778 | 17 | use crate::{ |
60c5eb7d | 18 | pluralize, CodeSuggestion, Diagnostic, DiagnosticId, Level, SubDiagnostic, SuggestionStyle, |
9fa01778 | 19 | }; |
9cc50fc6 | 20 | |
b7449926 | 21 | use rustc_data_structures::fx::FxHashMap; |
0531ce1d | 22 | use rustc_data_structures::sync::Lrc; |
dfeec247 | 23 | use rustc_span::hygiene::{ExpnKind, MacroKind}; |
041b39d2 | 24 | use std::borrow::Cow; |
60c5eb7d | 25 | use std::cmp::{max, min, Reverse}; |
c34b1796 | 26 | use std::io; |
60c5eb7d | 27 | use std::io::prelude::*; |
74b04a01 | 28 | use std::iter; |
48663c56 | 29 | use std::path::Path; |
60c5eb7d XL |
30 | use termcolor::{Ansi, BufferWriter, ColorChoice, ColorSpec, StandardStream}; |
31 | use termcolor::{Buffer, Color, WriteColor}; | |
3dfed10e | 32 | use tracing::*; |
1a4d82fc | 33 | |
f035d41b XL |
34 | /// Default column width, used in tests and when terminal dimensions cannot be determined. |
35 | const DEFAULT_COLUMN_WIDTH: usize = 140; | |
36 | ||
48663c56 XL |
37 | /// Describes the way the content of the `rendered` field of the json output is generated |
38 | #[derive(Clone, Copy, Debug, PartialEq, Eq)] | |
39 | pub enum HumanReadableErrorType { | |
40 | Default(ColorConfig), | |
dc9dc135 | 41 | AnnotateSnippet(ColorConfig), |
48663c56 XL |
42 | Short(ColorConfig), |
43 | } | |
44 | ||
45 | impl HumanReadableErrorType { | |
46 | /// Returns a (`short`, `color`) tuple | |
47 | pub fn unzip(self) -> (bool, ColorConfig) { | |
48 | match self { | |
49 | HumanReadableErrorType::Default(cc) => (false, cc), | |
50 | HumanReadableErrorType::Short(cc) => (true, cc), | |
dc9dc135 | 51 | HumanReadableErrorType::AnnotateSnippet(cc) => (false, cc), |
48663c56 XL |
52 | } |
53 | } | |
54 | pub fn new_emitter( | |
55 | self, | |
56 | dst: Box<dyn Write + Send>, | |
60c5eb7d | 57 | source_map: Option<Lrc<SourceMap>>, |
48663c56 | 58 | teach: bool, |
e1599b0c | 59 | terminal_width: Option<usize>, |
74b04a01 | 60 | macro_backtrace: bool, |
48663c56 XL |
61 | ) -> EmitterWriter { |
62 | let (short, color_config) = self.unzip(); | |
e1599b0c | 63 | let color = color_config.suggests_using_colors(); |
74b04a01 | 64 | EmitterWriter::new(dst, source_map, short, teach, color, terminal_width, macro_backtrace) |
e1599b0c XL |
65 | } |
66 | } | |
67 | ||
68 | #[derive(Clone, Copy, Debug)] | |
69 | struct Margin { | |
70 | /// The available whitespace in the left that can be consumed when centering. | |
71 | pub whitespace_left: usize, | |
72 | /// The column of the beginning of left-most span. | |
73 | pub span_left: usize, | |
74 | /// The column of the end of right-most span. | |
75 | pub span_right: usize, | |
76 | /// The beginning of the line to be displayed. | |
77 | pub computed_left: usize, | |
78 | /// The end of the line to be displayed. | |
79 | pub computed_right: usize, | |
f035d41b XL |
80 | /// The current width of the terminal. Uses value of `DEFAULT_COLUMN_WIDTH` constant by default |
81 | /// and in tests. | |
e1599b0c XL |
82 | pub column_width: usize, |
83 | /// The end column of a span label, including the span. Doesn't account for labels not in the | |
84 | /// same line as the span. | |
85 | pub label_right: usize, | |
86 | } | |
87 | ||
88 | impl Margin { | |
89 | fn new( | |
90 | whitespace_left: usize, | |
91 | span_left: usize, | |
92 | span_right: usize, | |
93 | label_right: usize, | |
94 | column_width: usize, | |
95 | max_line_len: usize, | |
96 | ) -> Self { | |
97 | // The 6 is padding to give a bit of room for `...` when displaying: | |
98 | // ``` | |
99 | // error: message | |
100 | // --> file.rs:16:58 | |
101 | // | | |
102 | // 16 | ... fn foo(self) -> Self::Bar { | |
103 | // | ^^^^^^^^^ | |
104 | // ``` | |
105 | ||
106 | let mut m = Margin { | |
e74abb32 XL |
107 | whitespace_left: whitespace_left.saturating_sub(6), |
108 | span_left: span_left.saturating_sub(6), | |
e1599b0c XL |
109 | span_right: span_right + 6, |
110 | computed_left: 0, | |
111 | computed_right: 0, | |
112 | column_width, | |
113 | label_right: label_right + 6, | |
114 | }; | |
115 | m.compute(max_line_len); | |
116 | m | |
117 | } | |
118 | ||
119 | fn was_cut_left(&self) -> bool { | |
120 | self.computed_left > 0 | |
121 | } | |
122 | ||
123 | fn was_cut_right(&self, line_len: usize) -> bool { | |
60c5eb7d XL |
124 | let right = |
125 | if self.computed_right == self.span_right || self.computed_right == self.label_right { | |
dfeec247 XL |
126 | // Account for the "..." padding given above. Otherwise we end up with code lines that |
127 | // do fit but end in "..." as if they were trimmed. | |
60c5eb7d XL |
128 | self.computed_right - 6 |
129 | } else { | |
130 | self.computed_right | |
131 | }; | |
e74abb32 | 132 | right < line_len && self.computed_left + self.column_width < line_len |
e1599b0c XL |
133 | } |
134 | ||
135 | fn compute(&mut self, max_line_len: usize) { | |
136 | // When there's a lot of whitespace (>20), we want to trim it as it is useless. | |
137 | self.computed_left = if self.whitespace_left > 20 { | |
138 | self.whitespace_left - 16 // We want some padding. | |
139 | } else { | |
140 | 0 | |
141 | }; | |
142 | // We want to show as much as possible, max_line_len is the right-most boundary for the | |
143 | // relevant code. | |
144 | self.computed_right = max(max_line_len, self.computed_left); | |
145 | ||
146 | if self.computed_right - self.computed_left > self.column_width { | |
147 | // Trimming only whitespace isn't enough, let's get craftier. | |
148 | if self.label_right - self.whitespace_left <= self.column_width { | |
149 | // Attempt to fit the code window only trimming whitespace. | |
150 | self.computed_left = self.whitespace_left; | |
151 | self.computed_right = self.computed_left + self.column_width; | |
152 | } else if self.label_right - self.span_left <= self.column_width { | |
153 | // Attempt to fit the code window considering only the spans and labels. | |
154 | let padding_left = (self.column_width - (self.label_right - self.span_left)) / 2; | |
155 | self.computed_left = self.span_left.saturating_sub(padding_left); | |
156 | self.computed_right = self.computed_left + self.column_width; | |
157 | } else if self.span_right - self.span_left <= self.column_width { | |
158 | // Attempt to fit the code window considering the spans and labels plus padding. | |
159 | let padding_left = (self.column_width - (self.span_right - self.span_left)) / 5 * 2; | |
160 | self.computed_left = self.span_left.saturating_sub(padding_left); | |
161 | self.computed_right = self.computed_left + self.column_width; | |
60c5eb7d XL |
162 | } else { |
163 | // Mostly give up but still don't show the full line. | |
e1599b0c XL |
164 | self.computed_left = self.span_left; |
165 | self.computed_right = self.span_right; | |
166 | } | |
167 | } | |
168 | } | |
169 | ||
170 | fn left(&self, line_len: usize) -> usize { | |
171 | min(self.computed_left, line_len) | |
172 | } | |
173 | ||
174 | fn right(&self, line_len: usize) -> usize { | |
e74abb32 | 175 | if line_len.saturating_sub(self.computed_left) <= self.column_width { |
e1599b0c XL |
176 | line_len |
177 | } else { | |
e74abb32 | 178 | min(line_len, self.computed_right) |
e1599b0c | 179 | } |
48663c56 XL |
180 | } |
181 | } | |
182 | ||
0531ce1d XL |
183 | const ANONYMIZED_LINE_NUM: &str = "LL"; |
184 | ||
5bcae85e | 185 | /// Emitter trait for emitting errors. |
9cc50fc6 | 186 | pub trait Emitter { |
9cc50fc6 | 187 | /// Emit a structured diagnostic. |
e74abb32 | 188 | fn emit_diagnostic(&mut self, diag: &Diagnostic); |
48663c56 XL |
189 | |
190 | /// Emit a notification that an artifact has been output. | |
191 | /// This is currently only supported for the JSON format, | |
192 | /// other formats can, and will, simply ignore it. | |
dc9dc135 | 193 | fn emit_artifact_notification(&mut self, _path: &Path, _artifact_type: &str) {} |
0531ce1d | 194 | |
9fa01778 | 195 | /// Checks if should show explanations about "rustc --explain" |
0531ce1d XL |
196 | fn should_show_explain(&self) -> bool { |
197 | true | |
198 | } | |
a7813a04 | 199 | |
60c5eb7d | 200 | fn source_map(&self) -> Option<&Lrc<SourceMap>>; |
e74abb32 | 201 | |
e1599b0c XL |
202 | /// Formats the substitutions of the primary_span |
203 | /// | |
204 | /// The are a lot of conditions to this method, but in short: | |
205 | /// | |
206 | /// * If the current `Diagnostic` has only one visible `CodeSuggestion`, | |
207 | /// we format the `help` suggestion depending on the content of the | |
208 | /// substitutions. In that case, we return the modified span only. | |
209 | /// | |
210 | /// * If the current `Diagnostic` has multiple suggestions, | |
211 | /// we return the original `primary_span` and the original suggestions. | |
212 | fn primary_span_formatted<'a>( | |
213 | &mut self, | |
e74abb32 | 214 | diag: &'a Diagnostic, |
e1599b0c | 215 | ) -> (MultiSpan, &'a [CodeSuggestion]) { |
e74abb32 XL |
216 | let mut primary_span = diag.span.clone(); |
217 | if let Some((sugg, rest)) = diag.suggestions.split_first() { | |
7cac9316 | 218 | if rest.is_empty() && |
e1599b0c | 219 | // ^ if there is only one suggestion |
7cac9316 | 220 | // don't display multi-suggestions as labels |
abe05a73 XL |
221 | sugg.substitutions.len() == 1 && |
222 | // don't display multipart suggestions as labels | |
223 | sugg.substitutions[0].parts.len() == 1 && | |
7cac9316 XL |
224 | // don't display long messages as labels |
225 | sugg.msg.split_whitespace().count() < 10 && | |
226 | // don't display multiline suggestions as labels | |
9fa01778 | 227 | !sugg.substitutions[0].parts[0].snippet.contains('\n') && |
e74abb32 XL |
228 | ![ |
229 | // when this style is set we want the suggestion to be a message, not inline | |
230 | SuggestionStyle::HideCodeAlways, | |
231 | // trivial suggestion for tooling's sake, never shown | |
232 | SuggestionStyle::CompletelyHidden, | |
233 | // subtle suggestion, never shown inline | |
234 | SuggestionStyle::ShowAlways, | |
235 | ].contains(&sugg.style) | |
9fa01778 | 236 | { |
ff7c6d11 | 237 | let substitution = &sugg.substitutions[0].parts[0].snippet.trim(); |
74b04a01 | 238 | let msg = if substitution.is_empty() || sugg.style.hide_inline() { |
e1599b0c XL |
239 | // This substitution is only removal OR we explicitly don't want to show the |
240 | // code inline (`hide_inline`). Therefore, we don't show the substitution. | |
041b39d2 XL |
241 | format!("help: {}", sugg.msg) |
242 | } else { | |
e1599b0c | 243 | // Show the default suggestion text with the substitution |
e74abb32 XL |
244 | format!( |
245 | "help: {}{}: `{}`", | |
246 | sugg.msg, | |
60c5eb7d XL |
247 | if self |
248 | .source_map() | |
249 | .map(|sm| is_case_difference( | |
250 | &**sm, | |
251 | substitution, | |
252 | sugg.substitutions[0].parts[0].span, | |
253 | )) | |
254 | .unwrap_or(false) | |
255 | { | |
e74abb32 XL |
256 | " (notice the capitalization)" |
257 | } else { | |
258 | "" | |
259 | }, | |
260 | substitution, | |
261 | ) | |
041b39d2 | 262 | }; |
abe05a73 | 263 | primary_span.push_span_label(sugg.substitutions[0].parts[0].span, msg); |
e1599b0c XL |
264 | |
265 | // We return only the modified primary_span | |
266 | (primary_span, &[]) | |
7cac9316 XL |
267 | } else { |
268 | // if there are multiple suggestions, print them all in full | |
269 | // to be consistent. We could try to figure out if we can | |
270 | // make one (or the first one) inline, but that would give | |
271 | // undue importance to a semi-random suggestion | |
e74abb32 | 272 | (primary_span, &diag.suggestions) |
7cac9316 | 273 | } |
e1599b0c | 274 | } else { |
e74abb32 | 275 | (primary_span, &diag.suggestions) |
e1599b0c XL |
276 | } |
277 | } | |
278 | ||
74b04a01 | 279 | fn fix_multispans_in_extern_macros_and_render_macro_backtrace( |
60c5eb7d XL |
280 | &self, |
281 | source_map: &Option<Lrc<SourceMap>>, | |
282 | span: &mut MultiSpan, | |
283 | children: &mut Vec<SubDiagnostic>, | |
284 | level: &Level, | |
285 | backtrace: bool, | |
286 | ) { | |
74b04a01 XL |
287 | // Check for spans in macros, before `fix_multispans_in_extern_macros` |
288 | // has a chance to replace them. | |
289 | let has_macro_spans = iter::once(&*span) | |
290 | .chain(children.iter().map(|child| &child.span)) | |
291 | .flat_map(|span| span.primary_spans()) | |
f9f354fc XL |
292 | .flat_map(|sp| sp.macro_backtrace()) |
293 | .find_map(|expn_data| { | |
294 | match expn_data.kind { | |
295 | ExpnKind::Root => None, | |
74b04a01 | 296 | |
f9f354fc XL |
297 | // Skip past non-macro entries, just in case there |
298 | // are some which do actually involve macros. | |
299 | ExpnKind::Desugaring(..) | ExpnKind::AstPass(..) => None, | |
74b04a01 | 300 | |
f9f354fc XL |
301 | ExpnKind::Macro(macro_kind, _) => Some(macro_kind), |
302 | } | |
303 | }); | |
74b04a01 XL |
304 | |
305 | if !backtrace { | |
306 | self.fix_multispans_in_extern_macros(source_map, span, children); | |
7cac9316 XL |
307 | } |
308 | ||
74b04a01 XL |
309 | self.render_multispans_macro_backtrace(span, children, backtrace); |
310 | ||
311 | if !backtrace { | |
312 | if let Some(macro_kind) = has_macro_spans { | |
313 | let msg = format!( | |
314 | "this {} originates in {} {} \ | |
315 | (in Nightly builds, run with -Z macro-backtrace for more info)", | |
316 | level, | |
317 | macro_kind.article(), | |
318 | macro_kind.descr(), | |
319 | ); | |
320 | ||
321 | children.push(SubDiagnostic { | |
322 | level: Level::Note, | |
323 | message: vec![(msg, Style::NoStyle)], | |
324 | span: MultiSpan::new(), | |
325 | render_span: None, | |
326 | }); | |
327 | } | |
e1599b0c XL |
328 | } |
329 | } | |
330 | ||
74b04a01 | 331 | fn render_multispans_macro_backtrace( |
60c5eb7d | 332 | &self, |
60c5eb7d | 333 | span: &mut MultiSpan, |
74b04a01 XL |
334 | children: &mut Vec<SubDiagnostic>, |
335 | backtrace: bool, | |
336 | ) { | |
337 | for span in iter::once(span).chain(children.iter_mut().map(|child| &mut child.span)) { | |
338 | self.render_multispan_macro_backtrace(span, backtrace); | |
339 | } | |
340 | } | |
e1599b0c | 341 | |
74b04a01 | 342 | fn render_multispan_macro_backtrace(&self, span: &mut MultiSpan, always_backtrace: bool) { |
e74abb32 | 343 | let mut new_labels: Vec<(Span, String)> = vec![]; |
e1599b0c | 344 | |
74b04a01 | 345 | for &sp in span.primary_spans() { |
e74abb32 XL |
346 | if sp.is_dummy() { |
347 | continue; | |
348 | } | |
74b04a01 XL |
349 | |
350 | // FIXME(eddyb) use `retain` on `macro_backtrace` to remove all the | |
351 | // entries we don't want to print, to make sure the indices being | |
352 | // printed are contiguous (or omitted if there's only one entry). | |
dfeec247 | 353 | let macro_backtrace: Vec<_> = sp.macro_backtrace().collect(); |
dfeec247 | 354 | for (i, trace) in macro_backtrace.iter().rev().enumerate() { |
dfeec247 | 355 | if trace.def_site.is_dummy() { |
e1599b0c XL |
356 | continue; |
357 | } | |
74b04a01 | 358 | |
e74abb32 | 359 | if always_backtrace { |
60c5eb7d | 360 | new_labels.push(( |
dfeec247 | 361 | trace.def_site, |
60c5eb7d XL |
362 | format!( |
363 | "in this expansion of `{}`{}", | |
dfeec247 | 364 | trace.kind.descr(), |
3dfed10e | 365 | if macro_backtrace.len() > 1 { |
74b04a01 XL |
366 | // if macro_backtrace.len() == 1 it'll be |
367 | // pointed at by "in this macro invocation" | |
60c5eb7d XL |
368 | format!(" (#{})", i + 1) |
369 | } else { | |
370 | String::new() | |
74b04a01 | 371 | }, |
60c5eb7d XL |
372 | ), |
373 | )); | |
e1599b0c | 374 | } |
74b04a01 XL |
375 | |
376 | // Don't add a label on the call site if the diagnostic itself | |
377 | // already points to (a part of) that call site, as the label | |
378 | // is meant for showing the relevant invocation when the actual | |
379 | // diagnostic is pointing to some part of macro definition. | |
380 | // | |
381 | // This also handles the case where an external span got replaced | |
382 | // with the call site span by `fix_multispans_in_extern_macros`. | |
383 | // | |
384 | // NB: `-Zmacro-backtrace` overrides this, for uniformity, as the | |
385 | // "in this expansion of" label above is always added in that mode, | |
386 | // and it needs an "in this macro invocation" label to match that. | |
387 | let redundant_span = trace.call_site.contains(sp); | |
388 | ||
389 | if !redundant_span && matches!(trace.kind, ExpnKind::Macro(MacroKind::Bang, _)) | |
60c5eb7d XL |
390 | || always_backtrace |
391 | { | |
392 | new_labels.push(( | |
393 | trace.call_site, | |
394 | format!( | |
395 | "in this macro invocation{}", | |
3dfed10e | 396 | if macro_backtrace.len() > 1 && always_backtrace { |
60c5eb7d XL |
397 | // only specify order when the macro |
398 | // backtrace is multiple levels deep | |
399 | format!(" (#{})", i + 1) | |
400 | } else { | |
401 | String::new() | |
74b04a01 | 402 | }, |
60c5eb7d XL |
403 | ), |
404 | )); | |
74b04a01 XL |
405 | } |
406 | if !always_backtrace { | |
407 | break; | |
e1599b0c XL |
408 | } |
409 | } | |
e74abb32 | 410 | } |
74b04a01 | 411 | |
e74abb32 XL |
412 | for (label_span, label_text) in new_labels { |
413 | span.push_span_label(label_span, label_text); | |
414 | } | |
74b04a01 XL |
415 | } |
416 | ||
417 | // This does a small "fix" for multispans by looking to see if it can find any that | |
ba9703b0 XL |
418 | // point directly at external macros. Since these are often difficult to read, |
419 | // this will change the span to point at the use site. | |
74b04a01 XL |
420 | fn fix_multispans_in_extern_macros( |
421 | &self, | |
422 | source_map: &Option<Lrc<SourceMap>>, | |
423 | span: &mut MultiSpan, | |
424 | children: &mut Vec<SubDiagnostic>, | |
425 | ) { | |
ba9703b0 XL |
426 | debug!("fix_multispans_in_extern_macros: before: span={:?} children={:?}", span, children); |
427 | for span in iter::once(&mut *span).chain(children.iter_mut().map(|child| &mut child.span)) { | |
74b04a01 | 428 | self.fix_multispan_in_extern_macros(source_map, span); |
e74abb32 | 429 | } |
ba9703b0 | 430 | debug!("fix_multispans_in_extern_macros: after: span={:?} children={:?}", span, children); |
74b04a01 XL |
431 | } |
432 | ||
ba9703b0 XL |
433 | // This "fixes" MultiSpans that contain `Span`s pointing to locations inside of external macros. |
434 | // Since these locations are often difficult to read, | |
435 | // we move these spans from the external macros to their corresponding use site. | |
74b04a01 XL |
436 | fn fix_multispan_in_extern_macros( |
437 | &self, | |
438 | source_map: &Option<Lrc<SourceMap>>, | |
439 | span: &mut MultiSpan, | |
440 | ) { | |
441 | let sm = match source_map { | |
442 | Some(ref sm) => sm, | |
443 | None => return, | |
444 | }; | |
445 | ||
ba9703b0 | 446 | // First, find all the spans in external macros and point instead at their use site. |
74b04a01 XL |
447 | let replacements: Vec<(Span, Span)> = span |
448 | .primary_spans() | |
449 | .iter() | |
450 | .copied() | |
451 | .chain(span.span_labels().iter().map(|sp_label| sp_label.span)) | |
452 | .filter_map(|sp| { | |
ba9703b0 | 453 | if !sp.is_dummy() && sm.is_imported(sp) { |
74b04a01 XL |
454 | let maybe_callsite = sp.source_callsite(); |
455 | if sp != maybe_callsite { | |
456 | return Some((sp, maybe_callsite)); | |
457 | } | |
458 | } | |
459 | None | |
460 | }) | |
461 | .collect(); | |
462 | ||
ba9703b0 | 463 | // After we have them, make sure we replace these 'bad' def sites with their use sites. |
74b04a01 XL |
464 | for (from, to) in replacements { |
465 | span.replace(from, to); | |
e1599b0c | 466 | } |
e1599b0c XL |
467 | } |
468 | } | |
469 | ||
470 | impl Emitter for EmitterWriter { | |
60c5eb7d | 471 | fn source_map(&self) -> Option<&Lrc<SourceMap>> { |
e74abb32 XL |
472 | self.sm.as_ref() |
473 | } | |
474 | ||
475 | fn emit_diagnostic(&mut self, diag: &Diagnostic) { | |
476 | let mut children = diag.children.clone(); | |
477 | let (mut primary_span, suggestions) = self.primary_span_formatted(&diag); | |
ba9703b0 | 478 | debug!("emit_diagnostic: suggestions={:?}", suggestions); |
e1599b0c | 479 | |
74b04a01 | 480 | self.fix_multispans_in_extern_macros_and_render_macro_backtrace( |
60c5eb7d XL |
481 | &self.sm, |
482 | &mut primary_span, | |
483 | &mut children, | |
484 | &diag.level, | |
74b04a01 | 485 | self.macro_backtrace, |
60c5eb7d XL |
486 | ); |
487 | ||
488 | self.emit_messages_default( | |
489 | &diag.level, | |
490 | &diag.styled_message(), | |
491 | &diag.code, | |
492 | &primary_span, | |
493 | &children, | |
494 | &suggestions, | |
495 | ); | |
1a4d82fc | 496 | } |
0531ce1d XL |
497 | |
498 | fn should_show_explain(&self) -> bool { | |
499 | !self.short_message | |
500 | } | |
223e47cc LB |
501 | } |
502 | ||
60c5eb7d XL |
503 | /// An emitter that does nothing when emitting a diagnostic. |
504 | pub struct SilentEmitter; | |
505 | ||
506 | impl Emitter for SilentEmitter { | |
507 | fn source_map(&self) -> Option<&Lrc<SourceMap>> { | |
508 | None | |
509 | } | |
510 | fn emit_diagnostic(&mut self, _: &Diagnostic) {} | |
511 | } | |
512 | ||
dfeec247 | 513 | /// Maximum number of lines we will print for each error; arbitrary. |
7453a54e | 514 | pub const MAX_HIGHLIGHT_LINES: usize = 6; |
dfeec247 XL |
515 | /// Maximum number of lines we will print for a multiline suggestion; arbitrary. |
516 | /// | |
517 | /// This should be replaced with a more involved mechanism to output multiline suggestions that | |
518 | /// more closely mimmics the regular diagnostic output, where irrelevant code lines are elided. | |
519 | pub const MAX_SUGGESTION_HIGHLIGHT_LINES: usize = 6; | |
520 | /// Maximum number of suggestions to be shown | |
7cac9316 XL |
521 | /// |
522 | /// Arbitrary, but taken from trait import suggestion limit | |
523 | pub const MAX_SUGGESTIONS: usize = 4; | |
7453a54e | 524 | |
9cc50fc6 | 525 | #[derive(Clone, Copy, Debug, PartialEq, Eq)] |
1a4d82fc JJ |
526 | pub enum ColorConfig { |
527 | Auto, | |
528 | Always, | |
9cc50fc6 | 529 | Never, |
223e47cc LB |
530 | } |
531 | ||
9cc50fc6 | 532 | impl ColorConfig { |
48663c56 XL |
533 | fn to_color_choice(self) -> ColorChoice { |
534 | match self { | |
a1dfa0c6 XL |
535 | ColorConfig::Always => { |
536 | if atty::is(atty::Stream::Stderr) { | |
537 | ColorChoice::Always | |
538 | } else { | |
539 | ColorChoice::AlwaysAnsi | |
540 | } | |
541 | } | |
0531ce1d | 542 | ColorConfig::Never => ColorChoice::Never, |
60c5eb7d | 543 | ColorConfig::Auto if atty::is(atty::Stream::Stderr) => ColorChoice::Auto, |
0531ce1d | 544 | ColorConfig::Auto => ColorChoice::Never, |
9cc50fc6 | 545 | } |
d9579d0f | 546 | } |
48663c56 XL |
547 | fn suggests_using_colors(self) -> bool { |
548 | match self { | |
60c5eb7d | 549 | ColorConfig::Always | ColorConfig::Auto => true, |
48663c56 XL |
550 | ColorConfig::Never => false, |
551 | } | |
552 | } | |
d9579d0f AL |
553 | } |
554 | ||
dc9dc135 | 555 | /// Handles the writing of `HumanReadableErrorType::Default` and `HumanReadableErrorType::Short` |
9cc50fc6 SL |
556 | pub struct EmitterWriter { |
557 | dst: Destination, | |
60c5eb7d | 558 | sm: Option<Lrc<SourceMap>>, |
abe05a73 | 559 | short_message: bool, |
2c00a5a8 | 560 | teach: bool, |
0531ce1d | 561 | ui_testing: bool, |
e1599b0c XL |
562 | terminal_width: Option<usize>, |
563 | ||
74b04a01 | 564 | macro_backtrace: bool, |
a7813a04 | 565 | } |
223e47cc | 566 | |
dc9dc135 XL |
567 | #[derive(Debug)] |
568 | pub struct FileWithAnnotatedLines { | |
569 | pub file: Lrc<SourceFile>, | |
570 | pub lines: Vec<Line>, | |
476ff2be | 571 | multiline_depth: usize, |
223e47cc LB |
572 | } |
573 | ||
1a4d82fc | 574 | impl EmitterWriter { |
e1599b0c XL |
575 | pub fn stderr( |
576 | color_config: ColorConfig, | |
60c5eb7d | 577 | source_map: Option<Lrc<SourceMap>>, |
e1599b0c XL |
578 | short_message: bool, |
579 | teach: bool, | |
580 | terminal_width: Option<usize>, | |
74b04a01 | 581 | macro_backtrace: bool, |
e1599b0c | 582 | ) -> EmitterWriter { |
0531ce1d XL |
583 | let dst = Destination::from_stderr(color_config); |
584 | EmitterWriter { | |
585 | dst, | |
a1dfa0c6 | 586 | sm: source_map, |
0531ce1d XL |
587 | short_message, |
588 | teach, | |
589 | ui_testing: false, | |
e1599b0c | 590 | terminal_width, |
74b04a01 | 591 | macro_backtrace, |
1a4d82fc JJ |
592 | } |
593 | } | |
594 | ||
48663c56 XL |
595 | pub fn new( |
596 | dst: Box<dyn Write + Send>, | |
60c5eb7d | 597 | source_map: Option<Lrc<SourceMap>>, |
48663c56 XL |
598 | short_message: bool, |
599 | teach: bool, | |
600 | colored: bool, | |
e1599b0c | 601 | terminal_width: Option<usize>, |
74b04a01 | 602 | macro_backtrace: bool, |
48663c56 | 603 | ) -> EmitterWriter { |
c30ab7b3 | 604 | EmitterWriter { |
48663c56 | 605 | dst: Raw(dst, colored), |
a1dfa0c6 | 606 | sm: source_map, |
2c00a5a8 XL |
607 | short_message, |
608 | teach, | |
0531ce1d | 609 | ui_testing: false, |
e1599b0c | 610 | terminal_width, |
74b04a01 | 611 | macro_backtrace, |
0531ce1d XL |
612 | } |
613 | } | |
614 | ||
615 | pub fn ui_testing(mut self, ui_testing: bool) -> Self { | |
616 | self.ui_testing = ui_testing; | |
617 | self | |
618 | } | |
619 | ||
620 | fn maybe_anonymized(&self, line_num: usize) -> String { | |
60c5eb7d | 621 | if self.ui_testing { ANONYMIZED_LINE_NUM.to_string() } else { line_num.to_string() } |
a7813a04 XL |
622 | } |
623 | ||
e1599b0c XL |
624 | fn draw_line( |
625 | &self, | |
626 | buffer: &mut StyledBuffer, | |
627 | source_string: &str, | |
628 | line_index: usize, | |
629 | line_offset: usize, | |
630 | width_offset: usize, | |
631 | code_offset: usize, | |
632 | margin: Margin, | |
633 | ) { | |
634 | let line_len = source_string.len(); | |
635 | // Create the source line we will highlight. | |
636 | let left = margin.left(line_len); | |
637 | let right = margin.right(line_len); | |
638 | // On long lines, we strip the source line, accounting for unicode. | |
639 | let mut taken = 0; | |
60c5eb7d XL |
640 | let code: String = source_string |
641 | .chars() | |
642 | .skip(left) | |
643 | .take_while(|ch| { | |
dfeec247 XL |
644 | // Make sure that the trimming on the right will fall within the terminal width. |
645 | // FIXME: `unicode_width` sometimes disagrees with terminals on how wide a `char` is. | |
646 | // For now, just accept that sometimes the code line will be longer than desired. | |
60c5eb7d XL |
647 | let next = unicode_width::UnicodeWidthChar::width(*ch).unwrap_or(1); |
648 | if taken + next > right - left { | |
649 | return false; | |
650 | } | |
651 | taken += next; | |
652 | true | |
653 | }) | |
654 | .collect(); | |
e1599b0c XL |
655 | buffer.puts(line_offset, code_offset, &code, Style::Quotation); |
656 | if margin.was_cut_left() { | |
657 | // We have stripped some code/whitespace from the beginning, make it clear. | |
658 | buffer.puts(line_offset, code_offset, "...", Style::LineNumber); | |
659 | } | |
660 | if margin.was_cut_right(line_len) { | |
661 | // We have stripped some code after the right-most span end, make it clear we did so. | |
662 | buffer.puts(line_offset, code_offset + taken - 3, "...", Style::LineNumber); | |
663 | } | |
664 | buffer.puts(line_offset, 0, &self.maybe_anonymized(line_index), Style::LineNumber); | |
665 | ||
666 | draw_col_separator(buffer, line_offset, width_offset - 2); | |
667 | } | |
668 | ||
669 | fn render_source_line( | |
670 | &self, | |
671 | buffer: &mut StyledBuffer, | |
672 | file: Lrc<SourceFile>, | |
673 | line: &Line, | |
674 | width_offset: usize, | |
675 | code_offset: usize, | |
676 | margin: Margin, | |
677 | ) -> Vec<(usize, Style)> { | |
678 | // Draw: | |
679 | // | |
680 | // LL | ... code ... | |
681 | // | ^^-^ span label | |
682 | // | | | |
683 | // | secondary span label | |
684 | // | |
685 | // ^^ ^ ^^^ ^^^^ ^^^ we don't care about code too far to the right of a span, we trim it | |
686 | // | | | | | |
687 | // | | | actual code found in your source code and the spans we use to mark it | |
688 | // | | when there's too much wasted space to the left, trim it | |
689 | // | vertical divider between the column number and the code | |
690 | // column number | |
691 | ||
2c00a5a8 XL |
692 | if line.line_index == 0 { |
693 | return Vec::new(); | |
694 | } | |
695 | ||
7cac9316 XL |
696 | let source_string = match file.get_line(line.line_index - 1) { |
697 | Some(s) => s, | |
698 | None => return Vec::new(), | |
699 | }; | |
5bcae85e SL |
700 | |
701 | let line_offset = buffer.num_lines(); | |
c1a9b12d | 702 | |
e1599b0c XL |
703 | let left = margin.left(source_string.len()); // Left trim |
704 | // Account for unicode characters of width !=0 that were removed. | |
60c5eb7d XL |
705 | let left = source_string |
706 | .chars() | |
707 | .take(left) | |
e74abb32 XL |
708 | .map(|ch| unicode_width::UnicodeWidthChar::width(ch).unwrap_or(1)) |
709 | .sum(); | |
5bcae85e | 710 | |
e1599b0c XL |
711 | self.draw_line( |
712 | buffer, | |
713 | &source_string, | |
714 | line.line_index, | |
715 | line_offset, | |
716 | width_offset, | |
717 | code_offset, | |
718 | margin, | |
719 | ); | |
5bcae85e | 720 | |
cc61c64b XL |
721 | // Special case when there's only one annotation involved, it is the start of a multiline |
722 | // span and there's no text at the beginning of the code line. Instead of doing the whole | |
723 | // graph: | |
724 | // | |
725 | // 2 | fn foo() { | |
726 | // | _^ | |
727 | // 3 | | | |
728 | // 4 | | } | |
729 | // | |_^ test | |
730 | // | |
731 | // we simplify the output to: | |
732 | // | |
733 | // 2 | / fn foo() { | |
734 | // 3 | | | |
735 | // 4 | | } | |
736 | // | |_^ test | |
e74abb32 XL |
737 | if let [ann] = &line.annotations[..] { |
738 | if let AnnotationType::MultilineStart(depth) = ann.annotation_type { | |
739 | if source_string.chars().take(ann.start_col).all(|c| c.is_whitespace()) { | |
740 | let style = if ann.is_primary { | |
741 | Style::UnderlinePrimary | |
742 | } else { | |
743 | Style::UnderlineSecondary | |
744 | }; | |
745 | buffer.putc(line_offset, width_offset + depth - 1, '/', style); | |
746 | return vec![(depth, style)]; | |
cc61c64b XL |
747 | } |
748 | } | |
749 | } | |
750 | ||
5bcae85e SL |
751 | // We want to display like this: |
752 | // | |
753 | // vec.push(vec.pop().unwrap()); | |
476ff2be | 754 | // --- ^^^ - previous borrow ends here |
5bcae85e SL |
755 | // | | |
756 | // | error occurs here | |
757 | // previous borrow of `vec` occurs here | |
758 | // | |
759 | // But there are some weird edge cases to be aware of: | |
760 | // | |
761 | // vec.push(vec.pop().unwrap()); | |
762 | // -------- - previous borrow ends here | |
763 | // || | |
764 | // |this makes no sense | |
765 | // previous borrow of `vec` occurs here | |
766 | // | |
767 | // For this reason, we group the lines into "highlight lines" | |
cc61c64b | 768 | // and "annotations lines", where the highlight lines have the `^`. |
5bcae85e SL |
769 | |
770 | // Sort the annotations by (start, end col) | |
3b2f2976 XL |
771 | // The labels are reversed, sort and then reversed again. |
772 | // Consider a list of annotations (A1, A2, C1, C2, B1, B2) where | |
773 | // the letter signifies the span. Here we are only sorting by the | |
774 | // span and hence, the order of the elements with the same span will | |
775 | // not change. On reversing the ordering (|a, b| but b.cmp(a)), you get | |
776 | // (C1, C2, B1, B2, A1, A2). All the elements with the same span are | |
777 | // still ordered first to last, but all the elements with different | |
778 | // spans are ordered by their spans in last to first order. Last to | |
779 | // first order is important, because the jiggly lines and | are on | |
780 | // the left, so the rightmost span needs to be rendered first, | |
781 | // otherwise the lines would end up needing to go over a message. | |
782 | ||
5bcae85e | 783 | let mut annotations = line.annotations.clone(); |
8faf50e0 | 784 | annotations.sort_by_key(|a| Reverse(a.start_col)); |
5bcae85e | 785 | |
476ff2be SL |
786 | // First, figure out where each label will be positioned. |
787 | // | |
788 | // In the case where you have the following annotations: | |
789 | // | |
790 | // vec.push(vec.pop().unwrap()); | |
791 | // -------- - previous borrow ends here [C] | |
792 | // || | |
793 | // |this makes no sense [B] | |
794 | // previous borrow of `vec` occurs here [A] | |
795 | // | |
796 | // `annotations_position` will hold [(2, A), (1, B), (0, C)]. | |
797 | // | |
798 | // We try, when possible, to stick the rightmost annotation at the end | |
799 | // of the highlight line: | |
5bcae85e SL |
800 | // |
801 | // vec.push(vec.pop().unwrap()); | |
802 | // --- --- - previous borrow ends here | |
803 | // | |
804 | // But sometimes that's not possible because one of the other | |
805 | // annotations overlaps it. For example, from the test | |
806 | // `span_overlap_label`, we have the following annotations | |
807 | // (written on distinct lines for clarity): | |
808 | // | |
809 | // fn foo(x: u32) { | |
810 | // -------------- | |
811 | // - | |
812 | // | |
813 | // In this case, we can't stick the rightmost-most label on | |
814 | // the highlight line, or we would get: | |
815 | // | |
816 | // fn foo(x: u32) { | |
817 | // -------- x_span | |
818 | // | | |
819 | // fn_span | |
820 | // | |
821 | // which is totally weird. Instead we want: | |
822 | // | |
823 | // fn foo(x: u32) { | |
824 | // -------------- | |
825 | // | | | |
826 | // | x_span | |
827 | // fn_span | |
828 | // | |
829 | // which is...less weird, at least. In fact, in general, if | |
830 | // the rightmost span overlaps with any other span, we should | |
831 | // use the "hang below" version, so we can at least make it | |
32a655c1 SL |
832 | // clear where the span *starts*. There's an exception for this |
833 | // logic, when the labels do not have a message: | |
834 | // | |
835 | // fn foo(x: u32) { | |
836 | // -------------- | |
837 | // | | |
838 | // x_span | |
839 | // | |
840 | // instead of: | |
841 | // | |
842 | // fn foo(x: u32) { | |
843 | // -------------- | |
844 | // | | | |
845 | // | x_span | |
846 | // <EMPTY LINE> | |
847 | // | |
476ff2be SL |
848 | let mut annotations_position = vec![]; |
849 | let mut line_len = 0; | |
850 | let mut p = 0; | |
8bb4bdeb XL |
851 | for (i, annotation) in annotations.iter().enumerate() { |
852 | for (j, next) in annotations.iter().enumerate() { | |
853 | if overlaps(next, annotation, 0) // This label overlaps with another one and both | |
cc61c64b XL |
854 | && annotation.has_label() // take space (they have text and are not |
855 | && j > i // multiline lines). | |
60c5eb7d XL |
856 | && p == 0 |
857 | // We're currently on the first line, move the label one line down | |
32a655c1 | 858 | { |
48663c56 XL |
859 | // If we're overlapping with an un-labelled annotation with the same span |
860 | // we can just merge them in the output | |
861 | if next.start_col == annotation.start_col | |
60c5eb7d XL |
862 | && next.end_col == annotation.end_col |
863 | && !next.has_label() | |
48663c56 XL |
864 | { |
865 | continue; | |
866 | } | |
867 | ||
32a655c1 | 868 | // This annotation needs a new line in the output. |
476ff2be | 869 | p += 1; |
8bb4bdeb | 870 | break; |
a7813a04 | 871 | } |
c1a9b12d | 872 | } |
476ff2be | 873 | annotations_position.push((p, annotation)); |
8bb4bdeb | 874 | for (j, next) in annotations.iter().enumerate() { |
60c5eb7d | 875 | if j > i { |
e74abb32 | 876 | let l = next.label.as_ref().map_or(0, |label| label.len() + 2); |
cc61c64b | 877 | if (overlaps(next, annotation, l) // Do not allow two labels to be in the same |
8bb4bdeb XL |
878 | // line if they overlap including padding, to |
879 | // avoid situations like: | |
880 | // | |
881 | // fn foo(x: u32) { | |
882 | // -------^------ | |
883 | // | | | |
884 | // fn_spanx_span | |
885 | // | |
8bb4bdeb | 886 | && annotation.has_label() // Both labels must have some text, otherwise |
cc61c64b XL |
887 | && next.has_label()) // they are not overlapping. |
888 | // Do not add a new line if this annotation | |
889 | // or the next are vertical line placeholders. | |
890 | || (annotation.takes_space() // If either this or the next annotation is | |
891 | && next.has_label()) // multiline start/end, move it to a new line | |
892 | || (annotation.has_label() // so as not to overlap the orizontal lines. | |
893 | && next.takes_space()) | |
041b39d2 XL |
894 | || (annotation.takes_space() && next.takes_space()) |
895 | || (overlaps(next, annotation, l) | |
896 | && next.end_col <= annotation.end_col | |
897 | && next.has_label() | |
60c5eb7d XL |
898 | && p == 0) |
899 | // Avoid #42595. | |
8bb4bdeb | 900 | { |
cc61c64b | 901 | // This annotation needs a new line in the output. |
8bb4bdeb XL |
902 | p += 1; |
903 | break; | |
904 | } | |
476ff2be SL |
905 | } |
906 | } | |
e74abb32 | 907 | line_len = max(line_len, p); |
476ff2be | 908 | } |
cc61c64b | 909 | |
476ff2be SL |
910 | if line_len != 0 { |
911 | line_len += 1; | |
5bcae85e SL |
912 | } |
913 | ||
476ff2be SL |
914 | // If there are no annotations or the only annotations on this line are |
915 | // MultilineLine, then there's only code being shown, stop processing. | |
8faf50e0 | 916 | if line.annotations.iter().all(|a| a.is_line()) { |
cc61c64b | 917 | return vec![]; |
5bcae85e SL |
918 | } |
919 | ||
60c5eb7d | 920 | // Write the column separator. |
32a655c1 SL |
921 | // |
922 | // After this we will have: | |
923 | // | |
924 | // 2 | fn foo() { | |
925 | // | | |
926 | // | | |
927 | // | | |
928 | // 3 | | |
929 | // 4 | } | |
930 | // | | |
0731742a | 931 | for pos in 0..=line_len { |
476ff2be | 932 | draw_col_separator(buffer, line_offset + pos + 1, width_offset - 2); |
60c5eb7d | 933 | buffer.putc(line_offset + pos + 1, width_offset - 2, '|', Style::LineNumber); |
476ff2be SL |
934 | } |
935 | ||
936 | // Write the horizontal lines for multiline annotations | |
937 | // (only the first and last lines need this). | |
938 | // | |
939 | // After this we will have: | |
940 | // | |
941 | // 2 | fn foo() { | |
942 | // | __________ | |
943 | // | | |
944 | // | | |
945 | // 3 | | |
946 | // 4 | } | |
947 | // | _ | |
948 | for &(pos, annotation) in &annotations_position { | |
949 | let style = if annotation.is_primary { | |
950 | Style::UnderlinePrimary | |
951 | } else { | |
952 | Style::UnderlineSecondary | |
953 | }; | |
954 | let pos = pos + 1; | |
955 | match annotation.annotation_type { | |
60c5eb7d | 956 | AnnotationType::MultilineStart(depth) | AnnotationType::MultilineEnd(depth) => { |
e1599b0c XL |
957 | draw_range( |
958 | buffer, | |
959 | '_', | |
960 | line_offset + pos, | |
961 | width_offset + depth, | |
6c58768f | 962 | (code_offset + annotation.start_col).saturating_sub(left), |
e1599b0c XL |
963 | style, |
964 | ); | |
476ff2be | 965 | } |
2c00a5a8 | 966 | _ if self.teach => { |
e1599b0c XL |
967 | buffer.set_style_range( |
968 | line_offset, | |
6c58768f XL |
969 | (code_offset + annotation.start_col).saturating_sub(left), |
970 | (code_offset + annotation.end_col).saturating_sub(left), | |
e1599b0c XL |
971 | style, |
972 | annotation.is_primary, | |
973 | ); | |
2c00a5a8 XL |
974 | } |
975 | _ => {} | |
476ff2be SL |
976 | } |
977 | } | |
978 | ||
cc61c64b | 979 | // Write the vertical lines for labels that are on a different line as the underline. |
476ff2be SL |
980 | // |
981 | // After this we will have: | |
982 | // | |
983 | // 2 | fn foo() { | |
984 | // | __________ | |
985 | // | | | | |
986 | // | | | |
60c5eb7d | 987 | // 3 | | |
476ff2be SL |
988 | // 4 | | } |
989 | // | |_ | |
990 | for &(pos, annotation) in &annotations_position { | |
991 | let style = if annotation.is_primary { | |
992 | Style::UnderlinePrimary | |
993 | } else { | |
994 | Style::UnderlineSecondary | |
995 | }; | |
996 | let pos = pos + 1; | |
32a655c1 | 997 | |
cc61c64b | 998 | if pos > 1 && (annotation.has_label() || annotation.takes_space()) { |
0731742a | 999 | for p in line_offset + 1..=line_offset + pos { |
60c5eb7d XL |
1000 | buffer.putc( |
1001 | p, | |
1002 | (code_offset + annotation.start_col).saturating_sub(left), | |
1003 | '|', | |
1004 | style, | |
1005 | ); | |
476ff2be SL |
1006 | } |
1007 | } | |
1008 | match annotation.annotation_type { | |
1009 | AnnotationType::MultilineStart(depth) => { | |
1010 | for p in line_offset + pos + 1..line_offset + line_len + 2 { | |
60c5eb7d | 1011 | buffer.putc(p, width_offset + depth - 1, '|', style); |
476ff2be SL |
1012 | } |
1013 | } | |
1014 | AnnotationType::MultilineEnd(depth) => { | |
0731742a | 1015 | for p in line_offset..=line_offset + pos { |
60c5eb7d | 1016 | buffer.putc(p, width_offset + depth - 1, '|', style); |
476ff2be SL |
1017 | } |
1018 | } | |
476ff2be SL |
1019 | _ => (), |
1020 | } | |
1021 | } | |
1022 | ||
1023 | // Write the labels on the annotations that actually have a label. | |
1024 | // | |
1025 | // After this we will have: | |
1026 | // | |
1027 | // 2 | fn foo() { | |
cc61c64b XL |
1028 | // | __________ |
1029 | // | | | |
1030 | // | something about `foo` | |
1031 | // 3 | | |
1032 | // 4 | } | |
1033 | // | _ test | |
476ff2be | 1034 | for &(pos, annotation) in &annotations_position { |
60c5eb7d XL |
1035 | let style = |
1036 | if annotation.is_primary { Style::LabelPrimary } else { Style::LabelSecondary }; | |
476ff2be | 1037 | let (pos, col) = if pos == 0 { |
e74abb32 | 1038 | (pos + 1, (annotation.end_col + 1).saturating_sub(left)) |
476ff2be | 1039 | } else { |
e74abb32 | 1040 | (pos + 2, annotation.start_col.saturating_sub(left)) |
476ff2be SL |
1041 | }; |
1042 | if let Some(ref label) = annotation.label { | |
e1599b0c | 1043 | buffer.puts(line_offset + pos, code_offset + col, &label, style); |
476ff2be SL |
1044 | } |
1045 | } | |
1046 | ||
1047 | // Sort from biggest span to smallest span so that smaller spans are | |
1048 | // represented in the output: | |
1049 | // | |
1050 | // x | fn foo() | |
1051 | // | ^^^---^^ | |
1052 | // | | | | |
1053 | // | | something about `foo` | |
1054 | // | something about `fn foo()` | |
e74abb32 XL |
1055 | annotations_position.sort_by_key(|(_, ann)| { |
1056 | // Decreasing order. When annotations share the same length, prefer `Primary`. | |
1057 | (Reverse(ann.len()), ann.is_primary) | |
476ff2be | 1058 | }); |
5bcae85e | 1059 | |
476ff2be SL |
1060 | // Write the underlines. |
1061 | // | |
1062 | // After this we will have: | |
1063 | // | |
1064 | // 2 | fn foo() { | |
cc61c64b XL |
1065 | // | ____-_____^ |
1066 | // | | | |
1067 | // | something about `foo` | |
1068 | // 3 | | |
1069 | // 4 | } | |
1070 | // | _^ test | |
476ff2be SL |
1071 | for &(_, annotation) in &annotations_position { |
1072 | let (underline, style) = if annotation.is_primary { | |
1073 | ('^', Style::UnderlinePrimary) | |
5bcae85e | 1074 | } else { |
476ff2be SL |
1075 | ('-', Style::UnderlineSecondary) |
1076 | }; | |
1077 | for p in annotation.start_col..annotation.end_col { | |
e1599b0c XL |
1078 | buffer.putc( |
1079 | line_offset + 1, | |
e74abb32 | 1080 | (code_offset + p).saturating_sub(left), |
e1599b0c XL |
1081 | underline, |
1082 | style, | |
1083 | ); | |
c1a9b12d SL |
1084 | } |
1085 | } | |
60c5eb7d XL |
1086 | annotations_position |
1087 | .iter() | |
1088 | .filter_map(|&(_, annotation)| match annotation.annotation_type { | |
cc61c64b XL |
1089 | AnnotationType::MultilineStart(p) | AnnotationType::MultilineEnd(p) => { |
1090 | let style = if annotation.is_primary { | |
1091 | Style::LabelPrimary | |
1092 | } else { | |
1093 | Style::LabelSecondary | |
1094 | }; | |
1095 | Some((p, style)) | |
abe05a73 | 1096 | } |
60c5eb7d XL |
1097 | _ => None, |
1098 | }) | |
1099 | .collect::<Vec<_>>() | |
5bcae85e SL |
1100 | } |
1101 | ||
1102 | fn get_multispan_max_line_num(&mut self, msp: &MultiSpan) -> usize { | |
e74abb32 XL |
1103 | let sm = match self.sm { |
1104 | Some(ref sm) => sm, | |
1105 | None => return 0, | |
1106 | }; | |
1107 | ||
5bcae85e | 1108 | let mut max = 0; |
e74abb32 XL |
1109 | for primary_span in msp.primary_spans() { |
1110 | if !primary_span.is_dummy() { | |
1111 | let hi = sm.lookup_char_pos(primary_span.hi()); | |
1112 | max = (hi.line).max(max); | |
5bcae85e | 1113 | } |
e74abb32 XL |
1114 | } |
1115 | if !self.short_message { | |
1116 | for span_label in msp.span_labels() { | |
1117 | if !span_label.span.is_dummy() { | |
1118 | let hi = sm.lookup_char_pos(span_label.span.hi()); | |
1119 | max = (hi.line).max(max); | |
a7813a04 | 1120 | } |
7453a54e | 1121 | } |
c1a9b12d | 1122 | } |
e74abb32 | 1123 | |
5bcae85e | 1124 | max |
c1a9b12d SL |
1125 | } |
1126 | ||
8faf50e0 | 1127 | fn get_max_line_num(&mut self, span: &MultiSpan, children: &[SubDiagnostic]) -> usize { |
9e0c209e | 1128 | let primary = self.get_multispan_max_line_num(span); |
60c5eb7d XL |
1129 | children |
1130 | .iter() | |
e74abb32 XL |
1131 | .map(|sub| self.get_multispan_max_line_num(&sub.span)) |
1132 | .max() | |
1133 | .unwrap_or(0) | |
1134 | .max(primary) | |
c1a9b12d SL |
1135 | } |
1136 | ||
9fa01778 | 1137 | /// Adds a left margin to every line but the first, given a padding length and the label being |
32a655c1 | 1138 | /// displayed, keeping the provided highlighting. |
60c5eb7d XL |
1139 | fn msg_to_buffer( |
1140 | &self, | |
1141 | buffer: &mut StyledBuffer, | |
1142 | msg: &[(String, Style)], | |
1143 | padding: usize, | |
1144 | label: &str, | |
1145 | override_style: Option<Style>, | |
1146 | ) { | |
32a655c1 SL |
1147 | // The extra 5 ` ` is padding that's always needed to align to the `note: `: |
1148 | // | |
1149 | // error: message | |
1150 | // --> file.rs:13:20 | |
1151 | // | | |
1152 | // 13 | <CODE> | |
1153 | // | ^^^^ | |
1154 | // | | |
1155 | // = note: multiline | |
1156 | // message | |
1157 | // ++^^^----xx | |
1158 | // | | | | | |
1159 | // | | | magic `2` | |
1160 | // | | length of label | |
1161 | // | magic `3` | |
1162 | // `max_line_num_len` | |
8faf50e0 | 1163 | let padding = " ".repeat(padding + label.len() + 5); |
32a655c1 | 1164 | |
e74abb32 XL |
1165 | /// Returns `override` if it is present and `style` is `NoStyle` or `style` otherwise |
1166 | fn style_or_override(style: Style, override_: Option<Style>) -> Style { | |
1167 | match (style, override_) { | |
1168 | (Style::NoStyle, Some(override_)) => override_, | |
1169 | _ => style, | |
32a655c1 | 1170 | } |
32a655c1 SL |
1171 | } |
1172 | ||
1173 | let mut line_number = 0; | |
1174 | ||
1175 | // Provided the following diagnostic message: | |
1176 | // | |
1177 | // let msg = vec![ | |
1178 | // (" | |
1179 | // ("highlighted multiline\nstring to\nsee how it ", Style::NoStyle), | |
1180 | // ("looks", Style::Highlight), | |
1181 | // ("with\nvery ", Style::NoStyle), | |
1182 | // ("weird", Style::Highlight), | |
1183 | // (" formats\n", Style::NoStyle), | |
1184 | // ("see?", Style::Highlight), | |
1185 | // ]; | |
1186 | // | |
ff7c6d11 | 1187 | // the expected output on a note is (* surround the highlighted text) |
32a655c1 SL |
1188 | // |
1189 | // = note: highlighted multiline | |
1190 | // string to | |
1191 | // see how it *looks* with | |
1192 | // very *weird* formats | |
1193 | // see? | |
1194 | for &(ref text, ref style) in msg.iter() { | |
1195 | let lines = text.split('\n').collect::<Vec<_>>(); | |
1196 | if lines.len() > 1 { | |
1197 | for (i, line) in lines.iter().enumerate() { | |
1198 | if i != 0 { | |
1199 | line_number += 1; | |
1200 | buffer.append(line_number, &padding, Style::NoStyle); | |
1201 | } | |
1202 | buffer.append(line_number, line, style_or_override(*style, override_style)); | |
1203 | } | |
1204 | } else { | |
1205 | buffer.append(line_number, text, style_or_override(*style, override_style)); | |
1206 | } | |
1207 | } | |
1208 | } | |
1209 | ||
9fa01778 XL |
1210 | fn emit_message_default( |
1211 | &mut self, | |
1212 | msp: &MultiSpan, | |
1213 | msg: &[(String, Style)], | |
1214 | code: &Option<DiagnosticId>, | |
1215 | level: &Level, | |
1216 | max_line_num_len: usize, | |
1217 | is_secondary: bool, | |
1218 | ) -> io::Result<()> { | |
5bcae85e | 1219 | let mut buffer = StyledBuffer::new(); |
60c5eb7d | 1220 | let header_style = if is_secondary { Style::HeaderMsg } else { Style::MainHeaderMsg }; |
5bcae85e | 1221 | |
60c5eb7d XL |
1222 | if !msp.has_primary_spans() && !msp.has_span_labels() && is_secondary && !self.short_message |
1223 | { | |
5bcae85e SL |
1224 | // This is a secondary message with no span info |
1225 | for _ in 0..max_line_num_len { | |
1226 | buffer.prepend(0, " ", Style::NoStyle); | |
1227 | } | |
1228 | draw_note_separator(&mut buffer, 0, max_line_num_len + 1); | |
e1599b0c XL |
1229 | if *level != Level::FailureNote { |
1230 | let level_str = level.to_string(); | |
1231 | if !level_str.is_empty() { | |
1232 | buffer.append(0, &level_str, Style::MainHeaderMsg); | |
1233 | buffer.append(0, ": ", Style::NoStyle); | |
1234 | } | |
0531ce1d | 1235 | } |
32a655c1 | 1236 | self.msg_to_buffer(&mut buffer, msg, max_line_num_len, "note", None); |
c30ab7b3 | 1237 | } else { |
0531ce1d | 1238 | let level_str = level.to_string(); |
e1599b0c XL |
1239 | // The failure note level itself does not provide any useful diagnostic information |
1240 | if *level != Level::FailureNote && !level_str.is_empty() { | |
dfeec247 | 1241 | buffer.append(0, &level_str, Style::Level(*level)); |
0531ce1d | 1242 | } |
abe05a73 XL |
1243 | // only render error codes, not lint codes |
1244 | if let Some(DiagnosticId::Error(ref code)) = *code { | |
dfeec247 XL |
1245 | buffer.append(0, "[", Style::Level(*level)); |
1246 | buffer.append(0, &code, Style::Level(*level)); | |
1247 | buffer.append(0, "]", Style::Level(*level)); | |
5bcae85e | 1248 | } |
e1599b0c | 1249 | if *level != Level::FailureNote && !level_str.is_empty() { |
8faf50e0 | 1250 | buffer.append(0, ": ", header_style); |
0531ce1d | 1251 | } |
32a655c1 | 1252 | for &(ref text, _) in msg.iter() { |
8faf50e0 | 1253 | buffer.append(0, text, header_style); |
32a655c1 | 1254 | } |
5bcae85e SL |
1255 | } |
1256 | ||
dc9dc135 | 1257 | let mut annotated_files = FileWithAnnotatedLines::collect_annotations(msp, &self.sm); |
a7813a04 | 1258 | |
5bcae85e | 1259 | // Make sure our primary file comes first |
a1dfa0c6 | 1260 | let (primary_lo, sm) = if let (Some(sm), Some(ref primary_span)) = |
60c5eb7d XL |
1261 | (self.sm.as_ref(), msp.primary_span().as_ref()) |
1262 | { | |
8faf50e0 | 1263 | if !primary_span.is_dummy() { |
a1dfa0c6 | 1264 | (sm.lookup_char_pos(primary_span.lo()), sm) |
5bcae85e | 1265 | } else { |
abe05a73 | 1266 | emit_to_destination(&buffer.render(), level, &mut self.dst, self.short_message)?; |
5bcae85e | 1267 | return Ok(()); |
c30ab7b3 SL |
1268 | } |
1269 | } else { | |
1270 | // If we don't have span information, emit and exit | |
abe05a73 | 1271 | emit_to_destination(&buffer.render(), level, &mut self.dst, self.short_message)?; |
c30ab7b3 SL |
1272 | return Ok(()); |
1273 | }; | |
5bcae85e | 1274 | if let Ok(pos) = |
60c5eb7d XL |
1275 | annotated_files.binary_search_by(|x| x.file.name.cmp(&primary_lo.file.name)) |
1276 | { | |
5bcae85e SL |
1277 | annotated_files.swap(0, pos); |
1278 | } | |
1279 | ||
1280 | // Print out the annotate source lines that correspond with the error | |
1281 | for annotated_file in annotated_files { | |
7cac9316 | 1282 | // we can't annotate anything if the source is unavailable. |
a1dfa0c6 | 1283 | if !sm.ensure_source_file_source_present(annotated_file.file.clone()) { |
7cac9316 XL |
1284 | continue; |
1285 | } | |
1286 | ||
5bcae85e SL |
1287 | // print out the span location and spacer before we print the annotated source |
1288 | // to do this, we need to know if this span will be primary | |
1289 | let is_primary = primary_lo.file.name == annotated_file.file.name; | |
1290 | if is_primary { | |
5bcae85e | 1291 | let loc = primary_lo.clone(); |
abe05a73 XL |
1292 | if !self.short_message { |
1293 | // remember where we are in the output buffer for easy reference | |
1294 | let buffer_msg_line_offset = buffer.num_lines(); | |
1295 | ||
1296 | buffer.prepend(buffer_msg_line_offset, "--> ", Style::LineNumber); | |
e1599b0c XL |
1297 | buffer.append( |
1298 | buffer_msg_line_offset, | |
1299 | &format!( | |
1300 | "{}:{}:{}", | |
1301 | loc.file.name, | |
1302 | sm.doctest_offset_line(&loc.file.name, loc.line), | |
1303 | loc.col.0 + 1, | |
1304 | ), | |
1305 | Style::LineAndColumn, | |
1306 | ); | |
abe05a73 XL |
1307 | for _ in 0..max_line_num_len { |
1308 | buffer.prepend(buffer_msg_line_offset, " ", Style::NoStyle); | |
1309 | } | |
1310 | } else { | |
e1599b0c XL |
1311 | buffer.prepend( |
1312 | 0, | |
1313 | &format!( | |
1314 | "{}:{}:{}: ", | |
1315 | loc.file.name, | |
1316 | sm.doctest_offset_line(&loc.file.name, loc.line), | |
1317 | loc.col.0 + 1, | |
1318 | ), | |
1319 | Style::LineAndColumn, | |
1320 | ); | |
5bcae85e | 1321 | } |
abe05a73 | 1322 | } else if !self.short_message { |
5bcae85e SL |
1323 | // remember where we are in the output buffer for easy reference |
1324 | let buffer_msg_line_offset = buffer.num_lines(); | |
1325 | ||
1326 | // Add spacing line | |
1327 | draw_col_separator(&mut buffer, buffer_msg_line_offset, max_line_num_len + 1); | |
1328 | ||
1329 | // Then, the secondary file indicator | |
1330 | buffer.prepend(buffer_msg_line_offset + 1, "::: ", Style::LineNumber); | |
2c00a5a8 XL |
1331 | let loc = if let Some(first_line) = annotated_file.lines.first() { |
1332 | let col = if let Some(first_annotation) = first_line.annotations.first() { | |
1333 | format!(":{}", first_annotation.start_col + 1) | |
1334 | } else { | |
b7449926 | 1335 | String::new() |
2c00a5a8 | 1336 | }; |
60c5eb7d XL |
1337 | format!( |
1338 | "{}:{}{}", | |
1339 | annotated_file.file.name, | |
1340 | sm.doctest_offset_line(&annotated_file.file.name, first_line.line_index), | |
1341 | col | |
1342 | ) | |
2c00a5a8 XL |
1343 | } else { |
1344 | annotated_file.file.name.to_string() | |
1345 | }; | |
60c5eb7d | 1346 | buffer.append(buffer_msg_line_offset + 1, &loc, Style::LineAndColumn); |
5bcae85e SL |
1347 | for _ in 0..max_line_num_len { |
1348 | buffer.prepend(buffer_msg_line_offset + 1, " ", Style::NoStyle); | |
c1a9b12d | 1349 | } |
a7813a04 | 1350 | } |
c1a9b12d | 1351 | |
abe05a73 XL |
1352 | if !self.short_message { |
1353 | // Put in the spacer between the location and annotated source | |
1354 | let buffer_msg_line_offset = buffer.num_lines(); | |
60c5eb7d XL |
1355 | draw_col_separator_no_space( |
1356 | &mut buffer, | |
1357 | buffer_msg_line_offset, | |
1358 | max_line_num_len + 1, | |
1359 | ); | |
5bcae85e | 1360 | |
abe05a73 | 1361 | // Contains the vertical lines' positions for active multiline annotations |
b7449926 | 1362 | let mut multilines = FxHashMap::default(); |
cc61c64b | 1363 | |
e1599b0c | 1364 | // Get the left-side margin to remove it |
ba9703b0 | 1365 | let mut whitespace_margin = usize::MAX; |
e1599b0c XL |
1366 | for line_idx in 0..annotated_file.lines.len() { |
1367 | let file = annotated_file.file.clone(); | |
1368 | let line = &annotated_file.lines[line_idx]; | |
1369 | if let Some(source_string) = file.get_line(line.line_index - 1) { | |
60c5eb7d XL |
1370 | let leading_whitespace = |
1371 | source_string.chars().take_while(|c| c.is_whitespace()).count(); | |
e1599b0c | 1372 | if source_string.chars().any(|c| !c.is_whitespace()) { |
60c5eb7d | 1373 | whitespace_margin = min(whitespace_margin, leading_whitespace); |
e1599b0c XL |
1374 | } |
1375 | } | |
1376 | } | |
ba9703b0 | 1377 | if whitespace_margin == usize::MAX { |
e1599b0c XL |
1378 | whitespace_margin = 0; |
1379 | } | |
1380 | ||
1381 | // Left-most column any visible span points at. | |
ba9703b0 | 1382 | let mut span_left_margin = usize::MAX; |
e1599b0c XL |
1383 | for line in &annotated_file.lines { |
1384 | for ann in &line.annotations { | |
1385 | span_left_margin = min(span_left_margin, ann.start_col); | |
1386 | span_left_margin = min(span_left_margin, ann.end_col); | |
1387 | } | |
1388 | } | |
ba9703b0 | 1389 | if span_left_margin == usize::MAX { |
e1599b0c XL |
1390 | span_left_margin = 0; |
1391 | } | |
1392 | ||
1393 | // Right-most column any visible span points at. | |
1394 | let mut span_right_margin = 0; | |
1395 | let mut label_right_margin = 0; | |
1396 | let mut max_line_len = 0; | |
1397 | for line in &annotated_file.lines { | |
60c5eb7d XL |
1398 | max_line_len = max( |
1399 | max_line_len, | |
1400 | annotated_file.file.get_line(line.line_index - 1).map_or(0, |s| s.len()), | |
1401 | ); | |
e1599b0c XL |
1402 | for ann in &line.annotations { |
1403 | span_right_margin = max(span_right_margin, ann.start_col); | |
1404 | span_right_margin = max(span_right_margin, ann.end_col); | |
1405 | // FIXME: account for labels not in the same line | |
e74abb32 | 1406 | let label_right = ann.label.as_ref().map_or(0, |l| l.len() + 1); |
e1599b0c XL |
1407 | label_right_margin = max(label_right_margin, ann.end_col + label_right); |
1408 | } | |
1409 | } | |
1410 | ||
1411 | let width_offset = 3 + max_line_num_len; | |
1412 | let code_offset = if annotated_file.multiline_depth == 0 { | |
1413 | width_offset | |
1414 | } else { | |
1415 | width_offset + annotated_file.multiline_depth + 1 | |
1416 | }; | |
1417 | ||
1418 | let column_width = if let Some(width) = self.terminal_width { | |
1419 | width.saturating_sub(code_offset) | |
1420 | } else if self.ui_testing { | |
f035d41b | 1421 | DEFAULT_COLUMN_WIDTH |
e1599b0c | 1422 | } else { |
74b04a01 | 1423 | termize::dimensions() |
e1599b0c | 1424 | .map(|(w, _)| w.saturating_sub(code_offset)) |
f035d41b | 1425 | .unwrap_or(DEFAULT_COLUMN_WIDTH) |
e1599b0c XL |
1426 | }; |
1427 | ||
1428 | let margin = Margin::new( | |
1429 | whitespace_margin, | |
1430 | span_left_margin, | |
1431 | span_right_margin, | |
1432 | label_right_margin, | |
1433 | column_width, | |
1434 | max_line_len, | |
1435 | ); | |
1436 | ||
abe05a73 XL |
1437 | // Next, output the annotate source for this file |
1438 | for line_idx in 0..annotated_file.lines.len() { | |
1439 | let previous_buffer_line = buffer.num_lines(); | |
cc61c64b | 1440 | |
e1599b0c XL |
1441 | let depths = self.render_source_line( |
1442 | &mut buffer, | |
1443 | annotated_file.file.clone(), | |
1444 | &annotated_file.lines[line_idx], | |
1445 | width_offset, | |
1446 | code_offset, | |
1447 | margin, | |
1448 | ); | |
cc61c64b | 1449 | |
b7449926 | 1450 | let mut to_add = FxHashMap::default(); |
5bcae85e | 1451 | |
abe05a73 XL |
1452 | for (depth, style) in depths { |
1453 | if multilines.get(&depth).is_some() { | |
1454 | multilines.remove(&depth); | |
1455 | } else { | |
1456 | to_add.insert(depth, style); | |
1457 | } | |
cc61c64b | 1458 | } |
cc61c64b | 1459 | |
abe05a73 XL |
1460 | // Set the multiline annotation vertical lines to the left of |
1461 | // the code in this line. | |
1462 | for (depth, style) in &multilines { | |
1463 | for line in previous_buffer_line..buffer.num_lines() { | |
60c5eb7d | 1464 | draw_multiline_line(&mut buffer, line, width_offset, *depth, *style); |
cc61c64b | 1465 | } |
abe05a73 XL |
1466 | } |
1467 | // check to see if we need to print out or elide lines that come between | |
1468 | // this annotated line and the next one. | |
1469 | if line_idx < (annotated_file.lines.len() - 1) { | |
60c5eb7d XL |
1470 | let line_idx_delta = annotated_file.lines[line_idx + 1].line_index |
1471 | - annotated_file.lines[line_idx].line_index; | |
abe05a73 XL |
1472 | if line_idx_delta > 2 { |
1473 | let last_buffer_line_num = buffer.num_lines(); | |
1474 | buffer.puts(last_buffer_line_num, 0, "...", Style::LineNumber); | |
1475 | ||
1476 | // Set the multiline annotation vertical lines on `...` bridging line. | |
1477 | for (depth, style) in &multilines { | |
60c5eb7d XL |
1478 | draw_multiline_line( |
1479 | &mut buffer, | |
1480 | last_buffer_line_num, | |
1481 | width_offset, | |
1482 | *depth, | |
1483 | *style, | |
1484 | ); | |
abe05a73 XL |
1485 | } |
1486 | } else if line_idx_delta == 2 { | |
60c5eb7d XL |
1487 | let unannotated_line = annotated_file |
1488 | .file | |
abe05a73 XL |
1489 | .get_line(annotated_file.lines[line_idx].line_index) |
1490 | .unwrap_or_else(|| Cow::from("")); | |
1491 | ||
1492 | let last_buffer_line_num = buffer.num_lines(); | |
1493 | ||
e1599b0c XL |
1494 | self.draw_line( |
1495 | &mut buffer, | |
1496 | &unannotated_line, | |
1497 | annotated_file.lines[line_idx + 1].line_index - 1, | |
1498 | last_buffer_line_num, | |
1499 | width_offset, | |
1500 | code_offset, | |
1501 | margin, | |
1502 | ); | |
abe05a73 XL |
1503 | |
1504 | for (depth, style) in &multilines { | |
e1599b0c XL |
1505 | draw_multiline_line( |
1506 | &mut buffer, | |
1507 | last_buffer_line_num, | |
1508 | width_offset, | |
1509 | *depth, | |
1510 | *style, | |
1511 | ); | |
abe05a73 | 1512 | } |
cc61c64b | 1513 | } |
c1a9b12d | 1514 | } |
cc61c64b | 1515 | |
abe05a73 XL |
1516 | multilines.extend(&to_add); |
1517 | } | |
7453a54e SL |
1518 | } |
1519 | } | |
5bcae85e | 1520 | |
5bcae85e | 1521 | // final step: take our styled buffer, render it, then output it |
abe05a73 | 1522 | emit_to_destination(&buffer.render(), level, &mut self.dst, self.short_message)?; |
5bcae85e SL |
1523 | |
1524 | Ok(()) | |
1525 | } | |
ff7c6d11 | 1526 | |
9fa01778 XL |
1527 | fn emit_suggestion_default( |
1528 | &mut self, | |
1529 | suggestion: &CodeSuggestion, | |
1530 | level: &Level, | |
1531 | max_line_num_len: usize, | |
1532 | ) -> io::Result<()> { | |
e74abb32 XL |
1533 | let sm = match self.sm { |
1534 | Some(ref sm) => sm, | |
60c5eb7d | 1535 | None => return Ok(()), |
e74abb32 | 1536 | }; |
5bcae85e | 1537 | |
60c5eb7d XL |
1538 | // Render the replacements for each suggestion |
1539 | let suggestions = suggestion.splice_lines(&**sm); | |
ba9703b0 | 1540 | debug!("emit_suggestion_default: suggestions={:?}", suggestions); |
60c5eb7d XL |
1541 | |
1542 | if suggestions.is_empty() { | |
1543 | // Suggestions coming from macros can have malformed spans. This is a heavy handed | |
1544 | // approach to avoid ICEs by ignoring the suggestion outright. | |
1545 | return Ok(()); | |
1546 | } | |
1547 | ||
e74abb32 XL |
1548 | let mut buffer = StyledBuffer::new(); |
1549 | ||
1550 | // Render the suggestion message | |
1551 | let level_str = level.to_string(); | |
1552 | if !level_str.is_empty() { | |
dfeec247 | 1553 | buffer.append(0, &level_str, Style::Level(*level)); |
e74abb32 XL |
1554 | buffer.append(0, ": ", Style::HeaderMsg); |
1555 | } | |
1556 | self.msg_to_buffer( | |
1557 | &mut buffer, | |
1558 | &[(suggestion.msg.to_owned(), Style::NoStyle)], | |
1559 | max_line_num_len, | |
1560 | "suggestion", | |
1561 | Some(Style::HeaderMsg), | |
1562 | ); | |
1563 | ||
e74abb32 XL |
1564 | let mut row_num = 2; |
1565 | let mut notice_capitalization = false; | |
1566 | for (complete, parts, only_capitalization) in suggestions.iter().take(MAX_SUGGESTIONS) { | |
1567 | notice_capitalization |= only_capitalization; | |
1568 | // Only show underline if the suggestion spans a single line and doesn't cover the | |
1569 | // entirety of the code output. If you have multiple replacements in the same line | |
1570 | // of code, show the underline. | |
60c5eb7d | 1571 | let show_underline = !(parts.len() == 1 && parts[0].snippet.trim() == complete.trim()) |
e74abb32 XL |
1572 | && complete.lines().count() == 1; |
1573 | ||
60c5eb7d XL |
1574 | let lines = sm |
1575 | .span_to_lines(parts[0].span) | |
1576 | .expect("span_to_lines failed when emitting suggestion"); | |
e74abb32 | 1577 | |
ba9703b0 | 1578 | assert!(!lines.lines.is_empty() || parts[0].span.is_dummy()); |
e74abb32 XL |
1579 | |
1580 | let line_start = sm.lookup_char_pos(parts[0].span.lo()).line; | |
1581 | draw_col_separator_no_space(&mut buffer, 1, max_line_num_len + 1); | |
e74abb32 | 1582 | let mut lines = complete.lines(); |
74b04a01 XL |
1583 | for (line_pos, line) in lines.by_ref().take(MAX_SUGGESTION_HIGHLIGHT_LINES).enumerate() |
1584 | { | |
e74abb32 | 1585 | // Print the span column to avoid confusion |
60c5eb7d XL |
1586 | buffer.puts( |
1587 | row_num, | |
1588 | 0, | |
1589 | &self.maybe_anonymized(line_start + line_pos), | |
1590 | Style::LineNumber, | |
1591 | ); | |
e74abb32 XL |
1592 | // print the suggestion |
1593 | draw_col_separator(&mut buffer, row_num, max_line_num_len + 1); | |
1594 | buffer.append(row_num, line, Style::NoStyle); | |
e74abb32 | 1595 | row_num += 1; |
0531ce1d | 1596 | } |
94b46f34 | 1597 | |
e74abb32 XL |
1598 | // This offset and the ones below need to be signed to account for replacement code |
1599 | // that is shorter than the original code. | |
dfeec247 | 1600 | let mut offsets: Vec<(usize, isize)> = Vec::new(); |
e74abb32 XL |
1601 | // Only show an underline in the suggestions if the suggestion is not the |
1602 | // entirety of the code being shown and the displayed code is not multiline. | |
1603 | if show_underline { | |
1604 | draw_col_separator(&mut buffer, row_num, max_line_num_len + 1); | |
1605 | for part in parts { | |
1606 | let span_start_pos = sm.lookup_char_pos(part.span.lo()).col_display; | |
1607 | let span_end_pos = sm.lookup_char_pos(part.span.hi()).col_display; | |
1608 | ||
1609 | // Do not underline the leading... | |
60c5eb7d | 1610 | let start = part.snippet.len().saturating_sub(part.snippet.trim_start().len()); |
e74abb32 XL |
1611 | // ...or trailing spaces. Account for substitutions containing unicode |
1612 | // characters. | |
60c5eb7d XL |
1613 | let sub_len: usize = part |
1614 | .snippet | |
1615 | .trim() | |
1616 | .chars() | |
e74abb32 XL |
1617 | .map(|ch| unicode_width::UnicodeWidthChar::width(ch).unwrap_or(1)) |
1618 | .sum(); | |
1619 | ||
dfeec247 XL |
1620 | let offset: isize = offsets |
1621 | .iter() | |
1622 | .filter_map( | |
1623 | |(start, v)| if span_start_pos <= *start { None } else { Some(v) }, | |
1624 | ) | |
1625 | .sum(); | |
e74abb32 XL |
1626 | let underline_start = (span_start_pos + start) as isize + offset; |
1627 | let underline_end = (span_start_pos + start + sub_len) as isize + offset; | |
dfeec247 | 1628 | assert!(underline_start >= 0 && underline_end >= 0); |
e74abb32 | 1629 | for p in underline_start..underline_end { |
60c5eb7d XL |
1630 | buffer.putc( |
1631 | row_num, | |
dfeec247 | 1632 | ((max_line_num_len + 3) as isize + p) as usize, |
60c5eb7d XL |
1633 | '^', |
1634 | Style::UnderlinePrimary, | |
1635 | ); | |
e74abb32 XL |
1636 | } |
1637 | // underline removals too | |
1638 | if underline_start == underline_end { | |
60c5eb7d XL |
1639 | for p in underline_start - 1..underline_start + 1 { |
1640 | buffer.putc( | |
1641 | row_num, | |
dfeec247 | 1642 | ((max_line_num_len + 3) as isize + p) as usize, |
60c5eb7d XL |
1643 | '-', |
1644 | Style::UnderlineSecondary, | |
1645 | ); | |
94b46f34 | 1646 | } |
041b39d2 | 1647 | } |
5bcae85e | 1648 | |
e74abb32 | 1649 | // length of the code after substitution |
60c5eb7d XL |
1650 | let full_sub_len = part |
1651 | .snippet | |
1652 | .chars() | |
e74abb32 XL |
1653 | .map(|ch| unicode_width::UnicodeWidthChar::width(ch).unwrap_or(1)) |
1654 | .sum::<usize>() as isize; | |
1655 | ||
1656 | // length of the code to be substituted | |
1657 | let snippet_len = span_end_pos as isize - span_start_pos as isize; | |
1658 | // For multiple substitutions, use the position *after* the previous | |
dfeec247 XL |
1659 | // substitutions have happened, only when further substitutions are |
1660 | // located strictly after. | |
1661 | offsets.push((span_end_pos, full_sub_len - snippet_len)); | |
7cac9316 | 1662 | } |
e74abb32 | 1663 | row_num += 1; |
7cac9316 | 1664 | } |
e74abb32 XL |
1665 | |
1666 | // if we elided some lines, add an ellipsis | |
1667 | if lines.next().is_some() { | |
1668 | buffer.puts(row_num, max_line_num_len - 1, "...", Style::LineNumber); | |
1669 | } else if !show_underline { | |
1670 | draw_col_separator_no_space(&mut buffer, row_num, max_line_num_len + 1); | |
1671 | row_num += 1; | |
7453a54e | 1672 | } |
c1a9b12d | 1673 | } |
e74abb32 XL |
1674 | if suggestions.len() > MAX_SUGGESTIONS { |
1675 | let others = suggestions.len() - MAX_SUGGESTIONS; | |
60c5eb7d | 1676 | let msg = format!("and {} other candidate{}", others, pluralize!(others)); |
e74abb32 XL |
1677 | buffer.puts(row_num, max_line_num_len + 3, &msg, Style::NoStyle); |
1678 | } else if notice_capitalization { | |
1679 | let msg = "notice the capitalization difference"; | |
1680 | buffer.puts(row_num, max_line_num_len + 3, &msg, Style::NoStyle); | |
1681 | } | |
1682 | emit_to_destination(&buffer.render(), level, &mut self.dst, self.short_message)?; | |
7453a54e | 1683 | Ok(()) |
c1a9b12d | 1684 | } |
ff7c6d11 | 1685 | |
e74abb32 XL |
1686 | fn emit_messages_default( |
1687 | &mut self, | |
1688 | level: &Level, | |
1689 | message: &[(String, Style)], | |
1690 | code: &Option<DiagnosticId>, | |
1691 | span: &MultiSpan, | |
1692 | children: &[SubDiagnostic], | |
1693 | suggestions: &[CodeSuggestion], | |
1694 | ) { | |
0531ce1d XL |
1695 | let max_line_num_len = if self.ui_testing { |
1696 | ANONYMIZED_LINE_NUM.len() | |
1697 | } else { | |
1698 | self.get_max_line_num(span, children).to_string().len() | |
1699 | }; | |
5bcae85e | 1700 | |
e74abb32 | 1701 | match self.emit_message_default(span, message, code, level, max_line_num_len, false) { |
5bcae85e | 1702 | Ok(()) => { |
60c5eb7d XL |
1703 | if !children.is_empty() |
1704 | || suggestions.iter().any(|s| s.style != SuggestionStyle::CompletelyHidden) | |
1705 | { | |
5bcae85e | 1706 | let mut buffer = StyledBuffer::new(); |
abe05a73 XL |
1707 | if !self.short_message { |
1708 | draw_col_separator_no_space(&mut buffer, 0, max_line_num_len + 1); | |
1709 | } | |
60c5eb7d XL |
1710 | match emit_to_destination( |
1711 | &buffer.render(), | |
1712 | level, | |
1713 | &mut self.dst, | |
1714 | self.short_message, | |
1715 | ) { | |
5bcae85e | 1716 | Ok(()) => (), |
60c5eb7d | 1717 | Err(e) => panic!("failed to emit error: {}", e), |
5bcae85e SL |
1718 | } |
1719 | } | |
abe05a73 XL |
1720 | if !self.short_message { |
1721 | for child in children { | |
1722 | let span = child.render_span.as_ref().unwrap_or(&child.span); | |
ba9703b0 | 1723 | if let Err(err) = self.emit_message_default( |
9fa01778 XL |
1724 | &span, |
1725 | &child.styled_message(), | |
1726 | &None, | |
1727 | &child.level, | |
1728 | max_line_num_len, | |
1729 | true, | |
1730 | ) { | |
ba9703b0 | 1731 | panic!("failed to emit error: {}", err); |
abe05a73 XL |
1732 | } |
1733 | } | |
1734 | for sugg in suggestions { | |
9fa01778 XL |
1735 | if sugg.style == SuggestionStyle::CompletelyHidden { |
1736 | // do not display this suggestion, it is meant only for tools | |
1737 | } else if sugg.style == SuggestionStyle::HideCodeAlways { | |
ba9703b0 | 1738 | if let Err(e) = self.emit_message_default( |
9fa01778 XL |
1739 | &MultiSpan::new(), |
1740 | &[(sugg.msg.to_owned(), Style::HeaderMsg)], | |
1741 | &None, | |
1742 | &Level::Help, | |
1743 | max_line_num_len, | |
1744 | true, | |
1745 | ) { | |
ba9703b0 | 1746 | panic!("failed to emit error: {}", e); |
9fa01778 | 1747 | } |
ba9703b0 XL |
1748 | } else if let Err(e) = |
1749 | self.emit_suggestion_default(sugg, &Level::Help, max_line_num_len) | |
1750 | { | |
1751 | panic!("failed to emit error: {}", e); | |
1752 | }; | |
5bcae85e SL |
1753 | } |
1754 | } | |
1755 | } | |
c30ab7b3 | 1756 | Err(e) => panic!("failed to emit error: {}", e), |
5bcae85e | 1757 | } |
0531ce1d XL |
1758 | |
1759 | let mut dst = self.dst.writable(); | |
dc9dc135 | 1760 | match writeln!(dst) { |
5bcae85e | 1761 | Err(e) => panic!("failed to emit error: {}", e), |
ba9703b0 XL |
1762 | _ => { |
1763 | if let Err(e) = dst.flush() { | |
1764 | panic!("failed to emit error: {}", e) | |
1765 | } | |
1766 | } | |
c1a9b12d | 1767 | } |
c1a9b12d | 1768 | } |
1a4d82fc | 1769 | } |
970d7e83 | 1770 | |
dc9dc135 XL |
1771 | impl FileWithAnnotatedLines { |
1772 | /// Preprocess all the annotations so that they are grouped by file and by line number | |
1773 | /// This helps us quickly iterate over the whole message (including secondary file spans) | |
1774 | pub fn collect_annotations( | |
1775 | msp: &MultiSpan, | |
60c5eb7d | 1776 | source_map: &Option<Lrc<SourceMap>>, |
dc9dc135 | 1777 | ) -> Vec<FileWithAnnotatedLines> { |
60c5eb7d XL |
1778 | fn add_annotation_to_file( |
1779 | file_vec: &mut Vec<FileWithAnnotatedLines>, | |
1780 | file: Lrc<SourceFile>, | |
1781 | line_index: usize, | |
1782 | ann: Annotation, | |
1783 | ) { | |
dc9dc135 XL |
1784 | for slot in file_vec.iter_mut() { |
1785 | // Look through each of our files for the one we're adding to | |
1786 | if slot.file.name == file.name { | |
1787 | // See if we already have a line for it | |
1788 | for line_slot in &mut slot.lines { | |
1789 | if line_slot.line_index == line_index { | |
1790 | line_slot.annotations.push(ann); | |
1791 | return; | |
1792 | } | |
1793 | } | |
1794 | // We don't have a line yet, create one | |
60c5eb7d | 1795 | slot.lines.push(Line { line_index, annotations: vec![ann] }); |
dc9dc135 XL |
1796 | slot.lines.sort(); |
1797 | return; | |
1798 | } | |
1799 | } | |
1800 | // This is the first time we're seeing the file | |
1801 | file_vec.push(FileWithAnnotatedLines { | |
1802 | file, | |
60c5eb7d | 1803 | lines: vec![Line { line_index, annotations: vec![ann] }], |
dc9dc135 XL |
1804 | multiline_depth: 0, |
1805 | }); | |
1806 | } | |
1807 | ||
1808 | let mut output = vec![]; | |
1809 | let mut multiline_annotations = vec![]; | |
1810 | ||
1811 | if let Some(ref sm) = source_map { | |
1812 | for span_label in msp.span_labels() { | |
1813 | if span_label.span.is_dummy() { | |
1814 | continue; | |
1815 | } | |
1816 | ||
1817 | let lo = sm.lookup_char_pos(span_label.span.lo()); | |
1818 | let mut hi = sm.lookup_char_pos(span_label.span.hi()); | |
1819 | ||
1820 | // Watch out for "empty spans". If we get a span like 6..6, we | |
1821 | // want to just display a `^` at 6, so convert that to | |
1822 | // 6..7. This is degenerate input, but it's best to degrade | |
1823 | // gracefully -- and the parser likes to supply a span like | |
1824 | // that for EOF, in particular. | |
1825 | ||
1826 | if lo.col_display == hi.col_display && lo.line == hi.line { | |
1827 | hi.col_display += 1; | |
1828 | } | |
1829 | ||
e74abb32 | 1830 | if lo.line != hi.line { |
dc9dc135 XL |
1831 | let ml = MultilineAnnotation { |
1832 | depth: 1, | |
1833 | line_start: lo.line, | |
1834 | line_end: hi.line, | |
1835 | start_col: lo.col_display, | |
1836 | end_col: hi.col_display, | |
1837 | is_primary: span_label.is_primary, | |
e74abb32 | 1838 | label: span_label.label, |
dc9dc135 XL |
1839 | overlaps_exactly: false, |
1840 | }; | |
e74abb32 | 1841 | multiline_annotations.push((lo.file, ml)); |
dc9dc135 | 1842 | } else { |
e74abb32 XL |
1843 | let ann = Annotation { |
1844 | start_col: lo.col_display, | |
1845 | end_col: hi.col_display, | |
1846 | is_primary: span_label.is_primary, | |
1847 | label: span_label.label, | |
1848 | annotation_type: AnnotationType::Singleline, | |
1849 | }; | |
dc9dc135 | 1850 | add_annotation_to_file(&mut output, lo.file, lo.line, ann); |
e74abb32 | 1851 | }; |
dc9dc135 XL |
1852 | } |
1853 | } | |
1854 | ||
1855 | // Find overlapping multiline annotations, put them at different depths | |
1856 | multiline_annotations.sort_by_key(|&(_, ref ml)| (ml.line_start, ml.line_end)); | |
e74abb32 XL |
1857 | for (_, ann) in multiline_annotations.clone() { |
1858 | for (_, a) in multiline_annotations.iter_mut() { | |
dc9dc135 XL |
1859 | // Move all other multiline annotations overlapping with this one |
1860 | // one level to the right. | |
60c5eb7d XL |
1861 | if !(ann.same_span(a)) |
1862 | && num_overlap(ann.line_start, ann.line_end, a.line_start, a.line_end, true) | |
dc9dc135 XL |
1863 | { |
1864 | a.increase_depth(); | |
1865 | } else if ann.same_span(a) && &ann != a { | |
1866 | a.overlaps_exactly = true; | |
1867 | } else { | |
1868 | break; | |
1869 | } | |
1870 | } | |
1871 | } | |
1872 | ||
60c5eb7d | 1873 | let mut max_depth = 0; // max overlapping multiline spans |
dc9dc135 | 1874 | for (file, ann) in multiline_annotations { |
e74abb32 | 1875 | max_depth = max(max_depth, ann.depth); |
dc9dc135 XL |
1876 | let mut end_ann = ann.as_end(); |
1877 | if !ann.overlaps_exactly { | |
1878 | // avoid output like | |
1879 | // | |
1880 | // | foo( | |
1881 | // | _____^ | |
1882 | // | |_____| | |
1883 | // | || bar, | |
1884 | // | || ); | |
1885 | // | || ^ | |
1886 | // | ||______| | |
1887 | // | |______foo | |
1888 | // | baz | |
1889 | // | |
1890 | // and instead get | |
1891 | // | |
1892 | // | foo( | |
1893 | // | _____^ | |
1894 | // | | bar, | |
1895 | // | | ); | |
1896 | // | | ^ | |
1897 | // | | | | |
1898 | // | |______foo | |
1899 | // | baz | |
1900 | add_annotation_to_file(&mut output, file.clone(), ann.line_start, ann.as_start()); | |
1901 | // 4 is the minimum vertical length of a multiline span when presented: two lines | |
1902 | // of code and two lines of underline. This is not true for the special case where | |
1903 | // the beginning doesn't have an underline, but the current logic seems to be | |
1904 | // working correctly. | |
1905 | let middle = min(ann.line_start + 4, ann.line_end); | |
1906 | for line in ann.line_start + 1..middle { | |
1907 | // Every `|` that joins the beginning of the span (`___^`) to the end (`|__^`). | |
1908 | add_annotation_to_file(&mut output, file.clone(), line, ann.as_line()); | |
1909 | } | |
e74abb32 XL |
1910 | let line_end = ann.line_end - 1; |
1911 | if middle < line_end { | |
1912 | add_annotation_to_file(&mut output, file.clone(), line_end, ann.as_line()); | |
dc9dc135 XL |
1913 | } |
1914 | } else { | |
1915 | end_ann.annotation_type = AnnotationType::Singleline; | |
1916 | } | |
1917 | add_annotation_to_file(&mut output, file, ann.line_end, end_ann); | |
1918 | } | |
1919 | for file_vec in output.iter_mut() { | |
1920 | file_vec.multiline_depth = max_depth; | |
1921 | } | |
1922 | output | |
1923 | } | |
1924 | } | |
1925 | ||
5bcae85e SL |
1926 | fn draw_col_separator(buffer: &mut StyledBuffer, line: usize, col: usize) { |
1927 | buffer.puts(line, col, "| ", Style::LineNumber); | |
7453a54e SL |
1928 | } |
1929 | ||
5bcae85e | 1930 | fn draw_col_separator_no_space(buffer: &mut StyledBuffer, line: usize, col: usize) { |
476ff2be SL |
1931 | draw_col_separator_no_space_with_style(buffer, line, col, Style::LineNumber); |
1932 | } | |
1933 | ||
60c5eb7d XL |
1934 | fn draw_col_separator_no_space_with_style( |
1935 | buffer: &mut StyledBuffer, | |
1936 | line: usize, | |
1937 | col: usize, | |
1938 | style: Style, | |
1939 | ) { | |
476ff2be SL |
1940 | buffer.putc(line, col, '|', style); |
1941 | } | |
1942 | ||
60c5eb7d XL |
1943 | fn draw_range( |
1944 | buffer: &mut StyledBuffer, | |
1945 | symbol: char, | |
1946 | line: usize, | |
1947 | col_from: usize, | |
1948 | col_to: usize, | |
1949 | style: Style, | |
1950 | ) { | |
476ff2be SL |
1951 | for col in col_from..col_to { |
1952 | buffer.putc(line, col, symbol, style); | |
1953 | } | |
5bcae85e SL |
1954 | } |
1955 | ||
1956 | fn draw_note_separator(buffer: &mut StyledBuffer, line: usize, col: usize) { | |
1957 | buffer.puts(line, col, "= ", Style::LineNumber); | |
1958 | } | |
1959 | ||
60c5eb7d XL |
1960 | fn draw_multiline_line( |
1961 | buffer: &mut StyledBuffer, | |
1962 | line: usize, | |
1963 | offset: usize, | |
1964 | depth: usize, | |
1965 | style: Style, | |
1966 | ) { | |
cc61c64b XL |
1967 | buffer.putc(line, offset + depth - 1, '|', style); |
1968 | } | |
1969 | ||
60c5eb7d XL |
1970 | fn num_overlap( |
1971 | a_start: usize, | |
1972 | a_end: usize, | |
1973 | b_start: usize, | |
1974 | b_end: usize, | |
1975 | inclusive: bool, | |
1976 | ) -> bool { | |
1977 | let extra = if inclusive { 1 } else { 0 }; | |
1978 | (b_start..b_end + extra).contains(&a_start) || (a_start..a_end + extra).contains(&b_start) | |
476ff2be | 1979 | } |
8bb4bdeb XL |
1980 | fn overlaps(a1: &Annotation, a2: &Annotation, padding: usize) -> bool { |
1981 | num_overlap(a1.start_col, a1.end_col + padding, a2.start_col, a2.end_col, false) | |
5bcae85e SL |
1982 | } |
1983 | ||
60c5eb7d XL |
1984 | fn emit_to_destination( |
1985 | rendered_buffer: &[Vec<StyledString>], | |
1986 | lvl: &Level, | |
1987 | dst: &mut Destination, | |
1988 | short_message: bool, | |
1989 | ) -> io::Result<()> { | |
9fa01778 | 1990 | use crate::lock; |
9e0c209e | 1991 | |
0531ce1d XL |
1992 | let mut dst = dst.writable(); |
1993 | ||
9e0c209e SL |
1994 | // In order to prevent error message interleaving, where multiple error lines get intermixed |
1995 | // when multiple compiler processes error simultaneously, we emit errors with additional | |
1996 | // steps. | |
1997 | // | |
1998 | // On Unix systems, we write into a buffered terminal rather than directly to a terminal. When | |
1999 | // the .flush() is called we take the buffer created from the buffered writes and write it at | |
2000 | // one shot. Because the Unix systems use ANSI for the colors, which is a text-based styling | |
2001 | // scheme, this buffered approach works and maintains the styling. | |
2002 | // | |
2003 | // On Windows, styling happens through calls to a terminal API. This prevents us from using the | |
2004 | // same buffering approach. Instead, we use a global Windows mutex, which we acquire long | |
2005 | // enough to output the full error message, then we release. | |
2006 | let _buffer_lock = lock::acquire_global_lock("rustc_errors"); | |
0531ce1d | 2007 | for (pos, line) in rendered_buffer.iter().enumerate() { |
5bcae85e | 2008 | for part in line { |
ba9703b0 | 2009 | dst.apply_style(*lvl, part.style)?; |
5bcae85e | 2010 | write!(dst, "{}", part.text)?; |
0531ce1d | 2011 | dst.reset()?; |
a7813a04 | 2012 | } |
0531ce1d | 2013 | if !short_message && (!lvl.is_failure_note() || pos != rendered_buffer.len() - 1) { |
dc9dc135 | 2014 | writeln!(dst)?; |
abe05a73 | 2015 | } |
9cc50fc6 | 2016 | } |
9e0c209e | 2017 | dst.flush()?; |
9cc50fc6 SL |
2018 | Ok(()) |
2019 | } | |
2020 | ||
5bcae85e | 2021 | pub enum Destination { |
0531ce1d XL |
2022 | Terminal(StandardStream), |
2023 | Buffered(BufferWriter), | |
48663c56 XL |
2024 | // The bool denotes whether we should be emitting ansi color codes or not |
2025 | Raw(Box<(dyn Write + Send)>, bool), | |
9cc50fc6 SL |
2026 | } |
2027 | ||
0531ce1d XL |
2028 | pub enum WritableDst<'a> { |
2029 | Terminal(&'a mut StandardStream), | |
2030 | Buffered(&'a mut BufferWriter, Buffer), | |
48663c56 XL |
2031 | Raw(&'a mut (dyn Write + Send)), |
2032 | ColoredRaw(Ansi<&'a mut (dyn Write + Send)>), | |
9e0c209e SL |
2033 | } |
2034 | ||
9cc50fc6 | 2035 | impl Destination { |
0531ce1d XL |
2036 | fn from_stderr(color: ColorConfig) -> Destination { |
2037 | let choice = color.to_color_choice(); | |
2038 | // On Windows we'll be performing global synchronization on the entire | |
2039 | // system for emitting rustc errors, so there's no need to buffer | |
2040 | // anything. | |
2041 | // | |
2042 | // On non-Windows we rely on the atomicity of `write` to ensure errors | |
2043 | // don't get all jumbled up. | |
2044 | if cfg!(windows) { | |
2045 | Terminal(StandardStream::stderr(choice)) | |
2046 | } else { | |
2047 | Buffered(BufferWriter::stderr(choice)) | |
9e0c209e SL |
2048 | } |
2049 | } | |
2050 | ||
416331ca | 2051 | fn writable(&mut self) -> WritableDst<'_> { |
0531ce1d XL |
2052 | match *self { |
2053 | Destination::Terminal(ref mut t) => WritableDst::Terminal(t), | |
2054 | Destination::Buffered(ref mut t) => { | |
2055 | let buf = t.buffer(); | |
2056 | WritableDst::Buffered(t, buf) | |
2057 | } | |
48663c56 XL |
2058 | Destination::Raw(ref mut t, false) => WritableDst::Raw(t), |
2059 | Destination::Raw(ref mut t, true) => WritableDst::ColoredRaw(Ansi::new(t)), | |
9cc50fc6 SL |
2060 | } |
2061 | } | |
0531ce1d | 2062 | } |
9cc50fc6 | 2063 | |
0531ce1d | 2064 | impl<'a> WritableDst<'a> { |
c30ab7b3 | 2065 | fn apply_style(&mut self, lvl: Level, style: Style) -> io::Result<()> { |
0531ce1d | 2066 | let mut spec = ColorSpec::new(); |
a7813a04 | 2067 | match style { |
041b39d2 | 2068 | Style::LineAndColumn => {} |
a7813a04 | 2069 | Style::LineNumber => { |
0531ce1d XL |
2070 | spec.set_bold(true); |
2071 | spec.set_intense(true); | |
9e0c209e | 2072 | if cfg!(windows) { |
0531ce1d | 2073 | spec.set_fg(Some(Color::Cyan)); |
9e0c209e | 2074 | } else { |
0531ce1d | 2075 | spec.set_fg(Some(Color::Blue)); |
9e0c209e | 2076 | } |
a7813a04 | 2077 | } |
5bcae85e | 2078 | Style::Quotation => {} |
dc9dc135 | 2079 | Style::MainHeaderMsg => { |
0531ce1d | 2080 | spec.set_bold(true); |
9e0c209e | 2081 | if cfg!(windows) { |
60c5eb7d | 2082 | spec.set_intense(true).set_fg(Some(Color::White)); |
9e0c209e | 2083 | } |
a7813a04 XL |
2084 | } |
2085 | Style::UnderlinePrimary | Style::LabelPrimary => { | |
0531ce1d XL |
2086 | spec = lvl.color(); |
2087 | spec.set_bold(true); | |
a7813a04 | 2088 | } |
60c5eb7d XL |
2089 | Style::UnderlineSecondary | Style::LabelSecondary => { |
2090 | spec.set_bold(true).set_intense(true); | |
9e0c209e | 2091 | if cfg!(windows) { |
0531ce1d | 2092 | spec.set_fg(Some(Color::Cyan)); |
9e0c209e | 2093 | } else { |
0531ce1d | 2094 | spec.set_fg(Some(Color::Blue)); |
9e0c209e | 2095 | } |
a7813a04 | 2096 | } |
60c5eb7d | 2097 | Style::HeaderMsg | Style::NoStyle => {} |
0531ce1d XL |
2098 | Style::Level(lvl) => { |
2099 | spec = lvl.color(); | |
2100 | spec.set_bold(true); | |
2101 | } | |
2102 | Style::Highlight => { | |
2103 | spec.set_bold(true); | |
a7813a04 XL |
2104 | } |
2105 | } | |
0531ce1d | 2106 | self.set_color(&spec) |
a7813a04 XL |
2107 | } |
2108 | ||
0531ce1d | 2109 | fn set_color(&mut self, color: &ColorSpec) -> io::Result<()> { |
a7813a04 | 2110 | match *self { |
0531ce1d XL |
2111 | WritableDst::Terminal(ref mut t) => t.set_color(color), |
2112 | WritableDst::Buffered(_, ref mut t) => t.set_color(color), | |
48663c56 | 2113 | WritableDst::ColoredRaw(ref mut t) => t.set_color(color), |
60c5eb7d | 2114 | WritableDst::Raw(_) => Ok(()), |
a7813a04 | 2115 | } |
a7813a04 XL |
2116 | } |
2117 | ||
0531ce1d | 2118 | fn reset(&mut self) -> io::Result<()> { |
a7813a04 | 2119 | match *self { |
0531ce1d XL |
2120 | WritableDst::Terminal(ref mut t) => t.reset(), |
2121 | WritableDst::Buffered(_, ref mut t) => t.reset(), | |
48663c56 | 2122 | WritableDst::ColoredRaw(ref mut t) => t.reset(), |
0531ce1d | 2123 | WritableDst::Raw(_) => Ok(()), |
a7813a04 | 2124 | } |
a7813a04 | 2125 | } |
9cc50fc6 SL |
2126 | } |
2127 | ||
0531ce1d | 2128 | impl<'a> Write for WritableDst<'a> { |
c34b1796 AL |
2129 | fn write(&mut self, bytes: &[u8]) -> io::Result<usize> { |
2130 | match *self { | |
0531ce1d XL |
2131 | WritableDst::Terminal(ref mut t) => t.write(bytes), |
2132 | WritableDst::Buffered(_, ref mut buf) => buf.write(bytes), | |
2133 | WritableDst::Raw(ref mut w) => w.write(bytes), | |
48663c56 | 2134 | WritableDst::ColoredRaw(ref mut t) => t.write(bytes), |
c34b1796 AL |
2135 | } |
2136 | } | |
0531ce1d | 2137 | |
c34b1796 | 2138 | fn flush(&mut self) -> io::Result<()> { |
1a4d82fc | 2139 | match *self { |
0531ce1d XL |
2140 | WritableDst::Terminal(ref mut t) => t.flush(), |
2141 | WritableDst::Buffered(_, ref mut buf) => buf.flush(), | |
2142 | WritableDst::Raw(ref mut w) => w.flush(), | |
48663c56 | 2143 | WritableDst::ColoredRaw(ref mut w) => w.flush(), |
0531ce1d XL |
2144 | } |
2145 | } | |
2146 | } | |
2147 | ||
2148 | impl<'a> Drop for WritableDst<'a> { | |
2149 | fn drop(&mut self) { | |
ba9703b0 XL |
2150 | if let WritableDst::Buffered(ref mut dst, ref mut buf) = self { |
2151 | drop(dst.print(buf)); | |
1a4d82fc JJ |
2152 | } |
2153 | } | |
9e0c209e | 2154 | } |
e74abb32 XL |
2155 | |
2156 | /// Whether the original and suggested code are visually similar enough to warrant extra wording. | |
60c5eb7d | 2157 | pub fn is_case_difference(sm: &SourceMap, suggested: &str, sp: Span) -> bool { |
e74abb32 | 2158 | // FIXME: this should probably be extended to also account for `FO0` → `FOO` and unicode. |
60c5eb7d XL |
2159 | let found = match sm.span_to_snippet(sp) { |
2160 | Ok(snippet) => snippet, | |
2161 | Err(e) => { | |
2162 | warn!("Invalid span {:?}. Err={:?}", sp, e); | |
2163 | return false; | |
2164 | } | |
2165 | }; | |
e74abb32 XL |
2166 | let ascii_confusables = &['c', 'f', 'i', 'k', 'o', 's', 'u', 'v', 'w', 'x', 'y', 'z']; |
2167 | // All the chars that differ in capitalization are confusable (above): | |
60c5eb7d XL |
2168 | let confusable = found |
2169 | .chars() | |
2170 | .zip(suggested.chars()) | |
2171 | .filter(|(f, s)| f != s) | |
2172 | .all(|(f, s)| (ascii_confusables.contains(&f) || ascii_confusables.contains(&s))); | |
e74abb32 XL |
2173 | confusable && found.to_lowercase() == suggested.to_lowercase() |
2174 | // FIXME: We sometimes suggest the same thing we already have, which is a | |
2175 | // bug, but be defensive against that here. | |
2176 | && found != suggested | |
2177 | } |