clippy_utils/src/hir_utils.rs

   1 use crate::consts::{constant_context, constant_simple};
   2 use crate::differing_macro_contexts;
   3 use crate::source::snippet_opt;
   4 use rustc_ast::ast::InlineAsmTemplatePiece;
   5 use rustc_data_structures::fx::FxHasher;
   6 use rustc_hir::def::Res;
   7 use rustc_hir::HirIdMap;
   8 use rustc_hir::{
   9     BinOpKind, Block, BodyId, Expr, ExprField, ExprKind, FnRetTy, GenericArg, GenericArgs, Guard, HirId,
  10     InlineAsmOperand, Lifetime, LifetimeName, ParamName, Pat, PatField, PatKind, Path, PathSegment, QPath, Stmt,
  11     StmtKind, Ty, TyKind, TypeBinding,
  12 };
  13 use rustc_lexer::{tokenize, TokenKind};
  14 use rustc_lint::LateContext;
  15 use rustc_middle::ty::TypeckResults;
  16 use rustc_span::Symbol;
  17 use std::hash::{Hash, Hasher};
  18
  19 /// Type used to check whether two ast are the same. This is different from the
  20 /// operator
  21 /// `==` on ast types as this operator would compare true equality with ID and
  22 /// span.
  23 ///
  24 /// Note that some expressions kinds are not considered but could be added.
  25 pub struct SpanlessEq<'a, 'tcx> {
  26     /// Context used to evaluate constant expressions.
  27     cx: &'a LateContext<'tcx>,
  28     maybe_typeck_results: Option<&'tcx TypeckResults<'tcx>>,
  29     allow_side_effects: bool,
  30     expr_fallback: Option<Box<dyn FnMut(&Expr<'_>, &Expr<'_>) -> bool + 'a>>,
  31 }
  32
  33 impl<'a, 'tcx> SpanlessEq<'a, 'tcx> {
  34     pub fn new(cx: &'a LateContext<'tcx>) -> Self {
  35         Self {
  36             cx,
  37             maybe_typeck_results: cx.maybe_typeck_results(),
  38             allow_side_effects: true,
  39             expr_fallback: None,
  40         }
  41     }
  42
  43     /// Consider expressions containing potential side effects as not equal.
  44     pub fn deny_side_effects(self) -> Self {
  45         Self {
  46             allow_side_effects: false,
  47             ..self
  48         }
  49     }
  50
  51     pub fn expr_fallback(self, expr_fallback: impl FnMut(&Expr<'_>, &Expr<'_>) -> bool + 'a) -> Self {
  52         Self {
  53             expr_fallback: Some(Box::new(expr_fallback)),
  54             ..self
  55         }
  56     }
  57
  58     /// Use this method to wrap comparisons that may involve inter-expression context.
  59     /// See `self.locals`.
  60     pub fn inter_expr(&mut self) -> HirEqInterExpr<'_, 'a, 'tcx> {
  61         HirEqInterExpr {
  62             inner: self,
  63             locals: HirIdMap::default(),
  64         }
  65     }
  66
  67     #[allow(dead_code)]
  68     pub fn eq_block(&mut self, left: &Block<'_>, right: &Block<'_>) -> bool {
  69         self.inter_expr().eq_block(left, right)
  70     }
  71
  72     pub fn eq_expr(&mut self, left: &Expr<'_>, right: &Expr<'_>) -> bool {
  73         self.inter_expr().eq_expr(left, right)
  74     }
  75
  76     pub fn eq_path_segment(&mut self, left: &PathSegment<'_>, right: &PathSegment<'_>) -> bool {
  77         self.inter_expr().eq_path_segment(left, right)
  78     }
  79
  80     pub fn eq_path_segments(&mut self, left: &[PathSegment<'_>], right: &[PathSegment<'_>]) -> bool {
  81         self.inter_expr().eq_path_segments(left, right)
  82     }
  83 }
  84
  85 pub struct HirEqInterExpr<'a, 'b, 'tcx> {
  86     inner: &'a mut SpanlessEq<'b, 'tcx>,
  87
  88     // When binding are declared, the binding ID in the left expression is mapped to the one on the
  89     // right. For example, when comparing `{ let x = 1; x + 2 }` and `{ let y = 1; y + 2 }`,
  90     // these blocks are considered equal since `x` is mapped to `y`.
  91     locals: HirIdMap<HirId>,
  92 }
  93
  94 impl HirEqInterExpr<'_, '_, '_> {
  95     pub fn eq_stmt(&mut self, left: &Stmt<'_>, right: &Stmt<'_>) -> bool {
  96         match (&left.kind, &right.kind) {
  97             (&StmtKind::Local(l), &StmtKind::Local(r)) => {
  98                 // This additional check ensures that the type of the locals are equivalent even if the init
  99                 // expression or type have some inferred parts.
 100                 if let Some(typeck) = self.inner.maybe_typeck_results {
 101                     let l_ty = typeck.pat_ty(l.pat);
 102                     let r_ty = typeck.pat_ty(r.pat);
 103                     if !rustc_middle::ty::TyS::same_type(l_ty, r_ty) {
 104                         return false;
 105                     }
 106                 }
 107
 108                 // eq_pat adds the HirIds to the locals map. We therefor call it last to make sure that
 109                 // these only get added if the init and type is equal.
 110                 both(&l.init, &r.init, |l, r| self.eq_expr(l, r))
 111                     && both(&l.ty, &r.ty, |l, r| self.eq_ty(l, r))
 112                     && self.eq_pat(l.pat, r.pat)
 113             },
 114             (&StmtKind::Expr(l), &StmtKind::Expr(r)) | (&StmtKind::Semi(l), &StmtKind::Semi(r)) => self.eq_expr(l, r),
 115             _ => false,
 116         }
 117     }
 118
 119     /// Checks whether two blocks are the same.
 120     fn eq_block(&mut self, left: &Block<'_>, right: &Block<'_>) -> bool {
 121         match (left.stmts, left.expr, right.stmts, right.expr) {
 122             ([], None, [], None) => {
 123                 // For empty blocks, check to see if the tokens are equal. This will catch the case where a macro
 124                 // expanded to nothing, or the cfg attribute was used.
 125                 let (left, right) = match (
 126                     snippet_opt(self.inner.cx, left.span),
 127                     snippet_opt(self.inner.cx, right.span),
 128                 ) {
 129                     (Some(left), Some(right)) => (left, right),
 130                     _ => return true,
 131                 };
 132                 let mut left_pos = 0;
 133                 let left = tokenize(&left)
 134                     .map(|t| {
 135                         let end = left_pos + t.len;
 136                         let s = &left[left_pos..end];
 137                         left_pos = end;
 138                         (t, s)
 139                     })
 140                     .filter(|(t, _)| {
 141                         !matches!(
 142                             t.kind,
 143                             TokenKind::LineComment { .. } | TokenKind::BlockComment { .. } | TokenKind::Whitespace
 144                         )
 145                     })
 146                     .map(|(_, s)| s);
 147                 let mut right_pos = 0;
 148                 let right = tokenize(&right)
 149                     .map(|t| {
 150                         let end = right_pos + t.len;
 151                         let s = &right[right_pos..end];
 152                         right_pos = end;
 153                         (t, s)
 154                     })
 155                     .filter(|(t, _)| {
 156                         !matches!(
 157                             t.kind,
 158                             TokenKind::LineComment { .. } | TokenKind::BlockComment { .. } | TokenKind::Whitespace
 159                         )
 160                     })
 161                     .map(|(_, s)| s);
 162                 left.eq(right)
 163             },
 164             _ => {
 165                 over(left.stmts, right.stmts, |l, r| self.eq_stmt(l, r))
 166                     && both(&left.expr, &right.expr, |l, r| self.eq_expr(l, r))
 167             },
 168         }
 169     }
 170
 171     pub fn eq_body(&mut self, left: BodyId, right: BodyId) -> bool {
 172         let cx = self.inner.cx;
 173         let eval_const = |body| constant_context(cx, cx.tcx.typeck_body(body)).expr(&cx.tcx.hir().body(body).value);
 174         eval_const(left) == eval_const(right)
 175     }
 176
 177     #[allow(clippy::similar_names)]
 178     pub fn eq_expr(&mut self, left: &Expr<'_>, right: &Expr<'_>) -> bool {
 179         if !self.inner.allow_side_effects && differing_macro_contexts(left.span, right.span) {
 180             return false;
 181         }
 182
 183         if let Some(typeck_results) = self.inner.maybe_typeck_results {
 184             if let (Some(l), Some(r)) = (
 185                 constant_simple(self.inner.cx, typeck_results, left),
 186                 constant_simple(self.inner.cx, typeck_results, right),
 187             ) {
 188                 if l == r {
 189                     return true;
 190                 }
 191             }
 192         }
 193
 194         let is_eq = match (
 195             &reduce_exprkind(self.inner.cx, &left.kind),
 196             &reduce_exprkind(self.inner.cx, &right.kind),
 197         ) {
 198             (&ExprKind::AddrOf(lb, l_mut, le), &ExprKind::AddrOf(rb, r_mut, re)) => {
 199                 lb == rb && l_mut == r_mut && self.eq_expr(le, re)
 200             },
 201             (&ExprKind::Continue(li), &ExprKind::Continue(ri)) => {
 202                 both(&li.label, &ri.label, |l, r| l.ident.name == r.ident.name)
 203             },
 204             (&ExprKind::Assign(ll, lr, _), &ExprKind::Assign(rl, rr, _)) => {
 205                 self.inner.allow_side_effects && self.eq_expr(ll, rl) && self.eq_expr(lr, rr)
 206             },
 207             (&ExprKind::AssignOp(ref lo, ll, lr), &ExprKind::AssignOp(ref ro, rl, rr)) => {
 208                 self.inner.allow_side_effects && lo.node == ro.node && self.eq_expr(ll, rl) && self.eq_expr(lr, rr)
 209             },
 210             (&ExprKind::Block(l, _), &ExprKind::Block(r, _)) => self.eq_block(l, r),
 211             (&ExprKind::Binary(l_op, ll, lr), &ExprKind::Binary(r_op, rl, rr)) => {
 212                 l_op.node == r_op.node && self.eq_expr(ll, rl) && self.eq_expr(lr, rr)
 213                     || swap_binop(l_op.node, ll, lr).map_or(false, |(l_op, ll, lr)| {
 214                         l_op == r_op.node && self.eq_expr(ll, rl) && self.eq_expr(lr, rr)
 215                     })
 216             },
 217             (&ExprKind::Break(li, ref le), &ExprKind::Break(ri, ref re)) => {
 218                 both(&li.label, &ri.label, |l, r| l.ident.name == r.ident.name)
 219                     && both(le, re, |l, r| self.eq_expr(l, r))
 220             },
 221             (&ExprKind::Box(l), &ExprKind::Box(r)) => self.eq_expr(l, r),
 222             (&ExprKind::Call(l_fun, l_args), &ExprKind::Call(r_fun, r_args)) => {
 223                 self.inner.allow_side_effects && self.eq_expr(l_fun, r_fun) && self.eq_exprs(l_args, r_args)
 224             },
 225             (&ExprKind::Cast(lx, lt), &ExprKind::Cast(rx, rt)) | (&ExprKind::Type(lx, lt), &ExprKind::Type(rx, rt)) => {
 226                 self.eq_expr(lx, rx) && self.eq_ty(lt, rt)
 227             },
 228             (&ExprKind::Field(l_f_exp, ref l_f_ident), &ExprKind::Field(r_f_exp, ref r_f_ident)) => {
 229                 l_f_ident.name == r_f_ident.name && self.eq_expr(l_f_exp, r_f_exp)
 230             },
 231             (&ExprKind::Index(la, li), &ExprKind::Index(ra, ri)) => self.eq_expr(la, ra) && self.eq_expr(li, ri),
 232             (&ExprKind::If(lc, lt, ref le), &ExprKind::If(rc, rt, ref re)) => {
 233                 self.eq_expr(lc, rc) && self.eq_expr(&**lt, &**rt) && both(le, re, |l, r| self.eq_expr(l, r))
 234             },
 235             (&ExprKind::Lit(ref l), &ExprKind::Lit(ref r)) => l.node == r.node,
 236             (&ExprKind::Loop(lb, ref ll, ref lls, _), &ExprKind::Loop(rb, ref rl, ref rls, _)) => {
 237                 lls == rls && self.eq_block(lb, rb) && both(ll, rl, |l, r| l.ident.name == r.ident.name)
 238             },
 239             (&ExprKind::Match(le, la, ref ls), &ExprKind::Match(re, ra, ref rs)) => {
 240                 ls == rs
 241                     && self.eq_expr(le, re)
 242                     && over(la, ra, |l, r| {
 243                         self.eq_pat(l.pat, r.pat)
 244                             && both(&l.guard, &r.guard, |l, r| self.eq_guard(l, r))
 245                             && self.eq_expr(l.body, r.body)
 246                     })
 247             },
 248             (&ExprKind::MethodCall(l_path, _, l_args, _), &ExprKind::MethodCall(r_path, _, r_args, _)) => {
 249                 self.inner.allow_side_effects && self.eq_path_segment(l_path, r_path) && self.eq_exprs(l_args, r_args)
 250             },
 251             (&ExprKind::Repeat(le, ref ll_id), &ExprKind::Repeat(re, ref rl_id)) => {
 252                 self.eq_expr(le, re) && self.eq_body(ll_id.body, rl_id.body)
 253             },
 254             (&ExprKind::Ret(ref l), &ExprKind::Ret(ref r)) => both(l, r, |l, r| self.eq_expr(l, r)),
 255             (&ExprKind::Path(ref l), &ExprKind::Path(ref r)) => self.eq_qpath(l, r),
 256             (&ExprKind::Struct(l_path, lf, ref lo), &ExprKind::Struct(r_path, rf, ref ro)) => {
 257                 self.eq_qpath(l_path, r_path)
 258                     && both(lo, ro, |l, r| self.eq_expr(l, r))
 259                     && over(lf, rf, |l, r| self.eq_expr_field(l, r))
 260             },
 261             (&ExprKind::Tup(l_tup), &ExprKind::Tup(r_tup)) => self.eq_exprs(l_tup, r_tup),
 262             (&ExprKind::Unary(l_op, le), &ExprKind::Unary(r_op, re)) => l_op == r_op && self.eq_expr(le, re),
 263             (&ExprKind::Array(l), &ExprKind::Array(r)) => self.eq_exprs(l, r),
 264             (&ExprKind::DropTemps(le), &ExprKind::DropTemps(re)) => self.eq_expr(le, re),
 265             _ => false,
 266         };
 267         is_eq || self.inner.expr_fallback.as_mut().map_or(false, |f| f(left, right))
 268     }
 269
 270     fn eq_exprs(&mut self, left: &[Expr<'_>], right: &[Expr<'_>]) -> bool {
 271         over(left, right, |l, r| self.eq_expr(l, r))
 272     }
 273
 274     fn eq_expr_field(&mut self, left: &ExprField<'_>, right: &ExprField<'_>) -> bool {
 275         left.ident.name == right.ident.name && self.eq_expr(left.expr, right.expr)
 276     }
 277
 278     fn eq_guard(&mut self, left: &Guard<'_>, right: &Guard<'_>) -> bool {
 279         match (left, right) {
 280             (Guard::If(l), Guard::If(r)) => self.eq_expr(l, r),
 281             (Guard::IfLet(lp, le), Guard::IfLet(rp, re)) => self.eq_pat(lp, rp) && self.eq_expr(le, re),
 282             _ => false,
 283         }
 284     }
 285
 286     fn eq_generic_arg(&mut self, left: &GenericArg<'_>, right: &GenericArg<'_>) -> bool {
 287         match (left, right) {
 288             (GenericArg::Const(l), GenericArg::Const(r)) => self.eq_body(l.value.body, r.value.body),
 289             (GenericArg::Lifetime(l_lt), GenericArg::Lifetime(r_lt)) => Self::eq_lifetime(l_lt, r_lt),
 290             (GenericArg::Type(l_ty), GenericArg::Type(r_ty)) => self.eq_ty(l_ty, r_ty),
 291             (GenericArg::Infer(l_inf), GenericArg::Infer(r_inf)) => self.eq_ty(&l_inf.to_ty(), &r_inf.to_ty()),
 292             _ => false,
 293         }
 294     }
 295
 296     fn eq_lifetime(left: &Lifetime, right: &Lifetime) -> bool {
 297         left.name == right.name
 298     }
 299
 300     fn eq_pat_field(&mut self, left: &PatField<'_>, right: &PatField<'_>) -> bool {
 301         let (PatField { ident: li, pat: lp, .. }, PatField { ident: ri, pat: rp, .. }) = (&left, &right);
 302         li.name == ri.name && self.eq_pat(lp, rp)
 303     }
 304
 305     /// Checks whether two patterns are the same.
 306     fn eq_pat(&mut self, left: &Pat<'_>, right: &Pat<'_>) -> bool {
 307         match (&left.kind, &right.kind) {
 308             (&PatKind::Box(l), &PatKind::Box(r)) => self.eq_pat(l, r),
 309             (&PatKind::Struct(ref lp, la, ..), &PatKind::Struct(ref rp, ra, ..)) => {
 310                 self.eq_qpath(lp, rp) && over(la, ra, |l, r| self.eq_pat_field(l, r))
 311             },
 312             (&PatKind::TupleStruct(ref lp, la, ls), &PatKind::TupleStruct(ref rp, ra, rs)) => {
 313                 self.eq_qpath(lp, rp) && over(la, ra, |l, r| self.eq_pat(l, r)) && ls == rs
 314             },
 315             (&PatKind::Binding(lb, li, _, ref lp), &PatKind::Binding(rb, ri, _, ref rp)) => {
 316                 let eq = lb == rb && both(lp, rp, |l, r| self.eq_pat(l, r));
 317                 if eq {
 318                     self.locals.insert(li, ri);
 319                 }
 320                 eq
 321             },
 322             (&PatKind::Path(ref l), &PatKind::Path(ref r)) => self.eq_qpath(l, r),
 323             (&PatKind::Lit(l), &PatKind::Lit(r)) => self.eq_expr(l, r),
 324             (&PatKind::Tuple(l, ls), &PatKind::Tuple(r, rs)) => ls == rs && over(l, r, |l, r| self.eq_pat(l, r)),
 325             (&PatKind::Range(ref ls, ref le, li), &PatKind::Range(ref rs, ref re, ri)) => {
 326                 both(ls, rs, |a, b| self.eq_expr(a, b)) && both(le, re, |a, b| self.eq_expr(a, b)) && (li == ri)
 327             },
 328             (&PatKind::Ref(le, ref lm), &PatKind::Ref(re, ref rm)) => lm == rm && self.eq_pat(le, re),
 329             (&PatKind::Slice(ls, ref li, le), &PatKind::Slice(rs, ref ri, re)) => {
 330                 over(ls, rs, |l, r| self.eq_pat(l, r))
 331                     && over(le, re, |l, r| self.eq_pat(l, r))
 332                     && both(li, ri, |l, r| self.eq_pat(l, r))
 333             },
 334             (&PatKind::Wild, &PatKind::Wild) => true,
 335             _ => false,
 336         }
 337     }
 338
 339     #[allow(clippy::similar_names)]
 340     fn eq_qpath(&mut self, left: &QPath<'_>, right: &QPath<'_>) -> bool {
 341         match (left, right) {
 342             (&QPath::Resolved(ref lty, lpath), &QPath::Resolved(ref rty, rpath)) => {
 343                 both(lty, rty, |l, r| self.eq_ty(l, r)) && self.eq_path(lpath, rpath)
 344             },
 345             (&QPath::TypeRelative(lty, lseg), &QPath::TypeRelative(rty, rseg)) => {
 346                 self.eq_ty(lty, rty) && self.eq_path_segment(lseg, rseg)
 347             },
 348             (&QPath::LangItem(llang_item, _), &QPath::LangItem(rlang_item, _)) => llang_item == rlang_item,
 349             _ => false,
 350         }
 351     }
 352
 353     fn eq_path(&mut self, left: &Path<'_>, right: &Path<'_>) -> bool {
 354         match (left.res, right.res) {
 355             (Res::Local(l), Res::Local(r)) => l == r || self.locals.get(&l) == Some(&r),
 356             (Res::Local(_), _) | (_, Res::Local(_)) => false,
 357             _ => over(left.segments, right.segments, |l, r| self.eq_path_segment(l, r)),
 358         }
 359     }
 360
 361     fn eq_path_parameters(&mut self, left: &GenericArgs<'_>, right: &GenericArgs<'_>) -> bool {
 362         if !(left.parenthesized || right.parenthesized) {
 363             over(left.args, right.args, |l, r| self.eq_generic_arg(l, r)) // FIXME(flip1995): may not work
 364                 && over(left.bindings, right.bindings, |l, r| self.eq_type_binding(l, r))
 365         } else if left.parenthesized && right.parenthesized {
 366             over(left.inputs(), right.inputs(), |l, r| self.eq_ty(l, r))
 367                 && both(&Some(&left.bindings[0].ty()), &Some(&right.bindings[0].ty()), |l, r| {
 368                     self.eq_ty(l, r)
 369                 })
 370         } else {
 371             false
 372         }
 373     }
 374
 375     pub fn eq_path_segments(&mut self, left: &[PathSegment<'_>], right: &[PathSegment<'_>]) -> bool {
 376         left.len() == right.len() && left.iter().zip(right).all(|(l, r)| self.eq_path_segment(l, r))
 377     }
 378
 379     pub fn eq_path_segment(&mut self, left: &PathSegment<'_>, right: &PathSegment<'_>) -> bool {
 380         // The == of idents doesn't work with different contexts,
 381         // we have to be explicit about hygiene
 382         left.ident.name == right.ident.name && both(&left.args, &right.args, |l, r| self.eq_path_parameters(l, r))
 383     }
 384
 385     #[allow(clippy::similar_names)]
 386     fn eq_ty(&mut self, left: &Ty<'_>, right: &Ty<'_>) -> bool {
 387         match (&left.kind, &right.kind) {
 388             (&TyKind::Slice(l_vec), &TyKind::Slice(r_vec)) => self.eq_ty(l_vec, r_vec),
 389             (&TyKind::Array(lt, ref ll_id), &TyKind::Array(rt, ref rl_id)) => {
 390                 self.eq_ty(lt, rt) && self.eq_body(ll_id.body, rl_id.body)
 391             },
 392             (&TyKind::Ptr(ref l_mut), &TyKind::Ptr(ref r_mut)) => {
 393                 l_mut.mutbl == r_mut.mutbl && self.eq_ty(&*l_mut.ty, &*r_mut.ty)
 394             },
 395             (&TyKind::Rptr(_, ref l_rmut), &TyKind::Rptr(_, ref r_rmut)) => {
 396                 l_rmut.mutbl == r_rmut.mutbl && self.eq_ty(&*l_rmut.ty, &*r_rmut.ty)
 397             },
 398             (&TyKind::Path(ref l), &TyKind::Path(ref r)) => self.eq_qpath(l, r),
 399             (&TyKind::Tup(l), &TyKind::Tup(r)) => over(l, r, |l, r| self.eq_ty(l, r)),
 400             (&TyKind::Infer, &TyKind::Infer) => true,
 401             _ => false,
 402         }
 403     }
 404
 405     fn eq_type_binding(&mut self, left: &TypeBinding<'_>, right: &TypeBinding<'_>) -> bool {
 406         left.ident.name == right.ident.name && self.eq_ty(left.ty(), right.ty())
 407     }
 408 }
 409
 410 /// Some simple reductions like `{ return }` => `return`
 411 fn reduce_exprkind<'hir>(cx: &LateContext<'_>, kind: &'hir ExprKind<'hir>) -> &'hir ExprKind<'hir> {
 412     if let ExprKind::Block(block, _) = kind {
 413         match (block.stmts, block.expr) {
 414             // From an `if let` expression without an `else` block. The arm for the implicit wild pattern is an empty
 415             // block with an empty span.
 416             ([], None) if block.span.is_empty() => &ExprKind::Tup(&[]),
 417             // `{}` => `()`
 418             ([], None) => match snippet_opt(cx, block.span) {
 419                 // Don't reduce if there are any tokens contained in the braces
 420                 Some(snip)
 421                     if tokenize(&snip)
 422                         .map(|t| t.kind)
 423                         .filter(|t| {
 424                             !matches!(
 425                                 t,
 426                                 TokenKind::LineComment { .. } | TokenKind::BlockComment { .. } | TokenKind::Whitespace
 427                             )
 428                         })
 429                         .ne([TokenKind::OpenBrace, TokenKind::CloseBrace].iter().copied()) =>
 430                 {
 431                     kind
 432                 },
 433                 _ => &ExprKind::Tup(&[]),
 434             },
 435             ([], Some(expr)) => match expr.kind {
 436                 // `{ return .. }` => `return ..`
 437                 ExprKind::Ret(..) => &expr.kind,
 438                 _ => kind,
 439             },
 440             ([stmt], None) => match stmt.kind {
 441                 StmtKind::Expr(expr) | StmtKind::Semi(expr) => match expr.kind {
 442                     // `{ return ..; }` => `return ..`
 443                     ExprKind::Ret(..) => &expr.kind,
 444                     _ => kind,
 445                 },
 446                 _ => kind,
 447             },
 448             _ => kind,
 449         }
 450     } else {
 451         kind
 452     }
 453 }
 454
 455 fn swap_binop<'a>(
 456     binop: BinOpKind,
 457     lhs: &'a Expr<'a>,
 458     rhs: &'a Expr<'a>,
 459 ) -> Option<(BinOpKind, &'a Expr<'a>, &'a Expr<'a>)> {
 460     match binop {
 461         BinOpKind::Add | BinOpKind::Eq | BinOpKind::Ne | BinOpKind::BitAnd | BinOpKind::BitXor | BinOpKind::BitOr => {
 462             Some((binop, rhs, lhs))
 463         },
 464         BinOpKind::Lt => Some((BinOpKind::Gt, rhs, lhs)),
 465         BinOpKind::Le => Some((BinOpKind::Ge, rhs, lhs)),
 466         BinOpKind::Ge => Some((BinOpKind::Le, rhs, lhs)),
 467         BinOpKind::Gt => Some((BinOpKind::Lt, rhs, lhs)),
 468         BinOpKind::Mul // Not always commutative, e.g. with matrices. See issue #5698
 469         | BinOpKind::Shl
 470         | BinOpKind::Shr
 471         | BinOpKind::Rem
 472         | BinOpKind::Sub
 473         | BinOpKind::Div
 474         | BinOpKind::And
 475         | BinOpKind::Or => None,
 476     }
 477 }
 478
 479 /// Checks if the two `Option`s are both `None` or some equal values as per
 480 /// `eq_fn`.
 481 pub fn both<X>(l: &Option<X>, r: &Option<X>, mut eq_fn: impl FnMut(&X, &X) -> bool) -> bool {
 482     l.as_ref()
 483         .map_or_else(|| r.is_none(), |x| r.as_ref().map_or(false, |y| eq_fn(x, y)))
 484 }
 485
 486 /// Checks if two slices are equal as per `eq_fn`.
 487 pub fn over<X>(left: &[X], right: &[X], mut eq_fn: impl FnMut(&X, &X) -> bool) -> bool {
 488     left.len() == right.len() && left.iter().zip(right).all(|(x, y)| eq_fn(x, y))
 489 }
 490
 491 /// Counts how many elements of the slices are equal as per `eq_fn`.
 492 pub fn count_eq<X: Sized>(
 493     left: &mut dyn Iterator<Item = X>,
 494     right: &mut dyn Iterator<Item = X>,
 495     mut eq_fn: impl FnMut(&X, &X) -> bool,
 496 ) -> usize {
 497     left.zip(right).take_while(|(l, r)| eq_fn(l, r)).count()
 498 }
 499
 500 /// Checks if two expressions evaluate to the same value, and don't contain any side effects.
 501 pub fn eq_expr_value(cx: &LateContext<'_>, left: &Expr<'_>, right: &Expr<'_>) -> bool {
 502     SpanlessEq::new(cx).deny_side_effects().eq_expr(left, right)
 503 }
 504
 505 /// Type used to hash an ast element. This is different from the `Hash` trait
 506 /// on ast types as this
 507 /// trait would consider IDs and spans.
 508 ///
 509 /// All expressions kind are hashed, but some might have a weaker hash.
 510 pub struct SpanlessHash<'a, 'tcx> {
 511     /// Context used to evaluate constant expressions.
 512     cx: &'a LateContext<'tcx>,
 513     maybe_typeck_results: Option<&'tcx TypeckResults<'tcx>>,
 514     s: FxHasher,
 515 }
 516
 517 impl<'a, 'tcx> SpanlessHash<'a, 'tcx> {
 518     pub fn new(cx: &'a LateContext<'tcx>) -> Self {
 519         Self {
 520             cx,
 521             maybe_typeck_results: cx.maybe_typeck_results(),
 522             s: FxHasher::default(),
 523         }
 524     }
 525
 526     pub fn finish(self) -> u64 {
 527         self.s.finish()
 528     }
 529
 530     pub fn hash_block(&mut self, b: &Block<'_>) {
 531         for s in b.stmts {
 532             self.hash_stmt(s);
 533         }
 534
 535         if let Some(e) = b.expr {
 536             self.hash_expr(e);
 537         }
 538
 539         std::mem::discriminant(&b.rules).hash(&mut self.s);
 540     }
 541
 542     #[allow(clippy::many_single_char_names, clippy::too_many_lines)]
 543     pub fn hash_expr(&mut self, e: &Expr<'_>) {
 544         let simple_const = self
 545             .maybe_typeck_results
 546             .and_then(|typeck_results| constant_simple(self.cx, typeck_results, e));
 547
 548         // const hashing may result in the same hash as some unrelated node, so add a sort of
 549         // discriminant depending on which path we're choosing next
 550         simple_const.hash(&mut self.s);
 551         if simple_const.is_some() {
 552             return;
 553         }
 554
 555         std::mem::discriminant(&e.kind).hash(&mut self.s);
 556
 557         match e.kind {
 558             ExprKind::AddrOf(kind, m, e) => {
 559                 std::mem::discriminant(&kind).hash(&mut self.s);
 560                 m.hash(&mut self.s);
 561                 self.hash_expr(e);
 562             },
 563             ExprKind::Continue(i) => {
 564                 if let Some(i) = i.label {
 565                     self.hash_name(i.ident.name);
 566                 }
 567             },
 568             ExprKind::Assign(l, r, _) => {
 569                 self.hash_expr(l);
 570                 self.hash_expr(r);
 571             },
 572             ExprKind::AssignOp(ref o, l, r) => {
 573                 std::mem::discriminant(&o.node).hash(&mut self.s);
 574                 self.hash_expr(l);
 575                 self.hash_expr(r);
 576             },
 577             ExprKind::Block(b, _) => {
 578                 self.hash_block(b);
 579             },
 580             ExprKind::Binary(op, l, r) => {
 581                 std::mem::discriminant(&op.node).hash(&mut self.s);
 582                 self.hash_expr(l);
 583                 self.hash_expr(r);
 584             },
 585             ExprKind::Break(i, ref j) => {
 586                 if let Some(i) = i.label {
 587                     self.hash_name(i.ident.name);
 588                 }
 589                 if let Some(j) = *j {
 590                     self.hash_expr(&*j);
 591                 }
 592             },
 593             ExprKind::Box(e) | ExprKind::DropTemps(e) | ExprKind::Yield(e, _) => {
 594                 self.hash_expr(e);
 595             },
 596             ExprKind::Call(fun, args) => {
 597                 self.hash_expr(fun);
 598                 self.hash_exprs(args);
 599             },
 600             ExprKind::Cast(e, ty) | ExprKind::Type(e, ty) => {
 601                 self.hash_expr(e);
 602                 self.hash_ty(ty);
 603             },
 604             ExprKind::Closure(cap, _, eid, _, _) => {
 605                 std::mem::discriminant(&cap).hash(&mut self.s);
 606                 // closures inherit TypeckResults
 607                 self.hash_expr(&self.cx.tcx.hir().body(eid).value);
 608             },
 609             ExprKind::Field(e, ref f) => {
 610                 self.hash_expr(e);
 611                 self.hash_name(f.name);
 612             },
 613             ExprKind::Index(a, i) => {
 614                 self.hash_expr(a);
 615                 self.hash_expr(i);
 616             },
 617             ExprKind::InlineAsm(asm) => {
 618                 for piece in asm.template {
 619                     match piece {
 620                         InlineAsmTemplatePiece::String(s) => s.hash(&mut self.s),
 621                         InlineAsmTemplatePiece::Placeholder {
 622                             operand_idx,
 623                             modifier,
 624                             span: _,
 625                         } => {
 626                             operand_idx.hash(&mut self.s);
 627                             modifier.hash(&mut self.s);
 628                         },
 629                     }
 630                 }
 631                 asm.options.hash(&mut self.s);
 632                 for (op, _op_sp) in asm.operands {
 633                     match op {
 634                         InlineAsmOperand::In { reg, expr } => {
 635                             reg.hash(&mut self.s);
 636                             self.hash_expr(expr);
 637                         },
 638                         InlineAsmOperand::Out { reg, late, expr } => {
 639                             reg.hash(&mut self.s);
 640                             late.hash(&mut self.s);
 641                             if let Some(expr) = expr {
 642                                 self.hash_expr(expr);
 643                             }
 644                         },
 645                         InlineAsmOperand::InOut { reg, late, expr } => {
 646                             reg.hash(&mut self.s);
 647                             late.hash(&mut self.s);
 648                             self.hash_expr(expr);
 649                         },
 650                         InlineAsmOperand::SplitInOut {
 651                             reg,
 652                             late,
 653                             in_expr,
 654                             out_expr,
 655                         } => {
 656                             reg.hash(&mut self.s);
 657                             late.hash(&mut self.s);
 658                             self.hash_expr(in_expr);
 659                             if let Some(out_expr) = out_expr {
 660                                 self.hash_expr(out_expr);
 661                             }
 662                         },
 663                         InlineAsmOperand::Const { anon_const } => self.hash_body(anon_const.body),
 664                         InlineAsmOperand::Sym { expr } => self.hash_expr(expr),
 665                     }
 666                 }
 667             },
 668             ExprKind::LlvmInlineAsm(..) | ExprKind::Err => {},
 669             ExprKind::Lit(ref l) => {
 670                 l.node.hash(&mut self.s);
 671             },
 672             ExprKind::Loop(b, ref i, ..) => {
 673                 self.hash_block(b);
 674                 if let Some(i) = *i {
 675                     self.hash_name(i.ident.name);
 676                 }
 677             },
 678             ExprKind::If(cond, then, ref else_opt) => {
 679                 self.hash_expr(cond);
 680                 self.hash_expr(then);
 681                 if let Some(e) = *else_opt {
 682                     self.hash_expr(e);
 683                 }
 684             },
 685             ExprKind::Match(e, arms, ref s) => {
 686                 self.hash_expr(e);
 687
 688                 for arm in arms {
 689                     self.hash_pat(arm.pat);
 690                     if let Some(ref e) = arm.guard {
 691                         self.hash_guard(e);
 692                     }
 693                     self.hash_expr(arm.body);
 694                 }
 695
 696                 s.hash(&mut self.s);
 697             },
 698             ExprKind::MethodCall(path, ref _tys, args, ref _fn_span) => {
 699                 self.hash_name(path.ident.name);
 700                 self.hash_exprs(args);
 701             },
 702             ExprKind::ConstBlock(ref l_id) => {
 703                 self.hash_body(l_id.body);
 704             },
 705             ExprKind::Repeat(e, ref l_id) => {
 706                 self.hash_expr(e);
 707                 self.hash_body(l_id.body);
 708             },
 709             ExprKind::Ret(ref e) => {
 710                 if let Some(e) = *e {
 711                     self.hash_expr(e);
 712                 }
 713             },
 714             ExprKind::Path(ref qpath) => {
 715                 self.hash_qpath(qpath);
 716             },
 717             ExprKind::Struct(path, fields, ref expr) => {
 718                 self.hash_qpath(path);
 719
 720                 for f in fields {
 721                     self.hash_name(f.ident.name);
 722                     self.hash_expr(f.expr);
 723                 }
 724
 725                 if let Some(e) = *expr {
 726                     self.hash_expr(e);
 727                 }
 728             },
 729             ExprKind::Tup(tup) => {
 730                 self.hash_exprs(tup);
 731             },
 732             ExprKind::Array(v) => {
 733                 self.hash_exprs(v);
 734             },
 735             ExprKind::Unary(lop, le) => {
 736                 std::mem::discriminant(&lop).hash(&mut self.s);
 737                 self.hash_expr(le);
 738             },
 739         }
 740     }
 741
 742     pub fn hash_exprs(&mut self, e: &[Expr<'_>]) {
 743         for e in e {
 744             self.hash_expr(e);
 745         }
 746     }
 747
 748     pub fn hash_name(&mut self, n: Symbol) {
 749         n.hash(&mut self.s);
 750     }
 751
 752     pub fn hash_qpath(&mut self, p: &QPath<'_>) {
 753         match *p {
 754             QPath::Resolved(_, path) => {
 755                 self.hash_path(path);
 756             },
 757             QPath::TypeRelative(_, path) => {
 758                 self.hash_name(path.ident.name);
 759             },
 760             QPath::LangItem(lang_item, ..) => {
 761                 std::mem::discriminant(&lang_item).hash(&mut self.s);
 762             },
 763         }
 764         // self.maybe_typeck_results.unwrap().qpath_res(p, id).hash(&mut self.s);
 765     }
 766
 767     pub fn hash_pat(&mut self, pat: &Pat<'_>) {
 768         std::mem::discriminant(&pat.kind).hash(&mut self.s);
 769         match pat.kind {
 770             PatKind::Binding(ann, _, _, pat) => {
 771                 std::mem::discriminant(&ann).hash(&mut self.s);
 772                 if let Some(pat) = pat {
 773                     self.hash_pat(pat);
 774                 }
 775             },
 776             PatKind::Box(pat) => self.hash_pat(pat),
 777             PatKind::Lit(expr) => self.hash_expr(expr),
 778             PatKind::Or(pats) => {
 779                 for pat in pats {
 780                     self.hash_pat(pat);
 781                 }
 782             },
 783             PatKind::Path(ref qpath) => self.hash_qpath(qpath),
 784             PatKind::Range(s, e, i) => {
 785                 if let Some(s) = s {
 786                     self.hash_expr(s);
 787                 }
 788                 if let Some(e) = e {
 789                     self.hash_expr(e);
 790                 }
 791                 std::mem::discriminant(&i).hash(&mut self.s);
 792             },
 793             PatKind::Ref(pat, mu) => {
 794                 self.hash_pat(pat);
 795                 std::mem::discriminant(&mu).hash(&mut self.s);
 796             },
 797             PatKind::Slice(l, m, r) => {
 798                 for pat in l {
 799                     self.hash_pat(pat);
 800                 }
 801                 if let Some(pat) = m {
 802                     self.hash_pat(pat);
 803                 }
 804                 for pat in r {
 805                     self.hash_pat(pat);
 806                 }
 807             },
 808             PatKind::Struct(ref qpath, fields, e) => {
 809                 self.hash_qpath(qpath);
 810                 for f in fields {
 811                     self.hash_name(f.ident.name);
 812                     self.hash_pat(f.pat);
 813                 }
 814                 e.hash(&mut self.s);
 815             },
 816             PatKind::Tuple(pats, e) => {
 817                 for pat in pats {
 818                     self.hash_pat(pat);
 819                 }
 820                 e.hash(&mut self.s);
 821             },
 822             PatKind::TupleStruct(ref qpath, pats, e) => {
 823                 self.hash_qpath(qpath);
 824                 for pat in pats {
 825                     self.hash_pat(pat);
 826                 }
 827                 e.hash(&mut self.s);
 828             },
 829             PatKind::Wild => {},
 830         }
 831     }
 832
 833     pub fn hash_path(&mut self, path: &Path<'_>) {
 834         match path.res {
 835             // constant hash since equality is dependant on inter-expression context
 836             Res::Local(_) => 1_usize.hash(&mut self.s),
 837             _ => {
 838                 for seg in path.segments {
 839                     self.hash_name(seg.ident.name);
 840                     self.hash_generic_args(seg.args().args);
 841                 }
 842             },
 843         }
 844     }
 845
 846     pub fn hash_stmt(&mut self, b: &Stmt<'_>) {
 847         std::mem::discriminant(&b.kind).hash(&mut self.s);
 848
 849         match &b.kind {
 850             StmtKind::Local(local) => {
 851                 self.hash_pat(local.pat);
 852                 if let Some(init) = local.init {
 853                     self.hash_expr(init);
 854                 }
 855             },
 856             StmtKind::Item(..) => {},
 857             StmtKind::Expr(expr) | StmtKind::Semi(expr) => {
 858                 self.hash_expr(expr);
 859             },
 860         }
 861     }
 862
 863     pub fn hash_guard(&mut self, g: &Guard<'_>) {
 864         match g {
 865             Guard::If(expr) | Guard::IfLet(_, expr) => {
 866                 self.hash_expr(expr);
 867             },
 868         }
 869     }
 870
 871     pub fn hash_lifetime(&mut self, lifetime: Lifetime) {
 872         std::mem::discriminant(&lifetime.name).hash(&mut self.s);
 873         if let LifetimeName::Param(ref name) = lifetime.name {
 874             std::mem::discriminant(name).hash(&mut self.s);
 875             match name {
 876                 ParamName::Plain(ref ident) => {
 877                     ident.name.hash(&mut self.s);
 878                 },
 879                 ParamName::Fresh(ref size) => {
 880                     size.hash(&mut self.s);
 881                 },
 882                 ParamName::Error => {},
 883             }
 884         }
 885     }
 886
 887     pub fn hash_ty(&mut self, ty: &Ty<'_>) {
 888         std::mem::discriminant(&ty.kind).hash(&mut self.s);
 889         self.hash_tykind(&ty.kind);
 890     }
 891
 892     pub fn hash_tykind(&mut self, ty: &TyKind<'_>) {
 893         match ty {
 894             TyKind::Slice(ty) => {
 895                 self.hash_ty(ty);
 896             },
 897             TyKind::Array(ty, anon_const) => {
 898                 self.hash_ty(ty);
 899                 self.hash_body(anon_const.body);
 900             },
 901             TyKind::Ptr(ref mut_ty) => {
 902                 self.hash_ty(mut_ty.ty);
 903                 mut_ty.mutbl.hash(&mut self.s);
 904             },
 905             TyKind::Rptr(lifetime, ref mut_ty) => {
 906                 self.hash_lifetime(*lifetime);
 907                 self.hash_ty(mut_ty.ty);
 908                 mut_ty.mutbl.hash(&mut self.s);
 909             },
 910             TyKind::BareFn(bfn) => {
 911                 bfn.unsafety.hash(&mut self.s);
 912                 bfn.abi.hash(&mut self.s);
 913                 for arg in bfn.decl.inputs {
 914                     self.hash_ty(arg);
 915                 }
 916                 std::mem::discriminant(&bfn.decl.output).hash(&mut self.s);
 917                 match bfn.decl.output {
 918                     FnRetTy::DefaultReturn(_) => {},
 919                     FnRetTy::Return(ty) => {
 920                         self.hash_ty(ty);
 921                     },
 922                 }
 923                 bfn.decl.c_variadic.hash(&mut self.s);
 924             },
 925             TyKind::Tup(ty_list) => {
 926                 for ty in *ty_list {
 927                     self.hash_ty(ty);
 928                 }
 929             },
 930             TyKind::Path(ref qpath) => self.hash_qpath(qpath),
 931             TyKind::OpaqueDef(_, arg_list) => {
 932                 self.hash_generic_args(arg_list);
 933             },
 934             TyKind::TraitObject(_, lifetime, _) => {
 935                 self.hash_lifetime(*lifetime);
 936             },
 937             TyKind::Typeof(anon_const) => {
 938                 self.hash_body(anon_const.body);
 939             },
 940             TyKind::Err | TyKind::Infer | TyKind::Never => {},
 941         }
 942     }
 943
 944     pub fn hash_body(&mut self, body_id: BodyId) {
 945         // swap out TypeckResults when hashing a body
 946         let old_maybe_typeck_results = self.maybe_typeck_results.replace(self.cx.tcx.typeck_body(body_id));
 947         self.hash_expr(&self.cx.tcx.hir().body(body_id).value);
 948         self.maybe_typeck_results = old_maybe_typeck_results;
 949     }
 950
 951     fn hash_generic_args(&mut self, arg_list: &[GenericArg<'_>]) {
 952         for arg in arg_list {
 953             match *arg {
 954                 GenericArg::Lifetime(l) => self.hash_lifetime(l),
 955                 GenericArg::Type(ref ty) => self.hash_ty(ty),
 956                 GenericArg::Const(ref ca) => self.hash_body(ca.value.body),
 957                 GenericArg::Infer(ref inf) => self.hash_ty(&inf.to_ty()),
 958             }
 959         }
 960     }
 961 }