clippy_utils/src/sugg.rs

   1 //! Contains utility functions to generate suggestions.
   2 #![deny(clippy::missing_docs_in_private_items)]
   3
   4 use crate::source::{snippet, snippet_opt, snippet_with_applicability, snippet_with_macro_callsite};
   5 use crate::{get_parent_expr_for_hir, higher};
   6 use rustc_ast::util::parser::AssocOp;
   7 use rustc_ast::{ast, token};
   8 use rustc_ast_pretty::pprust::token_kind_to_string;
   9 use rustc_errors::Applicability;
  10 use rustc_hir as hir;
  11 use rustc_hir::{ExprKind, HirId, MutTy, TyKind};
  12 use rustc_infer::infer::TyCtxtInferExt;
  13 use rustc_lint::{EarlyContext, LateContext, LintContext};
  14 use rustc_middle::hir::place::ProjectionKind;
  15 use rustc_middle::mir::{FakeReadCause, Mutability};
  16 use rustc_middle::ty;
  17 use rustc_span::source_map::{BytePos, CharPos, Pos, Span, SyntaxContext};
  18 use rustc_typeck::expr_use_visitor::{Delegate, ExprUseVisitor, PlaceBase, PlaceWithHirId};
  19 use std::borrow::Cow;
  20 use std::convert::TryInto;
  21 use std::fmt::Display;
  22 use std::iter;
  23 use std::ops::{Add, Neg, Not, Sub};
  24
  25 /// A helper type to build suggestion correctly handling parentheses.
  26 #[derive(Clone, PartialEq)]
  27 pub enum Sugg<'a> {
  28     /// An expression that never needs parentheses such as `1337` or `[0; 42]`.
  29     NonParen(Cow<'a, str>),
  30     /// An expression that does not fit in other variants.
  31     MaybeParen(Cow<'a, str>),
  32     /// A binary operator expression, including `as`-casts and explicit type
  33     /// coercion.
  34     BinOp(AssocOp, Cow<'a, str>, Cow<'a, str>),
  35 }
  36
  37 /// Literal constant `0`, for convenience.
  38 pub const ZERO: Sugg<'static> = Sugg::NonParen(Cow::Borrowed("0"));
  39 /// Literal constant `1`, for convenience.
  40 pub const ONE: Sugg<'static> = Sugg::NonParen(Cow::Borrowed("1"));
  41 /// a constant represents an empty string, for convenience.
  42 pub const EMPTY: Sugg<'static> = Sugg::NonParen(Cow::Borrowed(""));
  43
  44 impl Display for Sugg<'_> {
  45     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
  46         match *self {
  47             Sugg::NonParen(ref s) | Sugg::MaybeParen(ref s) => s.fmt(f),
  48             Sugg::BinOp(op, ref lhs, ref rhs) => binop_to_string(op, lhs, rhs).fmt(f),
  49         }
  50     }
  51 }
  52
  53 #[allow(clippy::wrong_self_convention)] // ok, because of the function `as_ty` method
  54 impl<'a> Sugg<'a> {
  55     /// Prepare a suggestion from an expression.
  56     pub fn hir_opt(cx: &LateContext<'_>, expr: &hir::Expr<'_>) -> Option<Self> {
  57         let get_snippet = |span| snippet(cx, span, "");
  58         snippet_opt(cx, expr.span).map(|_| Self::hir_from_snippet(expr, get_snippet))
  59     }
  60
  61     /// Convenience function around `hir_opt` for suggestions with a default
  62     /// text.
  63     pub fn hir(cx: &LateContext<'_>, expr: &hir::Expr<'_>, default: &'a str) -> Self {
  64         Self::hir_opt(cx, expr).unwrap_or(Sugg::NonParen(Cow::Borrowed(default)))
  65     }
  66
  67     /// Same as `hir`, but it adapts the applicability level by following rules:
  68     ///
  69     /// - Applicability level `Unspecified` will never be changed.
  70     /// - If the span is inside a macro, change the applicability level to `MaybeIncorrect`.
  71     /// - If the default value is used and the applicability level is `MachineApplicable`, change it
  72     ///   to
  73     /// `HasPlaceholders`
  74     pub fn hir_with_applicability(
  75         cx: &LateContext<'_>,
  76         expr: &hir::Expr<'_>,
  77         default: &'a str,
  78         applicability: &mut Applicability,
  79     ) -> Self {
  80         if *applicability != Applicability::Unspecified && expr.span.from_expansion() {
  81             *applicability = Applicability::MaybeIncorrect;
  82         }
  83         Self::hir_opt(cx, expr).unwrap_or_else(|| {
  84             if *applicability == Applicability::MachineApplicable {
  85                 *applicability = Applicability::HasPlaceholders;
  86             }
  87             Sugg::NonParen(Cow::Borrowed(default))
  88         })
  89     }
  90
  91     /// Same as `hir`, but will use the pre expansion span if the `expr` was in a macro.
  92     pub fn hir_with_macro_callsite(cx: &LateContext<'_>, expr: &hir::Expr<'_>, default: &'a str) -> Self {
  93         let get_snippet = |span| snippet_with_macro_callsite(cx, span, default);
  94         Self::hir_from_snippet(expr, get_snippet)
  95     }
  96
  97     /// Same as `hir`, but first walks the span up to the given context. This will result in the
  98     /// macro call, rather then the expansion, if the span is from a child context. If the span is
  99     /// not from a child context, it will be used directly instead.
 100     ///
 101     /// e.g. Given the expression `&vec![]`, getting a snippet from the span for `vec![]` as a HIR
 102     /// node would result in `box []`. If given the context of the address of expression, this
 103     /// function will correctly get a snippet of `vec![]`.
 104     pub fn hir_with_context(
 105         cx: &LateContext<'_>,
 106         expr: &hir::Expr<'_>,
 107         ctxt: SyntaxContext,
 108         default: &'a str,
 109         applicability: &mut Applicability,
 110     ) -> Self {
 111         if expr.span.ctxt() == ctxt {
 112             Self::hir_from_snippet(expr, |span| snippet(cx, span, default))
 113         } else {
 114             let snip = snippet_with_applicability(cx, expr.span, default, applicability);
 115             Sugg::NonParen(snip)
 116         }
 117     }
 118
 119     /// Generate a suggestion for an expression with the given snippet. This is used by the `hir_*`
 120     /// function variants of `Sugg`, since these use different snippet functions.
 121     fn hir_from_snippet(expr: &hir::Expr<'_>, get_snippet: impl Fn(Span) -> Cow<'a, str>) -> Self {
 122         if let Some(range) = higher::Range::hir(expr) {
 123             let op = match range.limits {
 124                 ast::RangeLimits::HalfOpen => AssocOp::DotDot,
 125                 ast::RangeLimits::Closed => AssocOp::DotDotEq,
 126             };
 127             let start = range.start.map_or("".into(), |expr| get_snippet(expr.span));
 128             let end = range.end.map_or("".into(), |expr| get_snippet(expr.span));
 129
 130             return Sugg::BinOp(op, start, end);
 131         }
 132
 133         match expr.kind {
 134             hir::ExprKind::AddrOf(..)
 135             | hir::ExprKind::Box(..)
 136             | hir::ExprKind::If(..)
 137             | hir::ExprKind::Let(..)
 138             | hir::ExprKind::Closure(..)
 139             | hir::ExprKind::Unary(..)
 140             | hir::ExprKind::Match(..) => Sugg::MaybeParen(get_snippet(expr.span)),
 141             hir::ExprKind::Continue(..)
 142             | hir::ExprKind::Yield(..)
 143             | hir::ExprKind::Array(..)
 144             | hir::ExprKind::Block(..)
 145             | hir::ExprKind::Break(..)
 146             | hir::ExprKind::Call(..)
 147             | hir::ExprKind::Field(..)
 148             | hir::ExprKind::Index(..)
 149             | hir::ExprKind::InlineAsm(..)
 150             | hir::ExprKind::ConstBlock(..)
 151             | hir::ExprKind::Lit(..)
 152             | hir::ExprKind::Loop(..)
 153             | hir::ExprKind::MethodCall(..)
 154             | hir::ExprKind::Path(..)
 155             | hir::ExprKind::Repeat(..)
 156             | hir::ExprKind::Ret(..)
 157             | hir::ExprKind::Struct(..)
 158             | hir::ExprKind::Tup(..)
 159             | hir::ExprKind::DropTemps(_)
 160             | hir::ExprKind::Err => Sugg::NonParen(get_snippet(expr.span)),
 161             hir::ExprKind::Assign(lhs, rhs, _) => {
 162                 Sugg::BinOp(AssocOp::Assign, get_snippet(lhs.span), get_snippet(rhs.span))
 163             },
 164             hir::ExprKind::AssignOp(op, lhs, rhs) => {
 165                 Sugg::BinOp(hirbinop2assignop(op), get_snippet(lhs.span), get_snippet(rhs.span))
 166             },
 167             hir::ExprKind::Binary(op, lhs, rhs) => Sugg::BinOp(
 168                 AssocOp::from_ast_binop(op.node.into()),
 169                 get_snippet(lhs.span),
 170                 get_snippet(rhs.span),
 171             ),
 172             hir::ExprKind::Cast(lhs, ty) => Sugg::BinOp(AssocOp::As, get_snippet(lhs.span), get_snippet(ty.span)),
 173             hir::ExprKind::Type(lhs, ty) => Sugg::BinOp(AssocOp::Colon, get_snippet(lhs.span), get_snippet(ty.span)),
 174         }
 175     }
 176
 177     /// Prepare a suggestion from an expression.
 178     pub fn ast(cx: &EarlyContext<'_>, expr: &ast::Expr, default: &'a str) -> Self {
 179         use rustc_ast::ast::RangeLimits;
 180
 181         let get_whole_snippet = || {
 182             if expr.span.from_expansion() {
 183                 snippet_with_macro_callsite(cx, expr.span, default)
 184             } else {
 185                 snippet(cx, expr.span, default)
 186             }
 187         };
 188
 189         match expr.kind {
 190             ast::ExprKind::AddrOf(..)
 191             | ast::ExprKind::Box(..)
 192             | ast::ExprKind::Closure(..)
 193             | ast::ExprKind::If(..)
 194             | ast::ExprKind::Let(..)
 195             | ast::ExprKind::Unary(..)
 196             | ast::ExprKind::Match(..) => Sugg::MaybeParen(get_whole_snippet()),
 197             ast::ExprKind::Async(..)
 198             | ast::ExprKind::Block(..)
 199             | ast::ExprKind::Break(..)
 200             | ast::ExprKind::Call(..)
 201             | ast::ExprKind::Continue(..)
 202             | ast::ExprKind::Yield(..)
 203             | ast::ExprKind::Field(..)
 204             | ast::ExprKind::ForLoop(..)
 205             | ast::ExprKind::Index(..)
 206             | ast::ExprKind::InlineAsm(..)
 207             | ast::ExprKind::ConstBlock(..)
 208             | ast::ExprKind::Lit(..)
 209             | ast::ExprKind::Loop(..)
 210             | ast::ExprKind::MacCall(..)
 211             | ast::ExprKind::MethodCall(..)
 212             | ast::ExprKind::Paren(..)
 213             | ast::ExprKind::Underscore
 214             | ast::ExprKind::Path(..)
 215             | ast::ExprKind::Repeat(..)
 216             | ast::ExprKind::Ret(..)
 217             | ast::ExprKind::Struct(..)
 218             | ast::ExprKind::Try(..)
 219             | ast::ExprKind::TryBlock(..)
 220             | ast::ExprKind::Tup(..)
 221             | ast::ExprKind::Array(..)
 222             | ast::ExprKind::While(..)
 223             | ast::ExprKind::Await(..)
 224             | ast::ExprKind::Err => Sugg::NonParen(get_whole_snippet()),
 225             ast::ExprKind::Range(ref lhs, ref rhs, RangeLimits::HalfOpen) => Sugg::BinOp(
 226                 AssocOp::DotDot,
 227                 lhs.as_ref().map_or("".into(), |lhs| snippet(cx, lhs.span, default)),
 228                 rhs.as_ref().map_or("".into(), |rhs| snippet(cx, rhs.span, default)),
 229             ),
 230             ast::ExprKind::Range(ref lhs, ref rhs, RangeLimits::Closed) => Sugg::BinOp(
 231                 AssocOp::DotDotEq,
 232                 lhs.as_ref().map_or("".into(), |lhs| snippet(cx, lhs.span, default)),
 233                 rhs.as_ref().map_or("".into(), |rhs| snippet(cx, rhs.span, default)),
 234             ),
 235             ast::ExprKind::Assign(ref lhs, ref rhs, _) => Sugg::BinOp(
 236                 AssocOp::Assign,
 237                 snippet(cx, lhs.span, default),
 238                 snippet(cx, rhs.span, default),
 239             ),
 240             ast::ExprKind::AssignOp(op, ref lhs, ref rhs) => Sugg::BinOp(
 241                 astbinop2assignop(op),
 242                 snippet(cx, lhs.span, default),
 243                 snippet(cx, rhs.span, default),
 244             ),
 245             ast::ExprKind::Binary(op, ref lhs, ref rhs) => Sugg::BinOp(
 246                 AssocOp::from_ast_binop(op.node),
 247                 snippet(cx, lhs.span, default),
 248                 snippet(cx, rhs.span, default),
 249             ),
 250             ast::ExprKind::Cast(ref lhs, ref ty) => Sugg::BinOp(
 251                 AssocOp::As,
 252                 snippet(cx, lhs.span, default),
 253                 snippet(cx, ty.span, default),
 254             ),
 255             ast::ExprKind::Type(ref lhs, ref ty) => Sugg::BinOp(
 256                 AssocOp::Colon,
 257                 snippet(cx, lhs.span, default),
 258                 snippet(cx, ty.span, default),
 259             ),
 260         }
 261     }
 262
 263     /// Convenience method to create the `<lhs> && <rhs>` suggestion.
 264     pub fn and(self, rhs: &Self) -> Sugg<'static> {
 265         make_binop(ast::BinOpKind::And, &self, rhs)
 266     }
 267
 268     /// Convenience method to create the `<lhs> & <rhs>` suggestion.
 269     pub fn bit_and(self, rhs: &Self) -> Sugg<'static> {
 270         make_binop(ast::BinOpKind::BitAnd, &self, rhs)
 271     }
 272
 273     /// Convenience method to create the `<lhs> as <rhs>` suggestion.
 274     pub fn as_ty<R: Display>(self, rhs: R) -> Sugg<'static> {
 275         make_assoc(AssocOp::As, &self, &Sugg::NonParen(rhs.to_string().into()))
 276     }
 277
 278     /// Convenience method to create the `&<expr>` suggestion.
 279     pub fn addr(self) -> Sugg<'static> {
 280         make_unop("&", self)
 281     }
 282
 283     /// Convenience method to create the `&mut <expr>` suggestion.
 284     pub fn mut_addr(self) -> Sugg<'static> {
 285         make_unop("&mut ", self)
 286     }
 287
 288     /// Convenience method to create the `*<expr>` suggestion.
 289     pub fn deref(self) -> Sugg<'static> {
 290         make_unop("*", self)
 291     }
 292
 293     /// Convenience method to create the `&*<expr>` suggestion. Currently this
 294     /// is needed because `sugg.deref().addr()` produces an unnecessary set of
 295     /// parentheses around the deref.
 296     pub fn addr_deref(self) -> Sugg<'static> {
 297         make_unop("&*", self)
 298     }
 299
 300     /// Convenience method to create the `&mut *<expr>` suggestion. Currently
 301     /// this is needed because `sugg.deref().mut_addr()` produces an unnecessary
 302     /// set of parentheses around the deref.
 303     pub fn mut_addr_deref(self) -> Sugg<'static> {
 304         make_unop("&mut *", self)
 305     }
 306
 307     /// Convenience method to transform suggestion into a return call
 308     pub fn make_return(self) -> Sugg<'static> {
 309         Sugg::NonParen(Cow::Owned(format!("return {}", self)))
 310     }
 311
 312     /// Convenience method to transform suggestion into a block
 313     /// where the suggestion is a trailing expression
 314     pub fn blockify(self) -> Sugg<'static> {
 315         Sugg::NonParen(Cow::Owned(format!("{{ {} }}", self)))
 316     }
 317
 318     /// Convenience method to create the `<lhs>..<rhs>` or `<lhs>...<rhs>`
 319     /// suggestion.
 320     #[allow(dead_code)]
 321     pub fn range(self, end: &Self, limit: ast::RangeLimits) -> Sugg<'static> {
 322         match limit {
 323             ast::RangeLimits::HalfOpen => make_assoc(AssocOp::DotDot, &self, end),
 324             ast::RangeLimits::Closed => make_assoc(AssocOp::DotDotEq, &self, end),
 325         }
 326     }
 327
 328     /// Adds parentheses to any expression that might need them. Suitable to the
 329     /// `self` argument of a method call
 330     /// (e.g., to build `bar.foo()` or `(1 + 2).foo()`).
 331     #[must_use]
 332     pub fn maybe_par(self) -> Self {
 333         match self {
 334             Sugg::NonParen(..) => self,
 335             // `(x)` and `(x).y()` both don't need additional parens.
 336             Sugg::MaybeParen(sugg) => {
 337                 if has_enclosing_paren(&sugg) {
 338                     Sugg::MaybeParen(sugg)
 339                 } else {
 340                     Sugg::NonParen(format!("({})", sugg).into())
 341                 }
 342             },
 343             Sugg::BinOp(op, lhs, rhs) => {
 344                 let sugg = binop_to_string(op, &lhs, &rhs);
 345                 Sugg::NonParen(format!("({})", sugg).into())
 346             },
 347         }
 348     }
 349 }
 350
 351 /// Generates a string from the operator and both sides.
 352 fn binop_to_string(op: AssocOp, lhs: &str, rhs: &str) -> String {
 353     match op {
 354         AssocOp::Add
 355         | AssocOp::Subtract
 356         | AssocOp::Multiply
 357         | AssocOp::Divide
 358         | AssocOp::Modulus
 359         | AssocOp::LAnd
 360         | AssocOp::LOr
 361         | AssocOp::BitXor
 362         | AssocOp::BitAnd
 363         | AssocOp::BitOr
 364         | AssocOp::ShiftLeft
 365         | AssocOp::ShiftRight
 366         | AssocOp::Equal
 367         | AssocOp::Less
 368         | AssocOp::LessEqual
 369         | AssocOp::NotEqual
 370         | AssocOp::Greater
 371         | AssocOp::GreaterEqual => format!(
 372             "{} {} {}",
 373             lhs,
 374             op.to_ast_binop().expect("Those are AST ops").to_string(),
 375             rhs
 376         ),
 377         AssocOp::Assign => format!("{} = {}", lhs, rhs),
 378         AssocOp::AssignOp(op) => {
 379             format!("{} {}= {}", lhs, token_kind_to_string(&token::BinOp(op)), rhs)
 380         },
 381         AssocOp::As => format!("{} as {}", lhs, rhs),
 382         AssocOp::DotDot => format!("{}..{}", lhs, rhs),
 383         AssocOp::DotDotEq => format!("{}..={}", lhs, rhs),
 384         AssocOp::Colon => format!("{}: {}", lhs, rhs),
 385     }
 386 }
 387
 388 /// Return `true` if `sugg` is enclosed in parenthesis.
 389 pub fn has_enclosing_paren(sugg: impl AsRef<str>) -> bool {
 390     let mut chars = sugg.as_ref().chars();
 391     if chars.next() == Some('(') {
 392         let mut depth = 1;
 393         for c in &mut chars {
 394             if c == '(' {
 395                 depth += 1;
 396             } else if c == ')' {
 397                 depth -= 1;
 398             }
 399             if depth == 0 {
 400                 break;
 401             }
 402         }
 403         chars.next().is_none()
 404     } else {
 405         false
 406     }
 407 }
 408
 409 /// Copied from the rust standard library, and then edited
 410 macro_rules! forward_binop_impls_to_ref {
 411     (impl $imp:ident, $method:ident for $t:ty, type Output = $o:ty) => {
 412         impl $imp<$t> for &$t {
 413             type Output = $o;
 414
 415             fn $method(self, other: $t) -> $o {
 416                 $imp::$method(self, &other)
 417             }
 418         }
 419
 420         impl $imp<&$t> for $t {
 421             type Output = $o;
 422
 423             fn $method(self, other: &$t) -> $o {
 424                 $imp::$method(&self, other)
 425             }
 426         }
 427
 428         impl $imp for $t {
 429             type Output = $o;
 430
 431             fn $method(self, other: $t) -> $o {
 432                 $imp::$method(&self, &other)
 433             }
 434         }
 435     };
 436 }
 437
 438 impl Add for &Sugg<'_> {
 439     type Output = Sugg<'static>;
 440     fn add(self, rhs: &Sugg<'_>) -> Sugg<'static> {
 441         make_binop(ast::BinOpKind::Add, self, rhs)
 442     }
 443 }
 444
 445 impl Sub for &Sugg<'_> {
 446     type Output = Sugg<'static>;
 447     fn sub(self, rhs: &Sugg<'_>) -> Sugg<'static> {
 448         make_binop(ast::BinOpKind::Sub, self, rhs)
 449     }
 450 }
 451
 452 forward_binop_impls_to_ref!(impl Add, add for Sugg<'_>, type Output = Sugg<'static>);
 453 forward_binop_impls_to_ref!(impl Sub, sub for Sugg<'_>, type Output = Sugg<'static>);
 454
 455 impl Neg for Sugg<'_> {
 456     type Output = Sugg<'static>;
 457     fn neg(self) -> Sugg<'static> {
 458         make_unop("-", self)
 459     }
 460 }
 461
 462 impl<'a> Not for Sugg<'a> {
 463     type Output = Sugg<'a>;
 464     fn not(self) -> Sugg<'a> {
 465         use AssocOp::{Equal, Greater, GreaterEqual, Less, LessEqual, NotEqual};
 466
 467         if let Sugg::BinOp(op, lhs, rhs) = self {
 468             let to_op = match op {
 469                 Equal => NotEqual,
 470                 NotEqual => Equal,
 471                 Less => GreaterEqual,
 472                 GreaterEqual => Less,
 473                 Greater => LessEqual,
 474                 LessEqual => Greater,
 475                 _ => return make_unop("!", Sugg::BinOp(op, lhs, rhs)),
 476             };
 477             Sugg::BinOp(to_op, lhs, rhs)
 478         } else {
 479             make_unop("!", self)
 480         }
 481     }
 482 }
 483
 484 /// Helper type to display either `foo` or `(foo)`.
 485 struct ParenHelper<T> {
 486     /// `true` if parentheses are needed.
 487     paren: bool,
 488     /// The main thing to display.
 489     wrapped: T,
 490 }
 491
 492 impl<T> ParenHelper<T> {
 493     /// Builds a `ParenHelper`.
 494     fn new(paren: bool, wrapped: T) -> Self {
 495         Self { paren, wrapped }
 496     }
 497 }
 498
 499 impl<T: Display> Display for ParenHelper<T> {
 500     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
 501         if self.paren {
 502             write!(f, "({})", self.wrapped)
 503         } else {
 504             self.wrapped.fmt(f)
 505         }
 506     }
 507 }
 508
 509 /// Builds the string for `<op><expr>` adding parenthesis when necessary.
 510 ///
 511 /// For convenience, the operator is taken as a string because all unary
 512 /// operators have the same
 513 /// precedence.
 514 pub fn make_unop(op: &str, expr: Sugg<'_>) -> Sugg<'static> {
 515     Sugg::MaybeParen(format!("{}{}", op, expr.maybe_par()).into())
 516 }
 517
 518 /// Builds the string for `<lhs> <op> <rhs>` adding parenthesis when necessary.
 519 ///
 520 /// Precedence of shift operator relative to other arithmetic operation is
 521 /// often confusing so
 522 /// parenthesis will always be added for a mix of these.
 523 pub fn make_assoc(op: AssocOp, lhs: &Sugg<'_>, rhs: &Sugg<'_>) -> Sugg<'static> {
 524     /// Returns `true` if the operator is a shift operator `<<` or `>>`.
 525     fn is_shift(op: AssocOp) -> bool {
 526         matches!(op, AssocOp::ShiftLeft | AssocOp::ShiftRight)
 527     }
 528
 529     /// Returns `true` if the operator is an arithmetic operator
 530     /// (i.e., `+`, `-`, `*`, `/`, `%`).
 531     fn is_arith(op: AssocOp) -> bool {
 532         matches!(
 533             op,
 534             AssocOp::Add | AssocOp::Subtract | AssocOp::Multiply | AssocOp::Divide | AssocOp::Modulus
 535         )
 536     }
 537
 538     /// Returns `true` if the operator `op` needs parenthesis with the operator
 539     /// `other` in the direction `dir`.
 540     fn needs_paren(op: AssocOp, other: AssocOp, dir: Associativity) -> bool {
 541         other.precedence() < op.precedence()
 542             || (other.precedence() == op.precedence()
 543                 && ((op != other && associativity(op) != dir)
 544                     || (op == other && associativity(op) != Associativity::Both)))
 545             || is_shift(op) && is_arith(other)
 546             || is_shift(other) && is_arith(op)
 547     }
 548
 549     let lhs_paren = if let Sugg::BinOp(lop, _, _) = *lhs {
 550         needs_paren(op, lop, Associativity::Left)
 551     } else {
 552         false
 553     };
 554
 555     let rhs_paren = if let Sugg::BinOp(rop, _, _) = *rhs {
 556         needs_paren(op, rop, Associativity::Right)
 557     } else {
 558         false
 559     };
 560
 561     let lhs = ParenHelper::new(lhs_paren, lhs).to_string();
 562     let rhs = ParenHelper::new(rhs_paren, rhs).to_string();
 563     Sugg::BinOp(op, lhs.into(), rhs.into())
 564 }
 565
 566 /// Convenience wrapper around `make_assoc` and `AssocOp::from_ast_binop`.
 567 pub fn make_binop(op: ast::BinOpKind, lhs: &Sugg<'_>, rhs: &Sugg<'_>) -> Sugg<'static> {
 568     make_assoc(AssocOp::from_ast_binop(op), lhs, rhs)
 569 }
 570
 571 #[derive(PartialEq, Eq, Clone, Copy)]
 572 /// Operator associativity.
 573 enum Associativity {
 574     /// The operator is both left-associative and right-associative.
 575     Both,
 576     /// The operator is left-associative.
 577     Left,
 578     /// The operator is not associative.
 579     None,
 580     /// The operator is right-associative.
 581     Right,
 582 }
 583
 584 /// Returns the associativity/fixity of an operator. The difference with
 585 /// `AssocOp::fixity` is that an operator can be both left and right associative
 586 /// (such as `+`: `a + b + c == (a + b) + c == a + (b + c)`.
 587 ///
 588 /// Chained `as` and explicit `:` type coercion never need inner parenthesis so
 589 /// they are considered
 590 /// associative.
 591 #[must_use]
 592 fn associativity(op: AssocOp) -> Associativity {
 593     use rustc_ast::util::parser::AssocOp::{
 594         Add, As, Assign, AssignOp, BitAnd, BitOr, BitXor, Colon, Divide, DotDot, DotDotEq, Equal, Greater,
 595         GreaterEqual, LAnd, LOr, Less, LessEqual, Modulus, Multiply, NotEqual, ShiftLeft, ShiftRight, Subtract,
 596     };
 597
 598     match op {
 599         Assign | AssignOp(_) => Associativity::Right,
 600         Add | BitAnd | BitOr | BitXor | LAnd | LOr | Multiply | As | Colon => Associativity::Both,
 601         Divide | Equal | Greater | GreaterEqual | Less | LessEqual | Modulus | NotEqual | ShiftLeft | ShiftRight
 602         | Subtract => Associativity::Left,
 603         DotDot | DotDotEq => Associativity::None,
 604     }
 605 }
 606
 607 /// Converts a `hir::BinOp` to the corresponding assigning binary operator.
 608 fn hirbinop2assignop(op: hir::BinOp) -> AssocOp {
 609     use rustc_ast::token::BinOpToken::{And, Caret, Minus, Or, Percent, Plus, Shl, Shr, Slash, Star};
 610
 611     AssocOp::AssignOp(match op.node {
 612         hir::BinOpKind::Add => Plus,
 613         hir::BinOpKind::BitAnd => And,
 614         hir::BinOpKind::BitOr => Or,
 615         hir::BinOpKind::BitXor => Caret,
 616         hir::BinOpKind::Div => Slash,
 617         hir::BinOpKind::Mul => Star,
 618         hir::BinOpKind::Rem => Percent,
 619         hir::BinOpKind::Shl => Shl,
 620         hir::BinOpKind::Shr => Shr,
 621         hir::BinOpKind::Sub => Minus,
 622
 623         hir::BinOpKind::And
 624         | hir::BinOpKind::Eq
 625         | hir::BinOpKind::Ge
 626         | hir::BinOpKind::Gt
 627         | hir::BinOpKind::Le
 628         | hir::BinOpKind::Lt
 629         | hir::BinOpKind::Ne
 630         | hir::BinOpKind::Or => panic!("This operator does not exist"),
 631     })
 632 }
 633
 634 /// Converts an `ast::BinOp` to the corresponding assigning binary operator.
 635 fn astbinop2assignop(op: ast::BinOp) -> AssocOp {
 636     use rustc_ast::ast::BinOpKind::{
 637         Add, And, BitAnd, BitOr, BitXor, Div, Eq, Ge, Gt, Le, Lt, Mul, Ne, Or, Rem, Shl, Shr, Sub,
 638     };
 639     use rustc_ast::token::BinOpToken;
 640
 641     AssocOp::AssignOp(match op.node {
 642         Add => BinOpToken::Plus,
 643         BitAnd => BinOpToken::And,
 644         BitOr => BinOpToken::Or,
 645         BitXor => BinOpToken::Caret,
 646         Div => BinOpToken::Slash,
 647         Mul => BinOpToken::Star,
 648         Rem => BinOpToken::Percent,
 649         Shl => BinOpToken::Shl,
 650         Shr => BinOpToken::Shr,
 651         Sub => BinOpToken::Minus,
 652         And | Eq | Ge | Gt | Le | Lt | Ne | Or => panic!("This operator does not exist"),
 653     })
 654 }
 655
 656 /// Returns the indentation before `span` if there are nothing but `[ \t]`
 657 /// before it on its line.
 658 fn indentation<T: LintContext>(cx: &T, span: Span) -> Option<String> {
 659     let lo = cx.sess().source_map().lookup_char_pos(span.lo());
 660     lo.file
 661         .get_line(lo.line - 1 /* line numbers in `Loc` are 1-based */)
 662         .and_then(|line| {
 663             if let Some((pos, _)) = line.char_indices().find(|&(_, c)| c != ' ' && c != '\t') {
 664                 // We can mix char and byte positions here because we only consider `[ \t]`.
 665                 if lo.col == CharPos(pos) {
 666                     Some(line[..pos].into())
 667                 } else {
 668                     None
 669                 }
 670             } else {
 671                 None
 672             }
 673         })
 674 }
 675
 676 /// Convenience extension trait for `Diagnostic`.
 677 pub trait DiagnosticExt<T: LintContext> {
 678     /// Suggests to add an attribute to an item.
 679     ///
 680     /// Correctly handles indentation of the attribute and item.
 681     ///
 682     /// # Example
 683     ///
 684     /// ```rust,ignore
 685     /// diag.suggest_item_with_attr(cx, item, "#[derive(Default)]");
 686     /// ```
 687     fn suggest_item_with_attr<D: Display + ?Sized>(
 688         &mut self,
 689         cx: &T,
 690         item: Span,
 691         msg: &str,
 692         attr: &D,
 693         applicability: Applicability,
 694     );
 695
 696     /// Suggest to add an item before another.
 697     ///
 698     /// The item should not be indented (except for inner indentation).
 699     ///
 700     /// # Example
 701     ///
 702     /// ```rust,ignore
 703     /// diag.suggest_prepend_item(cx, item,
 704     /// "fn foo() {
 705     ///     bar();
 706     /// }");
 707     /// ```
 708     fn suggest_prepend_item(&mut self, cx: &T, item: Span, msg: &str, new_item: &str, applicability: Applicability);
 709
 710     /// Suggest to completely remove an item.
 711     ///
 712     /// This will remove an item and all following whitespace until the next non-whitespace
 713     /// character. This should work correctly if item is on the same indentation level as the
 714     /// following item.
 715     ///
 716     /// # Example
 717     ///
 718     /// ```rust,ignore
 719     /// diag.suggest_remove_item(cx, item, "remove this")
 720     /// ```
 721     fn suggest_remove_item(&mut self, cx: &T, item: Span, msg: &str, applicability: Applicability);
 722 }
 723
 724 impl<T: LintContext> DiagnosticExt<T> for rustc_errors::Diagnostic {
 725     fn suggest_item_with_attr<D: Display + ?Sized>(
 726         &mut self,
 727         cx: &T,
 728         item: Span,
 729         msg: &str,
 730         attr: &D,
 731         applicability: Applicability,
 732     ) {
 733         if let Some(indent) = indentation(cx, item) {
 734             let span = item.with_hi(item.lo());
 735
 736             self.span_suggestion(span, msg, format!("{}\n{}", attr, indent), applicability);
 737         }
 738     }
 739
 740     fn suggest_prepend_item(&mut self, cx: &T, item: Span, msg: &str, new_item: &str, applicability: Applicability) {
 741         if let Some(indent) = indentation(cx, item) {
 742             let span = item.with_hi(item.lo());
 743
 744             let mut first = true;
 745             let new_item = new_item
 746                 .lines()
 747                 .map(|l| {
 748                     if first {
 749                         first = false;
 750                         format!("{}\n", l)
 751                     } else {
 752                         format!("{}{}\n", indent, l)
 753                     }
 754                 })
 755                 .collect::<String>();
 756
 757             self.span_suggestion(span, msg, format!("{}\n{}", new_item, indent), applicability);
 758         }
 759     }
 760
 761     fn suggest_remove_item(&mut self, cx: &T, item: Span, msg: &str, applicability: Applicability) {
 762         let mut remove_span = item;
 763         let hi = cx.sess().source_map().next_point(remove_span).hi();
 764         let fmpos = cx.sess().source_map().lookup_byte_offset(hi);
 765
 766         if let Some(ref src) = fmpos.sf.src {
 767             let non_whitespace_offset = src[fmpos.pos.to_usize()..].find(|c| c != ' ' && c != '\t' && c != '\n');
 768
 769             if let Some(non_whitespace_offset) = non_whitespace_offset {
 770                 remove_span = remove_span
 771                     .with_hi(remove_span.hi() + BytePos(non_whitespace_offset.try_into().expect("offset too large")));
 772             }
 773         }
 774
 775         self.span_suggestion(remove_span, msg, String::new(), applicability);
 776     }
 777 }
 778
 779 /// Suggestion results for handling closure
 780 /// args dereferencing and borrowing
 781 pub struct DerefClosure {
 782     /// confidence on the built suggestion
 783     pub applicability: Applicability,
 784     /// gradually built suggestion
 785     pub suggestion: String,
 786 }
 787
 788 /// Build suggestion gradually by handling closure arg specific usages,
 789 /// such as explicit deref and borrowing cases.
 790 /// Returns `None` if no such use cases have been triggered in closure body
 791 ///
 792 /// note: this only works on single line immutable closures with exactly one input parameter.
 793 pub fn deref_closure_args<'tcx>(cx: &LateContext<'_>, closure: &'tcx hir::Expr<'_>) -> Option<DerefClosure> {
 794     if let hir::ExprKind::Closure(_, fn_decl, body_id, ..) = closure.kind {
 795         let closure_body = cx.tcx.hir().body(body_id);
 796         // is closure arg a type annotated double reference (i.e.: `|x: &&i32| ...`)
 797         // a type annotation is present if param `kind` is different from `TyKind::Infer`
 798         let closure_arg_is_type_annotated_double_ref = if let TyKind::Rptr(_, MutTy { ty, .. }) = fn_decl.inputs[0].kind
 799         {
 800             matches!(ty.kind, TyKind::Rptr(_, MutTy { .. }))
 801         } else {
 802             false
 803         };
 804
 805         let mut visitor = DerefDelegate {
 806             cx,
 807             closure_span: closure.span,
 808             closure_arg_is_type_annotated_double_ref,
 809             next_pos: closure.span.lo(),
 810             suggestion_start: String::new(),
 811             applicability: Applicability::MachineApplicable,
 812         };
 813
 814         let fn_def_id = cx.tcx.hir().local_def_id(closure.hir_id);
 815         cx.tcx.infer_ctxt().enter(|infcx| {
 816             ExprUseVisitor::new(&mut visitor, &infcx, fn_def_id, cx.param_env, cx.typeck_results())
 817                 .consume_body(closure_body);
 818         });
 819
 820         if !visitor.suggestion_start.is_empty() {
 821             return Some(DerefClosure {
 822                 applicability: visitor.applicability,
 823                 suggestion: visitor.finish(),
 824             });
 825         }
 826     }
 827     None
 828 }
 829
 830 /// Visitor struct used for tracking down
 831 /// dereferencing and borrowing of closure's args
 832 struct DerefDelegate<'a, 'tcx> {
 833     /// The late context of the lint
 834     cx: &'a LateContext<'tcx>,
 835     /// The span of the input closure to adapt
 836     closure_span: Span,
 837     /// Indicates if the arg of the closure is a type annotated double reference
 838     closure_arg_is_type_annotated_double_ref: bool,
 839     /// last position of the span to gradually build the suggestion
 840     next_pos: BytePos,
 841     /// starting part of the gradually built suggestion
 842     suggestion_start: String,
 843     /// confidence on the built suggestion
 844     applicability: Applicability,
 845 }
 846
 847 impl<'tcx> DerefDelegate<'_, 'tcx> {
 848     /// build final suggestion:
 849     /// - create the ending part of suggestion
 850     /// - concatenate starting and ending parts
 851     /// - potentially remove needless borrowing
 852     pub fn finish(&mut self) -> String {
 853         let end_span = Span::new(self.next_pos, self.closure_span.hi(), self.closure_span.ctxt(), None);
 854         let end_snip = snippet_with_applicability(self.cx, end_span, "..", &mut self.applicability);
 855         let sugg = format!("{}{}", self.suggestion_start, end_snip);
 856         if self.closure_arg_is_type_annotated_double_ref {
 857             sugg.replacen('&', "", 1)
 858         } else {
 859             sugg
 860         }
 861     }
 862
 863     /// indicates whether the function from `parent_expr` takes its args by double reference
 864     fn func_takes_arg_by_double_ref(&self, parent_expr: &'tcx hir::Expr<'_>, cmt_hir_id: HirId) -> bool {
 865         let (call_args, inputs) = match parent_expr.kind {
 866             ExprKind::MethodCall(_, call_args, _) => {
 867                 if let Some(method_did) = self.cx.typeck_results().type_dependent_def_id(parent_expr.hir_id) {
 868                     (call_args, self.cx.tcx.fn_sig(method_did).skip_binder().inputs())
 869                 } else {
 870                     return false;
 871                 }
 872             },
 873             ExprKind::Call(func, call_args) => {
 874                 let typ = self.cx.typeck_results().expr_ty(func);
 875                 (call_args, typ.fn_sig(self.cx.tcx).skip_binder().inputs())
 876             },
 877             _ => return false,
 878         };
 879
 880         iter::zip(call_args, inputs)
 881             .any(|(arg, ty)| arg.hir_id == cmt_hir_id && matches!(ty.kind(), ty::Ref(_, inner, _) if inner.is_ref()))
 882     }
 883 }
 884
 885 impl<'tcx> Delegate<'tcx> for DerefDelegate<'_, 'tcx> {
 886     fn consume(&mut self, _: &PlaceWithHirId<'tcx>, _: HirId) {}
 887
 888     #[allow(clippy::too_many_lines)]
 889     fn borrow(&mut self, cmt: &PlaceWithHirId<'tcx>, _: HirId, _: ty::BorrowKind) {
 890         if let PlaceBase::Local(id) = cmt.place.base {
 891             let map = self.cx.tcx.hir();
 892             let span = map.span(cmt.hir_id);
 893             let start_span = Span::new(self.next_pos, span.lo(), span.ctxt(), None);
 894             let mut start_snip = snippet_with_applicability(self.cx, start_span, "..", &mut self.applicability);
 895
 896             // identifier referring to the variable currently triggered (i.e.: `fp`)
 897             let ident_str = map.name(id).to_string();
 898             // full identifier that includes projection (i.e.: `fp.field`)
 899             let ident_str_with_proj = snippet(self.cx, span, "..").to_string();
 900
 901             if cmt.place.projections.is_empty() {
 902                 // handle item without any projection, that needs an explicit borrowing
 903                 // i.e.: suggest `&x` instead of `x`
 904                 self.suggestion_start.push_str(&format!("{}&{}", start_snip, ident_str));
 905             } else {
 906                 // cases where a parent `Call` or `MethodCall` is using the item
 907                 // i.e.: suggest `.contains(&x)` for `.find(|x| [1, 2, 3].contains(x)).is_none()`
 908                 //
 909                 // Note about method calls:
 910                 // - compiler automatically dereference references if the target type is a reference (works also for
 911                 //   function call)
 912                 // - `self` arguments in the case of `x.is_something()` are also automatically (de)referenced, and
 913                 //   no projection should be suggested
 914                 if let Some(parent_expr) = get_parent_expr_for_hir(self.cx, cmt.hir_id) {
 915                     match &parent_expr.kind {
 916                         // given expression is the self argument and will be handled completely by the compiler
 917                         // i.e.: `|x| x.is_something()`
 918                         ExprKind::MethodCall(_, [self_expr, ..], _) if self_expr.hir_id == cmt.hir_id => {
 919                             self.suggestion_start
 920                                 .push_str(&format!("{}{}", start_snip, ident_str_with_proj));
 921                             self.next_pos = span.hi();
 922                             return;
 923                         },
 924                         // item is used in a call
 925                         // i.e.: `Call`: `|x| please(x)` or `MethodCall`: `|x| [1, 2, 3].contains(x)`
 926                         ExprKind::Call(_, [call_args @ ..]) | ExprKind::MethodCall(_, [_, call_args @ ..], _) => {
 927                             let expr = self.cx.tcx.hir().expect_expr(cmt.hir_id);
 928                             let arg_ty_kind = self.cx.typeck_results().expr_ty(expr).kind();
 929
 930                             if matches!(arg_ty_kind, ty::Ref(_, _, Mutability::Not)) {
 931                                 // suggest ampersand if call function is taking args by double reference
 932                                 let takes_arg_by_double_ref =
 933                                     self.func_takes_arg_by_double_ref(parent_expr, cmt.hir_id);
 934
 935                                 // compiler will automatically dereference field or index projection, so no need
 936                                 // to suggest ampersand, but full identifier that includes projection is required
 937                                 let has_field_or_index_projection =
 938                                     cmt.place.projections.iter().any(|proj| {
 939                                         matches!(proj.kind, ProjectionKind::Field(..) | ProjectionKind::Index)
 940                                     });
 941
 942                                 // no need to bind again if the function doesn't take arg by double ref
 943                                 // and if the item is already a double ref
 944                                 let ident_sugg = if !call_args.is_empty()
 945                                     && !takes_arg_by_double_ref
 946                                     && (self.closure_arg_is_type_annotated_double_ref || has_field_or_index_projection)
 947                                 {
 948                                     let ident = if has_field_or_index_projection {
 949                                         ident_str_with_proj
 950                                     } else {
 951                                         ident_str
 952                                     };
 953                                     format!("{}{}", start_snip, ident)
 954                                 } else {
 955                                     format!("{}&{}", start_snip, ident_str)
 956                                 };
 957                                 self.suggestion_start.push_str(&ident_sugg);
 958                                 self.next_pos = span.hi();
 959                                 return;
 960                             }
 961
 962                             self.applicability = Applicability::Unspecified;
 963                         },
 964                         _ => (),
 965                     }
 966                 }
 967
 968                 let mut replacement_str = ident_str;
 969                 let mut projections_handled = false;
 970                 cmt.place.projections.iter().enumerate().for_each(|(i, proj)| {
 971                     match proj.kind {
 972                         // Field projection like `|v| v.foo`
 973                         // no adjustment needed here, as field projections are handled by the compiler
 974                         ProjectionKind::Field(..) => match cmt.place.ty_before_projection(i).kind() {
 975                             ty::Adt(..) | ty::Tuple(_) => {
 976                                 replacement_str = ident_str_with_proj.clone();
 977                                 projections_handled = true;
 978                             },
 979                             _ => (),
 980                         },
 981                         // Index projection like `|x| foo[x]`
 982                         // the index is dropped so we can't get it to build the suggestion,
 983                         // so the span is set-up again to get more code, using `span.hi()` (i.e.: `foo[x]`)
 984                         // instead of `span.lo()` (i.e.: `foo`)
 985                         ProjectionKind::Index => {
 986                             let start_span = Span::new(self.next_pos, span.hi(), span.ctxt(), None);
 987                             start_snip = snippet_with_applicability(self.cx, start_span, "..", &mut self.applicability);
 988                             replacement_str.clear();
 989                             projections_handled = true;
 990                         },
 991                         // note: unable to trigger `Subslice` kind in tests
 992                         ProjectionKind::Subslice => (),
 993                         ProjectionKind::Deref => {
 994                             // Explicit derefs are typically handled later on, but
 995                             // some items do not need explicit deref, such as array accesses,
 996                             // so we mark them as already processed
 997                             // i.e.: don't suggest `*sub[1..4].len()` for `|sub| sub[1..4].len() == 3`
 998                             if let ty::Ref(_, inner, _) = cmt.place.ty_before_projection(i).kind() {
 999                                 if matches!(inner.kind(), ty::Ref(_, innermost, _) if innermost.is_array()) {
1000                                     projections_handled = true;
1001                                 }
1002                             }
1003                         },
1004                     }
1005                 });
1006
1007                 // handle `ProjectionKind::Deref` by removing one explicit deref
1008                 // if no special case was detected (i.e.: suggest `*x` instead of `**x`)
1009                 if !projections_handled {
1010                     let last_deref = cmt
1011                         .place
1012                         .projections
1013                         .iter()
1014                         .rposition(|proj| proj.kind == ProjectionKind::Deref);
1015
1016                     if let Some(pos) = last_deref {
1017                         let mut projections = cmt.place.projections.clone();
1018                         projections.truncate(pos);
1019
1020                         for item in projections {
1021                             if item.kind == ProjectionKind::Deref {
1022                                 replacement_str = format!("*{}", replacement_str);
1023                             }
1024                         }
1025                     }
1026                 }
1027
1028                 self.suggestion_start
1029                     .push_str(&format!("{}{}", start_snip, replacement_str));
1030             }
1031             self.next_pos = span.hi();
1032         }
1033     }
1034
1035     fn mutate(&mut self, _: &PlaceWithHirId<'tcx>, _: HirId) {}
1036
1037     fn fake_read(&mut self, _: rustc_typeck::expr_use_visitor::Place<'tcx>, _: FakeReadCause, _: HirId) {}
1038 }
1039
1040 #[cfg(test)]
1041 mod test {
1042     use super::Sugg;
1043
1044     use rustc_ast::util::parser::AssocOp;
1045     use std::borrow::Cow;
1046
1047     const SUGGESTION: Sugg<'static> = Sugg::NonParen(Cow::Borrowed("function_call()"));
1048
1049     #[test]
1050     fn make_return_transform_sugg_into_a_return_call() {
1051         assert_eq!("return function_call()", SUGGESTION.make_return().to_string());
1052     }
1053
1054     #[test]
1055     fn blockify_transforms_sugg_into_a_block() {
1056         assert_eq!("{ function_call() }", SUGGESTION.blockify().to_string());
1057     }
1058
1059     #[test]
1060     fn binop_maybe_par() {
1061         let sugg = Sugg::BinOp(AssocOp::Add, "1".into(), "1".into());
1062         assert_eq!("(1 + 1)", sugg.maybe_par().to_string());
1063
1064         let sugg = Sugg::BinOp(AssocOp::Add, "(1 + 1)".into(), "(1 + 1)".into());
1065         assert_eq!("((1 + 1) + (1 + 1))", sugg.maybe_par().to_string());
1066     }
1067     #[test]
1068     fn not_op() {
1069         use AssocOp::{Add, Equal, Greater, GreaterEqual, LAnd, LOr, Less, LessEqual, NotEqual};
1070
1071         fn test_not(op: AssocOp, correct: &str) {
1072             let sugg = Sugg::BinOp(op, "x".into(), "y".into());
1073             assert_eq!((!sugg).to_string(), correct);
1074         }
1075
1076         // Invert the comparison operator.
1077         test_not(Equal, "x != y");
1078         test_not(NotEqual, "x == y");
1079         test_not(Less, "x >= y");
1080         test_not(LessEqual, "x > y");
1081         test_not(Greater, "x <= y");
1082         test_not(GreaterEqual, "x < y");
1083
1084         // Other operators are inverted like !(..).
1085         test_not(Add, "!(x + y)");
1086         test_not(LAnd, "!(x && y)");
1087         test_not(LOr, "!(x || y)");
1088     }
1089 }