clippy_lints/src/utils/sugg.rs

   1 //! Contains utility functions to generate suggestions.
   2 #![deny(clippy::missing_docs_in_private_items)]
   3
   4 use matches::matches;
   5 use crate::rustc::hir;
   6 use crate::rustc::lint::{EarlyContext, LateContext, LintContext};
   7 use crate::rustc_errors;
   8 use std::borrow::Cow;
   9 use std::fmt::Display;
  10 use std;
  11 use crate::syntax::source_map::{CharPos, Span};
  12 use crate::syntax::parse::token;
  13 use crate::syntax::print::pprust::token_to_string;
  14 use crate::syntax::util::parser::AssocOp;
  15 use crate::syntax::ast;
  16 use crate::utils::{higher, snippet, snippet_opt};
  17 use crate::syntax_pos::{BytePos, Pos};
  18 use crate::rustc_errors::Applicability;
  19
  20 /// A helper type to build suggestion correctly handling parenthesis.
  21 pub enum Sugg<'a> {
  22     /// An expression that never needs parenthesis such as `1337` or `[0; 42]`.
  23     NonParen(Cow<'a, str>),
  24     /// An expression that does not fit in other variants.
  25     MaybeParen(Cow<'a, str>),
  26     /// A binary operator expression, including `as`-casts and explicit type
  27     /// coercion.
  28     BinOp(AssocOp, Cow<'a, str>),
  29 }
  30
  31 /// Literal constant `1`, for convenience.
  32 pub const ONE: Sugg<'static> = Sugg::NonParen(Cow::Borrowed("1"));
  33
  34 impl Display for Sugg<'_> {
  35     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
  36         match *self {
  37             Sugg::NonParen(ref s) | Sugg::MaybeParen(ref s) | Sugg::BinOp(_, ref s) => s.fmt(f),
  38         }
  39     }
  40 }
  41
  42 #[allow(clippy::wrong_self_convention)] // ok, because of the function `as_ty` method
  43 impl<'a> Sugg<'a> {
  44     /// Prepare a suggestion from an expression.
  45     pub fn hir_opt(cx: &LateContext<'_, '_>, expr: &hir::Expr) -> Option<Self> {
  46         snippet_opt(cx, expr.span).map(|snippet| {
  47             let snippet = Cow::Owned(snippet);
  48             match expr.node {
  49                 hir::ExprKind::AddrOf(..) |
  50                 hir::ExprKind::Box(..) |
  51                 hir::ExprKind::Closure(.., _) |
  52                 hir::ExprKind::If(..) |
  53                 hir::ExprKind::Unary(..) |
  54                 hir::ExprKind::Match(..) => Sugg::MaybeParen(snippet),
  55                 hir::ExprKind::Continue(..) |
  56                 hir::ExprKind::Yield(..) |
  57                 hir::ExprKind::Array(..) |
  58                 hir::ExprKind::Block(..) |
  59                 hir::ExprKind::Break(..) |
  60                 hir::ExprKind::Call(..) |
  61                 hir::ExprKind::Field(..) |
  62                 hir::ExprKind::Index(..) |
  63                 hir::ExprKind::InlineAsm(..) |
  64                 hir::ExprKind::Lit(..) |
  65                 hir::ExprKind::Loop(..) |
  66                 hir::ExprKind::MethodCall(..) |
  67                 hir::ExprKind::Path(..) |
  68                 hir::ExprKind::Repeat(..) |
  69                 hir::ExprKind::Ret(..) |
  70                 hir::ExprKind::Struct(..) |
  71                 hir::ExprKind::Tup(..) |
  72                 hir::ExprKind::While(..) => Sugg::NonParen(snippet),
  73                 hir::ExprKind::Assign(..) => Sugg::BinOp(AssocOp::Assign, snippet),
  74                 hir::ExprKind::AssignOp(op, ..) => Sugg::BinOp(hirbinop2assignop(op), snippet),
  75                 hir::ExprKind::Binary(op, ..) => Sugg::BinOp(AssocOp::from_ast_binop(higher::binop(op.node)), snippet),
  76                 hir::ExprKind::Cast(..) => Sugg::BinOp(AssocOp::As, snippet),
  77                 hir::ExprKind::Type(..) => Sugg::BinOp(AssocOp::Colon, snippet),
  78             }
  79         })
  80     }
  81
  82     /// Convenience function around `hir_opt` for suggestions with a default
  83     /// text.
  84     pub fn hir(cx: &LateContext<'_, '_>, expr: &hir::Expr, default: &'a str) -> Self {
  85         Self::hir_opt(cx, expr).unwrap_or_else(|| Sugg::NonParen(Cow::Borrowed(default)))
  86     }
  87
  88     /// Prepare a suggestion from an expression.
  89     pub fn ast(cx: &EarlyContext<'_>, expr: &ast::Expr, default: &'a str) -> Self {
  90         use crate::syntax::ast::RangeLimits;
  91
  92         let snippet = snippet(cx, expr.span, default);
  93
  94         match expr.node {
  95             ast::ExprKind::AddrOf(..) |
  96             ast::ExprKind::Box(..) |
  97             ast::ExprKind::Closure(..) |
  98             ast::ExprKind::If(..) |
  99             ast::ExprKind::IfLet(..) |
 100             ast::ExprKind::ObsoleteInPlace(..) |
 101             ast::ExprKind::Unary(..) |
 102             ast::ExprKind::Match(..) => Sugg::MaybeParen(snippet),
 103             ast::ExprKind::Async(..) |
 104             ast::ExprKind::Block(..) |
 105             ast::ExprKind::Break(..) |
 106             ast::ExprKind::Call(..) |
 107             ast::ExprKind::Continue(..) |
 108             ast::ExprKind::Yield(..) |
 109             ast::ExprKind::Field(..) |
 110             ast::ExprKind::ForLoop(..) |
 111             ast::ExprKind::Index(..) |
 112             ast::ExprKind::InlineAsm(..) |
 113             ast::ExprKind::Lit(..) |
 114             ast::ExprKind::Loop(..) |
 115             ast::ExprKind::Mac(..) |
 116             ast::ExprKind::MethodCall(..) |
 117             ast::ExprKind::Paren(..) |
 118             ast::ExprKind::Path(..) |
 119             ast::ExprKind::Repeat(..) |
 120             ast::ExprKind::Ret(..) |
 121             ast::ExprKind::Struct(..) |
 122             ast::ExprKind::Try(..) |
 123             ast::ExprKind::TryBlock(..) |
 124             ast::ExprKind::Tup(..) |
 125             ast::ExprKind::Array(..) |
 126             ast::ExprKind::While(..) |
 127             ast::ExprKind::WhileLet(..) => Sugg::NonParen(snippet),
 128             ast::ExprKind::Range(.., RangeLimits::HalfOpen) => Sugg::BinOp(AssocOp::DotDot, snippet),
 129             ast::ExprKind::Range(.., RangeLimits::Closed) => Sugg::BinOp(AssocOp::DotDotEq, snippet),
 130             ast::ExprKind::Assign(..) => Sugg::BinOp(AssocOp::Assign, snippet),
 131             ast::ExprKind::AssignOp(op, ..) => Sugg::BinOp(astbinop2assignop(op), snippet),
 132             ast::ExprKind::Binary(op, ..) => Sugg::BinOp(AssocOp::from_ast_binop(op.node), snippet),
 133             ast::ExprKind::Cast(..) => Sugg::BinOp(AssocOp::As, snippet),
 134             ast::ExprKind::Type(..) => Sugg::BinOp(AssocOp::Colon, snippet),
 135         }
 136     }
 137
 138     /// Convenience method to create the `<lhs> && <rhs>` suggestion.
 139     pub fn and(self, rhs: &Self) -> Sugg<'static> {
 140         make_binop(ast::BinOpKind::And, &self, rhs)
 141     }
 142
 143     /// Convenience method to create the `<lhs> as <rhs>` suggestion.
 144     pub fn as_ty<R: Display>(self, rhs: R) -> Sugg<'static> {
 145         make_assoc(AssocOp::As, &self, &Sugg::NonParen(rhs.to_string().into()))
 146     }
 147
 148     /// Convenience method to create the `&<expr>` suggestion.
 149     pub fn addr(self) -> Sugg<'static> {
 150         make_unop("&", self)
 151     }
 152
 153     /// Convenience method to create the `&mut <expr>` suggestion.
 154     pub fn mut_addr(self) -> Sugg<'static> {
 155         make_unop("&mut ", self)
 156     }
 157
 158     /// Convenience method to create the `*<expr>` suggestion.
 159     pub fn deref(self) -> Sugg<'static> {
 160         make_unop("*", self)
 161     }
 162
 163     /// Convenience method to create the `&*<expr>` suggestion. Currently this
 164     /// is needed because `sugg.deref().addr()` produces an unnecessary set of
 165     /// parentheses around the deref.
 166     pub fn addr_deref(self) -> Sugg<'static> {
 167         make_unop("&*", self)
 168     }
 169
 170     /// Convenience method to create the `&mut *<expr>` suggestion. Currently
 171     /// this is needed because `sugg.deref().mut_addr()` produces an unnecessary
 172     /// set of parentheses around the deref.
 173     pub fn mut_addr_deref(self) -> Sugg<'static> {
 174         make_unop("&mut *", self)
 175     }
 176
 177     /// Convenience method to create the `<lhs>..<rhs>` or `<lhs>...<rhs>`
 178     /// suggestion.
 179     #[allow(dead_code)]
 180     pub fn range(self, end: &Self, limit: ast::RangeLimits) -> Sugg<'static> {
 181         match limit {
 182             ast::RangeLimits::HalfOpen => make_assoc(AssocOp::DotDot, &self, end),
 183             ast::RangeLimits::Closed => make_assoc(AssocOp::DotDotEq, &self, end),
 184         }
 185     }
 186
 187     /// Add parenthesis to any expression that might need them. Suitable to the
 188     /// `self` argument of
 189     /// a method call (eg. to build `bar.foo()` or `(1 + 2).foo()`).
 190     pub fn maybe_par(self) -> Self {
 191         match self {
 192             Sugg::NonParen(..) => self,
 193             // (x) and (x).y() both don't need additional parens
 194             Sugg::MaybeParen(sugg) => if sugg.starts_with('(') && sugg.ends_with(')') {
 195                 Sugg::MaybeParen(sugg)
 196             } else {
 197                 Sugg::NonParen(format!("({})", sugg).into())
 198             },
 199             Sugg::BinOp(_, sugg) => Sugg::NonParen(format!("({})", sugg).into()),
 200         }
 201     }
 202 }
 203
 204 impl<'a, 'b> std::ops::Add<Sugg<'b>> for Sugg<'a> {
 205     type Output = Sugg<'static>;
 206     fn add(self, rhs: Sugg<'b>) -> Sugg<'static> {
 207         make_binop(ast::BinOpKind::Add, &self, &rhs)
 208     }
 209 }
 210
 211 impl<'a, 'b> std::ops::Sub<Sugg<'b>> for Sugg<'a> {
 212     type Output = Sugg<'static>;
 213     fn sub(self, rhs: Sugg<'b>) -> Sugg<'static> {
 214         make_binop(ast::BinOpKind::Sub, &self, &rhs)
 215     }
 216 }
 217
 218 impl<'a> std::ops::Not for Sugg<'a> {
 219     type Output = Sugg<'static>;
 220     fn not(self) -> Sugg<'static> {
 221         make_unop("!", self)
 222     }
 223 }
 224
 225 /// Helper type to display either `foo` or `(foo)`.
 226 struct ParenHelper<T> {
 227     /// Whether parenthesis are needed.
 228     paren: bool,
 229     /// The main thing to display.
 230     wrapped: T,
 231 }
 232
 233 impl<T> ParenHelper<T> {
 234     /// Build a `ParenHelper`.
 235     fn new(paren: bool, wrapped: T) -> Self {
 236         Self {
 237             paren,
 238             wrapped,
 239         }
 240     }
 241 }
 242
 243 impl<T: Display> Display for ParenHelper<T> {
 244     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
 245         if self.paren {
 246             write!(f, "({})", self.wrapped)
 247         } else {
 248             self.wrapped.fmt(f)
 249         }
 250     }
 251 }
 252
 253 /// Build the string for `<op><expr>` adding parenthesis when necessary.
 254 ///
 255 /// For convenience, the operator is taken as a string because all unary
 256 /// operators have the same
 257 /// precedence.
 258 pub fn make_unop(op: &str, expr: Sugg<'_>) -> Sugg<'static> {
 259     Sugg::MaybeParen(format!("{}{}", op, expr.maybe_par()).into())
 260 }
 261
 262 /// Build the string for `<lhs> <op> <rhs>` adding parenthesis when necessary.
 263 ///
 264 /// Precedence of shift operator relative to other arithmetic operation is
 265 /// often confusing so
 266 /// parenthesis will always be added for a mix of these.
 267 pub fn make_assoc(op: AssocOp, lhs: &Sugg<'_>, rhs: &Sugg<'_>) -> Sugg<'static> {
 268     /// Whether the operator is a shift operator `<<` or `>>`.
 269     fn is_shift(op: &AssocOp) -> bool {
 270         matches!(*op, AssocOp::ShiftLeft | AssocOp::ShiftRight)
 271     }
 272
 273     /// Whether the operator is a arithmetic operator (`+`, `-`, `*`, `/`, `%`).
 274     fn is_arith(op: &AssocOp) -> bool {
 275         matches!(
 276             *op,
 277             AssocOp::Add | AssocOp::Subtract | AssocOp::Multiply | AssocOp::Divide | AssocOp::Modulus
 278         )
 279     }
 280
 281     /// Whether the operator `op` needs parenthesis with the operator `other`
 282     /// in the direction
 283     /// `dir`.
 284     fn needs_paren(op: &AssocOp, other: &AssocOp, dir: Associativity) -> bool {
 285         other.precedence() < op.precedence()
 286             || (other.precedence() == op.precedence()
 287                 && ((op != other && associativity(op) != dir)
 288                     || (op == other && associativity(op) != Associativity::Both)))
 289             || is_shift(op) && is_arith(other) || is_shift(other) && is_arith(op)
 290     }
 291
 292     let lhs_paren = if let Sugg::BinOp(ref lop, _) = *lhs {
 293         needs_paren(&op, lop, Associativity::Left)
 294     } else {
 295         false
 296     };
 297
 298     let rhs_paren = if let Sugg::BinOp(ref rop, _) = *rhs {
 299         needs_paren(&op, rop, Associativity::Right)
 300     } else {
 301         false
 302     };
 303
 304     let lhs = ParenHelper::new(lhs_paren, lhs);
 305     let rhs = ParenHelper::new(rhs_paren, rhs);
 306     let sugg = match op {
 307         AssocOp::Add |
 308         AssocOp::BitAnd |
 309         AssocOp::BitOr |
 310         AssocOp::BitXor |
 311         AssocOp::Divide |
 312         AssocOp::Equal |
 313         AssocOp::Greater |
 314         AssocOp::GreaterEqual |
 315         AssocOp::LAnd |
 316         AssocOp::LOr |
 317         AssocOp::Less |
 318         AssocOp::LessEqual |
 319         AssocOp::Modulus |
 320         AssocOp::Multiply |
 321         AssocOp::NotEqual |
 322         AssocOp::ShiftLeft |
 323         AssocOp::ShiftRight |
 324         AssocOp::Subtract => format!("{} {} {}", lhs, op.to_ast_binop().expect("Those are AST ops").to_string(), rhs),
 325         AssocOp::Assign => format!("{} = {}", lhs, rhs),
 326         AssocOp::ObsoleteInPlace => format!("in ({}) {}", lhs, rhs),
 327         AssocOp::AssignOp(op) => format!("{} {}= {}", lhs, token_to_string(&token::BinOp(op)), rhs),
 328         AssocOp::As => format!("{} as {}", lhs, rhs),
 329         AssocOp::DotDot => format!("{}..{}", lhs, rhs),
 330         AssocOp::DotDotEq => format!("{}..={}", lhs, rhs),
 331         AssocOp::Colon => format!("{}: {}", lhs, rhs),
 332     };
 333
 334     Sugg::BinOp(op, sugg.into())
 335 }
 336
 337 /// Convenience wrapper around `make_assoc` and `AssocOp::from_ast_binop`.
 338 pub fn make_binop(op: ast::BinOpKind, lhs: &Sugg<'_>, rhs: &Sugg<'_>) -> Sugg<'static> {
 339     make_assoc(AssocOp::from_ast_binop(op), lhs, rhs)
 340 }
 341
 342 #[derive(PartialEq, Eq, Clone, Copy)]
 343 /// Operator associativity.
 344 enum Associativity {
 345     /// The operator is both left-associative and right-associative.
 346     Both,
 347     /// The operator is left-associative.
 348     Left,
 349     /// The operator is not associative.
 350     None,
 351     /// The operator is right-associative.
 352     Right,
 353 }
 354
 355 /// Return the associativity/fixity of an operator. The difference with
 356 /// `AssocOp::fixity` is that
 357 /// an operator can be both left and right associative (such as `+`:
 358 /// `a + b + c == (a + b) + c == a + (b + c)`.
 359 ///
 360 /// Chained `as` and explicit `:` type coercion never need inner parenthesis so
 361 /// they are considered
 362 /// associative.
 363 fn associativity(op: &AssocOp) -> Associativity {
 364     use crate::syntax::util::parser::AssocOp::*;
 365
 366     match *op {
 367         ObsoleteInPlace | Assign | AssignOp(_) => Associativity::Right,
 368         Add | BitAnd | BitOr | BitXor | LAnd | LOr | Multiply | As | Colon => Associativity::Both,
 369         Divide |
 370         Equal |
 371         Greater |
 372         GreaterEqual |
 373         Less |
 374         LessEqual |
 375         Modulus |
 376         NotEqual |
 377         ShiftLeft |
 378         ShiftRight |
 379         Subtract => Associativity::Left,
 380         DotDot | DotDotEq => Associativity::None,
 381     }
 382 }
 383
 384 /// Convert a `hir::BinOp` to the corresponding assigning binary operator.
 385 fn hirbinop2assignop(op: hir::BinOp) -> AssocOp {
 386     use crate::syntax::parse::token::BinOpToken::*;
 387
 388     AssocOp::AssignOp(match op.node {
 389         hir::BinOpKind::Add => Plus,
 390         hir::BinOpKind::BitAnd => And,
 391         hir::BinOpKind::BitOr => Or,
 392         hir::BinOpKind::BitXor => Caret,
 393         hir::BinOpKind::Div => Slash,
 394         hir::BinOpKind::Mul => Star,
 395         hir::BinOpKind::Rem => Percent,
 396         hir::BinOpKind::Shl => Shl,
 397         hir::BinOpKind::Shr => Shr,
 398         hir::BinOpKind::Sub => Minus,
 399
 400         | hir::BinOpKind::And
 401         | hir::BinOpKind::Eq
 402         | hir::BinOpKind::Ge
 403         | hir::BinOpKind::Gt
 404         | hir::BinOpKind::Le
 405         | hir::BinOpKind::Lt
 406         | hir::BinOpKind::Ne
 407         | hir::BinOpKind::Or
 408         => panic!("This operator does not exist"),
 409     })
 410 }
 411
 412 /// Convert an `ast::BinOp` to the corresponding assigning binary operator.
 413 fn astbinop2assignop(op: ast::BinOp) -> AssocOp {
 414     use crate::syntax::ast::BinOpKind::*;
 415     use crate::syntax::parse::token::BinOpToken;
 416
 417     AssocOp::AssignOp(match op.node {
 418         Add => BinOpToken::Plus,
 419         BitAnd => BinOpToken::And,
 420         BitOr => BinOpToken::Or,
 421         BitXor => BinOpToken::Caret,
 422         Div => BinOpToken::Slash,
 423         Mul => BinOpToken::Star,
 424         Rem => BinOpToken::Percent,
 425         Shl => BinOpToken::Shl,
 426         Shr => BinOpToken::Shr,
 427         Sub => BinOpToken::Minus,
 428         And | Eq | Ge | Gt | Le | Lt | Ne | Or => panic!("This operator does not exist"),
 429     })
 430 }
 431
 432 /// Return the indentation before `span` if there are nothing but `[ \t]`
 433 /// before it on its line.
 434 fn indentation<'a, T: LintContext<'a>>(cx: &T, span: Span) -> Option<String> {
 435     let lo = cx.sess().source_map().lookup_char_pos(span.lo());
 436     if let Some(line) = lo.file
 437         .get_line(lo.line - 1 /* line numbers in `Loc` are 1-based */)
 438     {
 439         if let Some((pos, _)) = line.char_indices().find(|&(_, c)| c != ' ' && c != '\t') {
 440             // we can mix char and byte positions here because we only consider `[ \t]`
 441             if lo.col == CharPos(pos) {
 442                 Some(line[..pos].into())
 443             } else {
 444                 None
 445             }
 446         } else {
 447             None
 448         }
 449     } else {
 450         None
 451     }
 452 }
 453
 454 /// Convenience extension trait for `DiagnosticBuilder`.
 455 pub trait DiagnosticBuilderExt<'a, T: LintContext<'a>> {
 456     /// Suggests to add an attribute to an item.
 457     ///
 458     /// Correctly handles indentation of the attribute and item.
 459     ///
 460     /// # Example
 461     ///
 462     /// ```rust,ignore
 463     /// db.suggest_item_with_attr(cx, item, "#[derive(Default)]");
 464     /// ```
 465     fn suggest_item_with_attr<D: Display + ?Sized>(&mut self, cx: &T, item: Span, msg: &str, attr: &D, applicability: Applicability);
 466
 467     /// Suggest to add an item before another.
 468     ///
 469     /// The item should not be indented (expect for inner indentation).
 470     ///
 471     /// # Example
 472     ///
 473     /// ```rust,ignore
 474     /// db.suggest_prepend_item(cx, item,
 475     /// "fn foo() {
 476     ///     bar();
 477     /// }");
 478     /// ```
 479     fn suggest_prepend_item(&mut self, cx: &T, item: Span, msg: &str, new_item: &str, applicability: Applicability);
 480
 481     /// Suggest to completely remove an item.
 482     ///
 483     /// This will remove an item and all following whitespace until the next non-whitespace
 484     /// character. This should work correctly if item is on the same indentation level as the
 485     /// following item.
 486     ///
 487     /// # Example
 488     ///
 489     /// ```rust,ignore
 490     /// db.suggest_remove_item(cx, item, "remove this")
 491     /// ```
 492     fn suggest_remove_item(&mut self, cx: &T, item: Span, msg: &str, applicability: Applicability);
 493 }
 494
 495 impl<'a, 'b, 'c, T: LintContext<'c>> DiagnosticBuilderExt<'c, T> for rustc_errors::DiagnosticBuilder<'b> {
 496     fn suggest_item_with_attr<D: Display + ?Sized>(&mut self, cx: &T, item: Span, msg: &str, attr: &D, applicability: Applicability) {
 497         if let Some(indent) = indentation(cx, item) {
 498             let span = item.with_hi(item.lo());
 499
 500             self.span_suggestion_with_applicability(
 501                         span,
 502                         msg,
 503                         format!("{}\n{}", attr, indent),
 504                         applicability,
 505                         );
 506         }
 507     }
 508
 509     fn suggest_prepend_item(&mut self, cx: &T, item: Span, msg: &str, new_item: &str, applicability: Applicability) {
 510         if let Some(indent) = indentation(cx, item) {
 511             let span = item.with_hi(item.lo());
 512
 513             let mut first = true;
 514             let new_item = new_item
 515                 .lines()
 516                 .map(|l| {
 517                     if first {
 518                         first = false;
 519                         format!("{}\n", l)
 520                     } else {
 521                         format!("{}{}\n", indent, l)
 522                     }
 523                 })
 524                 .collect::<String>();
 525
 526             self.span_suggestion_with_applicability(
 527                         span,
 528                         msg,
 529                         format!("{}\n{}", new_item, indent),
 530                         applicability,
 531                         );
 532         }
 533     }
 534
 535     fn suggest_remove_item(&mut self, cx: &T, item: Span, msg: &str, applicability: Applicability) {
 536         let mut remove_span = item;
 537         let hi = cx.sess().source_map().next_point(remove_span).hi();
 538         let fmpos = cx.sess().source_map().lookup_byte_offset(hi);
 539
 540         if let Some(ref src) = fmpos.fm.src {
 541             let non_whitespace_offset = src[fmpos.pos.to_usize()..].find(|c| c != ' ' && c != '\t' && c != '\n');
 542
 543             if let Some(non_whitespace_offset) = non_whitespace_offset {
 544                 remove_span = remove_span.with_hi(remove_span.hi() + BytePos(non_whitespace_offset as u32))
 545             }
 546         }
 547
 548         self.span_suggestion_with_applicability(
 549                     remove_span,
 550                     msg,
 551                     String::new(),
 552                     applicability,
 553                     );
 554     }
 555 }