-
Notifications
You must be signed in to change notification settings - Fork 12.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rustc explain #48337
Rustc explain #48337
Changes from all commits
9b597a1
1dc2015
5747fd6
16fb6b0
ce6429a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -21,7 +21,7 @@ use std::io::prelude::*; | |
use std::io; | ||
use std::rc::Rc; | ||
use term; | ||
use std::collections::HashMap; | ||
use std::collections::{HashMap, HashSet}; | ||
use std::cmp::min; | ||
use unicode_width; | ||
|
||
|
@@ -107,6 +107,7 @@ pub struct EmitterWriter { | |
cm: Option<Rc<CodeMapper>>, | ||
short_message: bool, | ||
teach: bool, | ||
error_codes: HashSet<String>, | ||
} | ||
|
||
struct FileWithAnnotatedLines { | ||
|
@@ -115,6 +116,33 @@ struct FileWithAnnotatedLines { | |
multiline_depth: usize, | ||
} | ||
|
||
impl Drop for EmitterWriter { | ||
fn drop(&mut self) { | ||
if !self.short_message && !self.error_codes.is_empty() { | ||
let mut error_codes = self.error_codes.clone().into_iter().collect::<Vec<_>>(); | ||
error_codes.sort(); | ||
if error_codes.len() > 1 { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should this restrict the error list to some reasonable amount? I'm ok with any amount, but I'd constrain it to at most two full 80 col lines. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Does it really matter? I can do it but I'm not sure if this is very useful... You're not supposed to try to have as much errors as possible when writing code haha. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It should be rare, but I see no reason for us not to gracefully handle that case :) It won't ever be possible for a given project to have more than a subset of the ~600 errors the compiler has, but regardless, it is worthless to list the error codes, once the user understands how to use the flag, it makes more sense to scroll to the error that they want more information on and copy the error code from there, as the error code on it's own is meaningless. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ok, I'll limit then. |
||
let limit = if error_codes.len() > 9 { 9 } else { error_codes.len() }; | ||
writeln!(self.dst, | ||
"You've got a few errors: {}{}", | ||
error_codes[..limit].join(", "), | ||
if error_codes.len() > 9 { "..." } else { "" } | ||
).expect("failed to give tips..."); | ||
writeln!(self.dst, | ||
"If you want more information on an error, try using \ | ||
\"rustc --explain {}\"", | ||
&error_codes[0]).expect("failed to give tips..."); | ||
} else { | ||
writeln!(self.dst, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should this message show up for errors that don't show any extra information if There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure to understand your point... There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sorry I confused this with the |
||
"If you want more information on this error, try using \ | ||
\"rustc --explain {}\"", | ||
&error_codes[0]).expect("failed to give tips..."); | ||
} | ||
self.dst.flush().expect("failed to emit errors"); | ||
} | ||
} | ||
} | ||
|
||
impl EmitterWriter { | ||
pub fn stderr(color_config: ColorConfig, | ||
code_map: Option<Rc<CodeMapper>>, | ||
|
@@ -128,13 +156,15 @@ impl EmitterWriter { | |
cm: code_map, | ||
short_message, | ||
teach, | ||
error_codes: HashSet::new(), | ||
} | ||
} else { | ||
EmitterWriter { | ||
dst: Raw(Box::new(io::stderr())), | ||
cm: code_map, | ||
short_message, | ||
teach, | ||
error_codes: HashSet::new(), | ||
} | ||
} | ||
} | ||
|
@@ -149,6 +179,7 @@ impl EmitterWriter { | |
cm: code_map, | ||
short_message, | ||
teach, | ||
error_codes: HashSet::new(), | ||
} | ||
} | ||
|
||
|
@@ -975,12 +1006,14 @@ impl EmitterWriter { | |
if primary_span != &&DUMMY_SP { | ||
(cm.lookup_char_pos(primary_span.lo()), cm) | ||
} else { | ||
emit_to_destination(&buffer.render(), level, &mut self.dst, self.short_message)?; | ||
emit_to_destination(&buffer.render(), level, &mut self.dst, self.short_message, | ||
&mut self.error_codes)?; | ||
return Ok(()); | ||
} | ||
} else { | ||
// If we don't have span information, emit and exit | ||
emit_to_destination(&buffer.render(), level, &mut self.dst, self.short_message)?; | ||
emit_to_destination(&buffer.render(), level, &mut self.dst, self.short_message, | ||
&mut self.error_codes)?; | ||
return Ok(()); | ||
}; | ||
if let Ok(pos) = | ||
|
@@ -1153,7 +1186,8 @@ impl EmitterWriter { | |
} | ||
|
||
// final step: take our styled buffer, render it, then output it | ||
emit_to_destination(&buffer.render(), level, &mut self.dst, self.short_message)?; | ||
emit_to_destination(&buffer.render(), level, &mut self.dst, self.short_message, | ||
&mut self.error_codes)?; | ||
|
||
Ok(()) | ||
|
||
|
@@ -1241,7 +1275,8 @@ impl EmitterWriter { | |
let msg = format!("and {} other candidates", suggestions.len() - MAX_SUGGESTIONS); | ||
buffer.puts(row_num, 0, &msg, Style::NoStyle); | ||
} | ||
emit_to_destination(&buffer.render(), level, &mut self.dst, self.short_message)?; | ||
emit_to_destination(&buffer.render(), level, &mut self.dst, self.short_message, | ||
&mut self.error_codes)?; | ||
} | ||
Ok(()) | ||
} | ||
|
@@ -1269,7 +1304,7 @@ impl EmitterWriter { | |
draw_col_separator_no_space(&mut buffer, 0, max_line_num_len + 1); | ||
} | ||
match emit_to_destination(&buffer.render(), level, &mut self.dst, | ||
self.short_message) { | ||
self.short_message, &mut self.error_codes) { | ||
Ok(()) => (), | ||
Err(e) => panic!("failed to emit error: {}", e) | ||
} | ||
|
@@ -1362,7 +1397,8 @@ fn overlaps(a1: &Annotation, a2: &Annotation, padding: usize) -> bool { | |
fn emit_to_destination(rendered_buffer: &Vec<Vec<StyledString>>, | ||
lvl: &Level, | ||
dst: &mut Destination, | ||
short_message: bool) | ||
short_message: bool, | ||
error_codes: &mut HashSet<String>) | ||
-> io::Result<()> { | ||
use lock; | ||
|
||
|
@@ -1383,6 +1419,9 @@ fn emit_to_destination(rendered_buffer: &Vec<Vec<StyledString>>, | |
for part in line { | ||
dst.apply_style(lvl.clone(), part.style)?; | ||
write!(dst, "{}", part.text)?; | ||
if !short_message && part.text.len() == 12 && part.text.starts_with("error[E") { | ||
error_codes.insert(part.text[6..11].to_owned()); | ||
} | ||
dst.reset_attrs()?; | ||
} | ||
if !short_message { | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@GuillaumeGomez (more belated commentary in light of #48550) What was the motivation for putting the this in
drop()
? Semantically, printing the message notifying the user about--explain
does not seem like a "cleanup" action. As Niko suggested, I would kind of expect this to go with the "aborting due to previous error" message inHandler.abort_if_errors
—and it looks like theHandler
already knows which codes have been emitted, too.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hum, if this is true, it might allow to make my task for #48562.