raw_strings: separate raw string detection from lint logic

This commit is contained in:
Samuel Tardieu 2024-10-05 15:58:30 +02:00
parent 753629bb33
commit 846bd30cfe

View File

@ -81,94 +81,105 @@ impl EarlyLintPass for RawStrings {
&& !in_external_macro(cx.sess(), expr.span) && !in_external_macro(cx.sess(), expr.span)
&& expr.span.check_source_text(cx, |src| src.starts_with(prefix)) && expr.span.check_source_text(cx, |src| src.starts_with(prefix))
{ {
let str = lit.symbol.as_str(); self.check_raw_string(cx, lit.symbol.as_str(), expr.span, prefix, max, lit.kind.descr());
let descr = lit.kind.descr(); }
}
}
if !str.contains(['\\', '"']) { impl RawStrings {
span_lint_and_then( fn check_raw_string(
cx, &mut self,
NEEDLESS_RAW_STRINGS, cx: &EarlyContext<'_>,
expr.span, str: &str,
"unnecessary raw string literal", lit_span: Span,
|diag| { prefix: &str,
let (start, end) = hash_spans(expr.span, prefix.len(), 0, max); max: u8,
descr: &str,
) {
if !str.contains(['\\', '"']) {
span_lint_and_then(
cx,
NEEDLESS_RAW_STRINGS,
lit_span,
"unnecessary raw string literal",
|diag| {
let (start, end) = hash_spans(lit_span, prefix.len(), 0, max);
// BytePos: skip over the `b` in `br`, we checked the prefix appears in the source text // BytePos: skip over the `b` in `br`, we checked the prefix appears in the source text
let r_pos = expr.span.lo() + BytePos::from_usize(prefix.len() - 1); let r_pos = lit_span.lo() + BytePos::from_usize(prefix.len() - 1);
let start = start.with_lo(r_pos); let start = start.with_lo(r_pos);
let mut remove = vec![(start, String::new())]; let mut remove = vec![(start, String::new())];
// avoid debug ICE from empty suggestions // avoid debug ICE from empty suggestions
if !end.is_empty() { if !end.is_empty() {
remove.push((end, String::new())); remove.push((end, String::new()));
}
diag.multipart_suggestion_verbose(
format!("use a plain {descr} literal instead"),
remove,
Applicability::MachineApplicable,
);
},
);
if !matches!(cx.get_lint_level(NEEDLESS_RAW_STRINGS), rustc_lint::Allow) {
return;
}
}
let mut req = {
let mut following_quote = false;
let mut req = 0;
// `once` so a raw string ending in hashes is still checked
let num = str.as_bytes().iter().chain(once(&0)).try_fold(0u8, |acc, &b| {
match b {
b'"' if !following_quote => (following_quote, req) = (true, 1),
b'#' => req += u8::from(following_quote),
_ => {
if following_quote {
following_quote = false;
if req == max {
return ControlFlow::Break(req);
}
return ControlFlow::Continue(acc.max(req));
}
},
} }
ControlFlow::Continue(acc) diag.multipart_suggestion_verbose(
}); format!("use a plain {descr} literal instead"),
remove,
match num { Applicability::MachineApplicable,
ControlFlow::Continue(num) | ControlFlow::Break(num) => num, );
} },
}; );
if self.allow_one_hash_in_raw_strings { if !matches!(cx.get_lint_level(NEEDLESS_RAW_STRINGS), rustc_lint::Allow) {
req = req.max(1); return;
} }
if req < max { }
span_lint_and_then(
cx,
NEEDLESS_RAW_STRING_HASHES,
expr.span,
"unnecessary hashes around raw string literal",
|diag| {
let (start, end) = hash_spans(expr.span, prefix.len(), req, max);
let message = match max - req { let mut req = {
_ if req == 0 => format!("remove all the hashes around the {descr} literal"), let mut following_quote = false;
1 => format!("remove one hash from both sides of the {descr} literal"), let mut req = 0;
n => format!("remove {n} hashes from both sides of the {descr} literal"), // `once` so a raw string ending in hashes is still checked
}; let num = str.as_bytes().iter().chain(once(&0)).try_fold(0u8, |acc, &b| {
match b {
b'"' if !following_quote => (following_quote, req) = (true, 1),
b'#' => req += u8::from(following_quote),
_ => {
if following_quote {
following_quote = false;
diag.multipart_suggestion( if req == max {
message, return ControlFlow::Break(req);
vec![(start, String::new()), (end, String::new())], }
Applicability::MachineApplicable,
); return ControlFlow::Continue(acc.max(req));
}
}, },
); }
ControlFlow::Continue(acc)
});
match num {
ControlFlow::Continue(num) | ControlFlow::Break(num) => num,
} }
};
if self.allow_one_hash_in_raw_strings {
req = req.max(1);
}
if req < max {
span_lint_and_then(
cx,
NEEDLESS_RAW_STRING_HASHES,
lit_span,
"unnecessary hashes around raw string literal",
|diag| {
let (start, end) = hash_spans(lit_span, prefix.len(), req, max);
let message = match max - req {
_ if req == 0 => format!("remove all the hashes around the {descr} literal"),
1 => format!("remove one hash from both sides of the {descr} literal"),
n => format!("remove {n} hashes from both sides of the {descr} literal"),
};
diag.multipart_suggestion(
message,
vec![(start, String::new()), (end, String::new())],
Applicability::MachineApplicable,
);
},
);
} }
} }
} }