Skip to content

--explain disambiguates no long description and invalid error codes #69442

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

Merged
merged 1 commit into from
Mar 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions src/librustc_driver/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,10 @@ use rustc_codegen_ssa::CodegenResults;
use rustc_codegen_utils::codegen_backend::CodegenBackend;
use rustc_data_structures::profiling::print_time_passes_entry;
use rustc_data_structures::sync::SeqCst;
use rustc_errors::{registry::Registry, PResult};
use rustc_errors::{
registry::{InvalidErrorCode, Registry},
PResult,
};
use rustc_feature::{find_gated_cfg, UnstableFeatures};
use rustc_hir::def_id::LOCAL_CRATE;
use rustc_interface::util::{collect_crate_types, get_builtin_codegen_backend};
Expand Down Expand Up @@ -522,11 +525,10 @@ fn stdout_isatty() -> bool {
fn handle_explain(registry: Registry, code: &str, output: ErrorOutputType) {
let normalised =
if code.starts_with('E') { code.to_string() } else { format!("E{0:0>4}", code) };
match registry.find_description(&normalised) {
Some(ref description) => {
match registry.try_find_description(&normalised) {
Ok(Some(description)) => {
let mut is_in_code_block = false;
let mut text = String::new();

// Slice off the leading newline and print.
for line in description.lines() {
let indent_level =
Expand All @@ -542,16 +544,18 @@ fn handle_explain(registry: Registry, code: &str, output: ErrorOutputType) {
}
text.push('\n');
}

if stdout_isatty() {
show_content_with_pager(&text);
} else {
print!("{}", text);
}
}
None => {
Ok(None) => {
early_error(output, &format!("no extended information for {}", code));
}
Err(InvalidErrorCode) => {
early_error(output, &format!("{} is not a valid error code", code));
}
}
}

Expand Down
5 changes: 3 additions & 2 deletions src/librustc_error_codes/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@

macro_rules! register_diagnostics {
($($ecode:ident: $message:expr,)* ; $($code:ident,)*) => (
pub static DIAGNOSTICS: &[(&str, &str)] = &[
$( (stringify!($ecode), $message), )*
pub static DIAGNOSTICS: &[(&str, Option<&str>)] = &[
$( (stringify!($ecode), Some($message)), )*
$( (stringify!($code), None), )*
];
)
}
Expand Down
6 changes: 3 additions & 3 deletions src/librustc_errors/json.rs
Original file line number Diff line number Diff line change
Expand Up @@ -419,10 +419,10 @@ impl DiagnosticCode {
DiagnosticId::Error(s) => s,
DiagnosticId::Lint(s) => s,
};
let explanation =
je.registry.as_ref().and_then(|registry| registry.find_description(&s));
let je_result =
je.registry.as_ref().map(|registry| registry.try_find_description(&s)).unwrap();

DiagnosticCode { code: s, explanation }
DiagnosticCode { code: s, explanation: je_result.unwrap_or(None) }
})
}
}
8 changes: 6 additions & 2 deletions src/librustc_errors/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -786,8 +786,12 @@ impl HandlerInner {
.emitted_diagnostic_codes
.iter()
.filter_map(|x| match &x {
DiagnosticId::Error(s) if registry.find_description(s).is_some() => {
Some(s.clone())
DiagnosticId::Error(s) => {
if let Ok(Some(_explanation)) = registry.try_find_description(s) {
Some(s.clone())
} else {
None
}
}
_ => None,
})
Expand Down
24 changes: 20 additions & 4 deletions src/librustc_errors/registry.rs
Original file line number Diff line number Diff line change
@@ -1,16 +1,32 @@
use rustc_data_structures::fx::FxHashMap;

#[derive(Debug)]
pub struct InvalidErrorCode;

#[derive(Clone)]
pub struct Registry {
descriptions: FxHashMap<&'static str, &'static str>,
long_descriptions: FxHashMap<&'static str, Option<&'static str>>,
}

impl Registry {
pub fn new(descriptions: &[(&'static str, &'static str)]) -> Registry {
Registry { descriptions: descriptions.iter().cloned().collect() }
pub fn new(long_descriptions: &[(&'static str, Option<&'static str>)]) -> Registry {
Registry { long_descriptions: long_descriptions.iter().cloned().collect() }
}

/// This will panic if an invalid error code is passed in
pub fn find_description(&self, code: &str) -> Option<&'static str> {
self.descriptions.get(code).cloned()
self.try_find_description(code).unwrap()
}
/// Returns `InvalidErrorCode` if the code requested does not exist in the
/// registry. Otherwise, returns an `Option` where `None` means the error
/// code is valid but has no extended information.
pub fn try_find_description(
&self,
code: &str,
) -> Result<Option<&'static str>, InvalidErrorCode> {
if !self.long_descriptions.contains_key(code) {
return Err(InvalidErrorCode);
}
Ok(self.long_descriptions.get(code).unwrap().clone())
}
}