Rollup merge of #127929 - estebank:addr_of, r=compiler-errors

Use more accurate span for `addr_of!` suggestion

Use a multipart suggestion instead of a single whole-span replacement:

```
error[E0796]: creating a shared reference to a mutable static
  --> $DIR/reference-to-mut-static-unsafe-fn.rs:10:18
   |
LL |         let _y = &X;
   |                  ^^ shared reference to mutable static
   |
   = note: this shared reference has lifetime `'static`, but if the static ever gets mutated, or a mutable reference is created, then any further use of this shared reference is Undefined Behavior
help: use `addr_of!` instead to create a raw pointer
   |
LL |         let _y = addr_of!(X);
   |                  ~~~~~~~~~ +
```

compiler/rustc_hir_analysis/src/check/errs.rs

@@ -1,5 +1,4 @@
 use rustc_hir as hir;
-use rustc_hir_pretty::qpath_to_string;
 use rustc_lint_defs::builtin::STATIC_MUT_REFS;
 use rustc_middle::ty::{Mutability, TyCtxt};
 use rustc_span::Span;
@@ -12,9 +11,17 @@ pub fn maybe_expr_static_mut(tcx: TyCtxt<'_>, expr: hir::Expr<'_>) {
  let hir_id = expr.hir_id;
  if let hir::ExprKind::AddrOf(borrow_kind, m, expr) = expr.kind
  && matches!(borrow_kind, hir::BorrowKind::Ref)
- && let Some(var) = path_if_static_mut(tcx, expr)
+ && path_if_static_mut(expr)
  {
- handle_static_mut_ref(tcx, span, var, span.edition().at_least_rust_2024(), m, hir_id);
+ handle_static_mut_ref(
+ tcx,
+ span,
+ span.with_hi(expr.span.lo()),
+ span.shrink_to_hi(),
+ span.edition().at_least_rust_2024(),
+ m,
+ hir_id,
+ );
  }
 }
 
@@ -24,51 +31,53 @@ pub fn maybe_stmt_static_mut(tcx: TyCtxt<'_>, stmt: hir::Stmt<'_>) {
  && let hir::PatKind::Binding(ba, _, _, _) = loc.pat.kind
  && let hir::ByRef::Yes(rmutbl) = ba.0
  && let Some(init) = loc.init
- && let Some(var) = path_if_static_mut(tcx, init)
+ && path_if_static_mut(init)
  {
  handle_static_mut_ref(
  tcx,
  init.span,
- var,
+ init.span.shrink_to_lo(),
+ init.span.shrink_to_hi(),
  loc.span.edition().at_least_rust_2024(),
  rmutbl,
  stmt.hir_id,
  );
  }
 }
 
-fn path_if_static_mut(tcx: TyCtxt<'_>, expr: &hir::Expr<'_>) -> Option<String> {
+fn path_if_static_mut(expr: &hir::Expr<'_>) -> bool {
  if let hir::ExprKind::Path(qpath) = expr.kind
  && let hir::QPath::Resolved(_, path) = qpath
  && let hir::def::Res::Def(def_kind, _) = path.res
  && let hir::def::DefKind::Static { safety: _, mutability: Mutability::Mut, nested: false } =
  def_kind
  {
- return Some(qpath_to_string(&tcx, &qpath));
+ return true;
  }
- None
+ false
 }
 
 fn handle_static_mut_ref(
  tcx: TyCtxt<'_>,
  span: Span,
- var: String,
+ lo: Span,
+ hi: Span,
  e2024: bool,
  mutable: Mutability,
  hir_id: hir::HirId,
 ) {
  if e2024 {
  let (sugg, shared) = if mutable == Mutability::Mut {
- (errors::StaticMutRefSugg::Mut { span, var }, "mutable")
+ (errors::MutRefSugg::Mut { lo, hi }, "mutable")
  } else {
- (errors::StaticMutRefSugg::Shared { span, var }, "shared")
+ (errors::MutRefSugg::Shared { lo, hi }, "shared")
  };
  tcx.dcx().emit_err(errors::StaticMutRef { span, sugg, shared });
  } else {
  let (sugg, shared) = if mutable == Mutability::Mut {
- (errors::RefOfMutStaticSugg::Mut { span, var }, "mutable")
+ (errors::MutRefSugg::Mut { lo, hi }, "mutable")
  } else {
- (errors::RefOfMutStaticSugg::Shared { span, var }, "shared")
+ (errors::MutRefSugg::Shared { lo, hi }, "shared")
  };
  tcx.emit_node_span_lint(
  STATIC_MUT_REFS,

compiler/rustc_hir_analysis/src/errors.rs

@@ -1500,33 +1500,33 @@ pub struct StaticMutRef<'a> {
  #[label]
  pub span: Span,
  #[subdiagnostic]
- pub sugg: StaticMutRefSugg,
+ pub sugg: MutRefSugg,
  pub shared: &'a str,
 }
 
 #[derive(Subdiagnostic)]
-pub enum StaticMutRefSugg {
- #[suggestion(
+pub enum MutRefSugg {
+ #[multipart_suggestion(
  hir_analysis_suggestion,
  style = "verbose",
- code = "addr_of!({var})",
  applicability = "maybe-incorrect"
  )]
  Shared {
- #[primary_span]
- span: Span,
- var: String,
+ #[suggestion_part(code = "addr_of!(")]
+ lo: Span,
+ #[suggestion_part(code = ")")]
+ hi: Span,
  },
- #[suggestion(
+ #[multipart_suggestion(
  hir_analysis_suggestion_mut,
  style = "verbose",
- code = "addr_of_mut!({var})",
  applicability = "maybe-incorrect"
  )]
  Mut {
- #[primary_span]
- span: Span,
- var: String,
+ #[suggestion_part(code = "addr_of_mut!(")]
+ lo: Span,
+ #[suggestion_part(code = ")")]
+ hi: Span,
  },
 }
 
@@ -1539,36 +1539,10 @@ pub struct RefOfMutStatic<'a> {
  #[label]
  pub span: Span,
  #[subdiagnostic]
- pub sugg: RefOfMutStaticSugg,
+ pub sugg: MutRefSugg,
  pub shared: &'a str,
 }
 
-#[derive(Subdiagnostic)]
-pub enum RefOfMutStaticSugg {
- #[suggestion(
- hir_analysis_suggestion,
- style = "verbose",
- code = "addr_of!({var})",
- applicability = "maybe-incorrect"
- )]
- Shared {
- #[primary_span]
- span: Span,
- var: String,
- },
- #[suggestion(
- hir_analysis_suggestion_mut,
- style = "verbose",
- code = "addr_of_mut!({var})",
- applicability = "maybe-incorrect"
- )]
- Mut {
- #[primary_span]
- span: Span,
- var: String,
- },
-}
-
 #[derive(Diagnostic)]
 #[diag(hir_analysis_not_supported_delegation)]
 pub struct NotSupportedDelegation<'a> {

tests/ui/abi/statics/static-mut-foreign.stderr

@@ -11,7 +11,7 @@ LL | static_bound(&rust_dbg_static_mut);
 help: use `addr_of!` instead to create a raw pointer
  |
 LL | static_bound(addr_of!(rust_dbg_static_mut));
- | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ | ~~~~~~~~~ +
 
 warning: creating a mutable reference to mutable static is discouraged
  --> $DIR/static-mut-foreign.rs:33:22
@@ -25,7 +25,7 @@ LL | static_bound_set(&mut rust_dbg_static_mut);
 help: use `addr_of_mut!` instead to create a raw pointer
  |
 LL | static_bound_set(addr_of_mut!(rust_dbg_static_mut));
- | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ | ~~~~~~~~~~~~~ +
 
 warning: 2 warnings emitted
 

tests/ui/borrowck/borrowck-access-permissions.stderr

@@ -11,7 +11,7 @@ LL | let _y2 = &mut static_x_mut;
 help: use `addr_of_mut!` instead to create a raw pointer
  |
 LL | let _y2 = addr_of_mut!(static_x_mut);
- | ~~~~~~~~~~~~~~~~~~~~~~~~~~
+ | ~~~~~~~~~~~~~ +
 
 error[E0596]: cannot borrow `x` as mutable, as it is not declared as mutable
  --> $DIR/borrowck-access-permissions.rs:10:19

tests/ui/borrowck/borrowck-unsafe-static-mutable-borrows.stderr

@@ -11,7 +11,7 @@ LL | let sfoo: *mut Foo = &mut SFOO;
 help: use `addr_of_mut!` instead to create a raw pointer
  |
 LL | let sfoo: *mut Foo = addr_of_mut!(SFOO);
- | ~~~~~~~~~~~~~~~~~~
+ | ~~~~~~~~~~~~~ +
 
 warning: 1 warning emitted
 

tests/ui/borrowck/issue-20801.stderr

@@ -11,7 +11,7 @@ LL | unsafe { &mut GLOBAL_MUT_T }
 help: use `addr_of_mut!` instead to create a raw pointer
  |
 LL | unsafe { addr_of_mut!(GLOBAL_MUT_T) }
- | ~~~~~~~~~~~~~~~~~~~~~~~~~~
+ | ~~~~~~~~~~~~~ +
 
 error[E0507]: cannot move out of a mutable reference
  --> $DIR/issue-20801.rs:27:22

tests/ui/borrowck/issue-55492-borrowck-migrate-scans-parents.stderr

@@ -11,7 +11,7 @@ LL | c1(&mut Y);
 help: use `addr_of_mut!` instead to create a raw pointer
  |
 LL | c1(addr_of_mut!(Y));
- | ~~~~~~~~~~~~~~~
+ | ~~~~~~~~~~~~~ +
 
 warning: creating a mutable reference to mutable static is discouraged
  --> $DIR/issue-55492-borrowck-migrate-scans-parents.rs:27:16
@@ -25,7 +25,7 @@ LL | c1(&mut Z);
 help: use `addr_of_mut!` instead to create a raw pointer
  |
 LL | c1(addr_of_mut!(Z));
- | ~~~~~~~~~~~~~~~
+ | ~~~~~~~~~~~~~ +
 
 warning: creating a mutable reference to mutable static is discouraged
  --> $DIR/issue-55492-borrowck-migrate-scans-parents.rs:64:37
@@ -39,7 +39,7 @@ LL | borrowck_closures_unique::e(&mut X);
 help: use `addr_of_mut!` instead to create a raw pointer
  |
 LL | borrowck_closures_unique::e(addr_of_mut!(X));
- | ~~~~~~~~~~~~~~~
+ | ~~~~~~~~~~~~~ +
 
 error[E0594]: cannot assign to `x`, as it is not declared as mutable
  --> $DIR/issue-55492-borrowck-migrate-scans-parents.rs:9:46

tests/ui/consts/const_let_assign2.stderr

@@ -11,7 +11,7 @@ LL | let ptr = unsafe { &mut BB };
 help: use `addr_of_mut!` instead to create a raw pointer
  |
 LL | let ptr = unsafe { addr_of_mut!(BB) };
- | ~~~~~~~~~~~~~~~~
+ | ~~~~~~~~~~~~~ +
 
 warning: 1 warning emitted
 

tests/ui/drop/issue-23338-ensure-param-drop-order.stderr

@@ -11,7 +11,7 @@ LL | (mem::size_of_val(&trails) * 8) as u32
 help: use `addr_of!` instead to create a raw pointer
  |
 LL | (mem::size_of_val(addr_of!(trails)) * 8) as u32
- | ~~~~~~~~~~~~~~~~
+ | ~~~~~~~~~ +
 
 warning: 1 warning emitted
 

tests/ui/drop/issue-23611-enum-swap-in-drop.stderr

@@ -11,7 +11,7 @@ LL | (mem::size_of_val(&trails) * 8) as u32
 help: use `addr_of!` instead to create a raw pointer
  |
 LL | (mem::size_of_val(addr_of!(trails)) * 8) as u32
- | ~~~~~~~~~~~~~~~~
+ | ~~~~~~~~~ +
 
 warning: 1 warning emitted
 

tests/ui/issues/issue-54410.stderr

@@ -19,7 +19,7 @@ LL | println!("{:p}", unsafe { &symbol });
 help: use `addr_of!` instead to create a raw pointer
  |
 LL | println!("{:p}", unsafe { addr_of!(symbol) });
- | ~~~~~~~~~~~~~~~~
+ | ~~~~~~~~~ +
 
 error: aborting due to 1 previous error; 1 warning emitted
 

tests/ui/nll/borrowck-thread-local-static-mut-borrow-outlives-fn.stderr

@@ -11,7 +11,7 @@ LL | S1 { a: unsafe { &mut X1 } }
 help: use `addr_of_mut!` instead to create a raw pointer
  |
 LL | S1 { a: unsafe { addr_of_mut!(X1) } }
- | ~~~~~~~~~~~~~~~~
+ | ~~~~~~~~~~~~~ +
 
 warning: 1 warning emitted
 

tests/ui/static/reference-to-mut-static-safe.e2021.stderr

@@ -11,7 +11,7 @@ LL | let _x = &X;
 help: use `addr_of!` instead to create a raw pointer
  |
 LL | let _x = addr_of!(X);
- | ~~~~~~~~~~~
+ | ~~~~~~~~~ +
 
 error[E0133]: use of mutable static is unsafe and requires unsafe function or block
  --> $DIR/reference-to-mut-static-safe.rs:9:15

tests/ui/static/reference-to-mut-static-safe.e2024.stderr

@@ -8,7 +8,7 @@ LL | let _x = &X;
 help: use `addr_of!` instead to create a raw pointer
  |
 LL | let _x = addr_of!(X);
- | ~~~~~~~~~~~
+ | ~~~~~~~~~ +
 
 error[E0133]: use of mutable static is unsafe and requires unsafe block
  --> $DIR/reference-to-mut-static-safe.rs:9:15

tests/ui/static/reference-to-mut-static-unsafe-fn.stderr

@@ -8,7 +8,7 @@ LL | let _y = &X;
 help: use `addr_of!` instead to create a raw pointer
  |
 LL | let _y = addr_of!(X);
- | ~~~~~~~~~~~
+ | ~~~~~~~~~ +
 
 error[E0796]: creating a shared reference to a mutable static
  --> $DIR/reference-to-mut-static-unsafe-fn.rs:13:22
@@ -20,7 +20,7 @@ LL | let ref _a = X;
 help: use `addr_of!` instead to create a raw pointer
  |
 LL | let ref _a = addr_of!(X);
- | ~~~~~~~~~~~
+ | +++++++++ +
 
 error[E0796]: creating a mutable reference to a mutable static
  --> $DIR/reference-to-mut-static-unsafe-fn.rs:16:26
@@ -32,7 +32,7 @@ LL | let ref mut _a = X;
 help: use `addr_of_mut!` instead to create a raw pointer
  |
 LL | let ref mut _a = addr_of_mut!(X);
- | ~~~~~~~~~~~~~~~
+ | +++++++++++++ +
 
 error[E0796]: creating a shared reference to a mutable static
  --> $DIR/reference-to-mut-static-unsafe-fn.rs:19:25
@@ -44,7 +44,7 @@ LL | let (_b, _c) = (&X, &mut Y);
 help: use `addr_of!` instead to create a raw pointer
  |
 LL | let (_b, _c) = (addr_of!(X), &mut Y);
- | ~~~~~~~~~~~
+ | ~~~~~~~~~ +
 
 error[E0796]: creating a mutable reference to a mutable static
  --> $DIR/reference-to-mut-static-unsafe-fn.rs:19:29
@@ -56,7 +56,7 @@ LL | let (_b, _c) = (&X, &mut Y);
 help: use `addr_of_mut!` instead to create a raw pointer
  |
 LL | let (_b, _c) = (&X, addr_of_mut!(Y));
- | ~~~~~~~~~~~~~~~
+ | ~~~~~~~~~~~~~ +
 
 error[E0796]: creating a shared reference to a mutable static
  --> $DIR/reference-to-mut-static-unsafe-fn.rs:23:13
@@ -68,7 +68,7 @@ LL | foo(&X);
 help: use `addr_of!` instead to create a raw pointer
  |
 LL | foo(addr_of!(X));
- | ~~~~~~~~~~~
+ | ~~~~~~~~~ +
 
 error: aborting due to 6 previous errors