Rollup merge of #139392 - compiler-errors:raw-expr, r=oli-obk

Detect and provide suggestion for `&raw EXPR`

When emitting an error in the parser, and we detect that the previous token was `raw` and we *could* have consumed `const`/`mut`, suggest that this may have been a mistyped raw ref expr. To do this, we add `const`/`mut` to the expected token set when parsing `&raw` as an expression (which does not affect the "good path" of parsing, for the record).

This is kind of a rudimentary error improvement, since it doesn't actually attempt to recover anything, leading to some other knock-on errors b/c we still treat `&raw` as the expression that was parsed... but at least we add the suggestion! I don't think the parser grammar means we can faithfully recover `&raw EXPR` early, i.e. during `parse_expr_borrow`.

Fixes #133231
This commit is contained in:
Matthias Krüger 2025-04-14 18:15:31 +02:00 committed by GitHub
commit bf49dfc943
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 189 additions and 1 deletions

View file

@ -609,6 +609,8 @@ impl<'a> Parser<'a> {
// FIXME: translation requires list formatting (for `expect`)
let mut err = self.dcx().struct_span_err(self.token.span, msg_exp);
self.label_expected_raw_ref(&mut err);
// Look for usages of '=>' where '>=' was probably intended
if self.token == token::FatArrow
&& expected.iter().any(|tok| matches!(tok, TokenType::Operator | TokenType::Le))
@ -750,6 +752,25 @@ impl<'a> Parser<'a> {
Err(err)
}
/// Adds a label when `&raw EXPR` was written instead of `&raw const EXPR`/`&raw mut EXPR`.
///
/// Given that not all parser diagnostics flow through `expected_one_of_not_found`, this
/// label may need added to other diagnostics emission paths as needed.
pub(super) fn label_expected_raw_ref(&mut self, err: &mut Diag<'_>) {
if self.prev_token.is_keyword(kw::Raw)
&& self.expected_token_types.contains(TokenType::KwMut)
&& self.expected_token_types.contains(TokenType::KwConst)
&& self.token.can_begin_expr()
{
err.span_suggestions(
self.prev_token.span.shrink_to_hi(),
"`&raw` must be followed by `const` or `mut` to be a raw reference expression",
[" const".to_string(), " mut".to_string()],
Applicability::MaybeIncorrect,
);
}
}
/// Checks if the current token or the previous token are misspelled keywords
/// and adds a helpful suggestion.
fn check_for_misspelled_kw(&self, err: &mut Diag<'_>, expected: &[TokenType]) {

View file

@ -827,6 +827,18 @@ impl<'a> Parser<'a> {
if let Some(lt) = lifetime {
self.error_remove_borrow_lifetime(span, lt.ident.span.until(expr.span));
}
// Add expected tokens if we parsed `&raw` as an expression.
// This will make sure we see "expected `const`, `mut`", and
// guides recovery in case we write `&raw expr`.
if borrow_kind == ast::BorrowKind::Ref
&& mutbl == ast::Mutability::Not
&& matches!(&expr.kind, ExprKind::Path(None, p) if p.is_ident(kw::Raw))
{
self.expected_token_types.insert(TokenType::KwMut);
self.expected_token_types.insert(TokenType::KwConst);
}
Ok((span, ExprKind::AddrOf(borrow_kind, mutbl, expr)))
}

View file

@ -518,7 +518,11 @@ impl<'a> Parser<'a> {
let prev = self.prev_token.span;
let sp = self.token.span;
let mut e = self.dcx().struct_span_err(sp, msg);
let do_not_suggest_help = self.token.is_keyword(kw::In) || self.token == token::Colon;
self.label_expected_raw_ref(&mut e);
let do_not_suggest_help = self.token.is_keyword(kw::In)
|| self.token == token::Colon
|| self.prev_token.is_keyword(kw::Raw);
// Check to see if the user has written something like
//