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