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::Let(lp, le, _), &ExprKind::Let(rp, re, _)) => self.eq_pat(lp, rp) && self.eq_expr(le, re),
 236             (&ExprKind::Lit(ref l), &ExprKind::Lit(ref r)) => l.node == r.node,
 237             (&ExprKind::Loop(lb, ref ll, ref lls, _), &ExprKind::Loop(rb, ref rl, ref rls, _)) => {
 238                 lls == rls && self.eq_block(lb, rb) && both(ll, rl, |l, r| l.ident.name == r.ident.name)
 239             },
 240             (&ExprKind::Match(le, la, ref ls), &ExprKind::Match(re, ra, ref rs)) => {
 241                 ls == rs
 242                     && self.eq_expr(le, re)
 243                     && over(la, ra, |l, r| {
 244                         self.eq_pat(l.pat, r.pat)
 245                             && both(&l.guard, &r.guard, |l, r| self.eq_guard(l, r))
 246                             && self.eq_expr(l.body, r.body)
 247                     })
 248             },
 249             (&ExprKind::MethodCall(l_path, _, l_args, _), &ExprKind::MethodCall(r_path, _, r_args, _)) => {
 250                 self.inner.allow_side_effects && self.eq_path_segment(l_path, r_path) && self.eq_exprs(l_args, r_args)
 251             },
 252             (&ExprKind::Repeat(le, ref ll_id), &ExprKind::Repeat(re, ref rl_id)) => {
 253                 self.eq_expr(le, re) && self.eq_body(ll_id.body, rl_id.body)
 254             },
 255             (&ExprKind::Ret(ref l), &ExprKind::Ret(ref r)) => both(l, r, |l, r| self.eq_expr(l, r)),
 256             (&ExprKind::Path(ref l), &ExprKind::Path(ref r)) => self.eq_qpath(l, r),
 257             (&ExprKind::Struct(l_path, lf, ref lo), &ExprKind::Struct(r_path, rf, ref ro)) => {
 258                 self.eq_qpath(l_path, r_path)
 259                     && both(lo, ro, |l, r| self.eq_expr(l, r))
 260                     && over(lf, rf, |l, r| self.eq_expr_field(l, r))
 261             },
 262             (&ExprKind::Tup(l_tup), &ExprKind::Tup(r_tup)) => self.eq_exprs(l_tup, r_tup),
 263             (&ExprKind::Unary(l_op, le), &ExprKind::Unary(r_op, re)) => l_op == r_op && self.eq_expr(le, re),
 264             (&ExprKind::Array(l), &ExprKind::Array(r)) => self.eq_exprs(l, r),
 265             (&ExprKind::DropTemps(le), &ExprKind::DropTemps(re)) => self.eq_expr(le, re),
 266             _ => false,
 267         };
 268         is_eq || self.inner.expr_fallback.as_mut().map_or(false, |f| f(left, right))
 269     }
 270
 271     fn eq_exprs(&mut self, left: &[Expr<'_>], right: &[Expr<'_>]) -> bool {
 272         over(left, right, |l, r| self.eq_expr(l, r))
 273     }
 274
 275     fn eq_expr_field(&mut self, left: &ExprField<'_>, right: &ExprField<'_>) -> bool {
 276         left.ident.name == right.ident.name && self.eq_expr(left.expr, right.expr)
 277     }
 278
 279     fn eq_guard(&mut self, left: &Guard<'_>, right: &Guard<'_>) -> bool {
 280         match (left, right) {
 281             (Guard::If(l), Guard::If(r)) => self.eq_expr(l, r),
 282             (Guard::IfLet(lp, le), Guard::IfLet(rp, re)) => self.eq_pat(lp, rp) && self.eq_expr(le, re),
 283             _ => false,
 284         }
 285     }
 286
 287     fn eq_generic_arg(&mut self, left: &GenericArg<'_>, right: &GenericArg<'_>) -> bool {
 288         match (left, right) {
 289             (GenericArg::Const(l), GenericArg::Const(r)) => self.eq_body(l.value.body, r.value.body),
 290             (GenericArg::Lifetime(l_lt), GenericArg::Lifetime(r_lt)) => Self::eq_lifetime(l_lt, r_lt),
 291             (GenericArg::Type(l_ty), GenericArg::Type(r_ty)) => self.eq_ty(l_ty, r_ty),
 292             (GenericArg::Infer(l_inf), GenericArg::Infer(r_inf)) => self.eq_ty(&l_inf.to_ty(), &r_inf.to_ty()),
 293             _ => false,
 294         }
 295     }
 296
 297     fn eq_lifetime(left: &Lifetime, right: &Lifetime) -> bool {
 298         left.name == right.name
 299     }
 300
 301     fn eq_pat_field(&mut self, left: &PatField<'_>, right: &PatField<'_>) -> bool {
 302         let (PatField { ident: li, pat: lp, .. }, PatField { ident: ri, pat: rp, .. }) = (&left, &right);
 303         li.name == ri.name && self.eq_pat(lp, rp)
 304     }
 305
 306     /// Checks whether two patterns are the same.
 307     fn eq_pat(&mut self, left: &Pat<'_>, right: &Pat<'_>) -> bool {
 308         match (&left.kind, &right.kind) {
 309             (&PatKind::Box(l), &PatKind::Box(r)) => self.eq_pat(l, r),
 310             (&PatKind::Struct(ref lp, la, ..), &PatKind::Struct(ref rp, ra, ..)) => {
 311                 self.eq_qpath(lp, rp) && over(la, ra, |l, r| self.eq_pat_field(l, r))
 312             },
 313             (&PatKind::TupleStruct(ref lp, la, ls), &PatKind::TupleStruct(ref rp, ra, rs)) => {
 314                 self.eq_qpath(lp, rp) && over(la, ra, |l, r| self.eq_pat(l, r)) && ls == rs
 315             },
 316             (&PatKind::Binding(lb, li, _, ref lp), &PatKind::Binding(rb, ri, _, ref rp)) => {
 317                 let eq = lb == rb && both(lp, rp, |l, r| self.eq_pat(l, r));
 318                 if eq {
 319                     self.locals.insert(li, ri);
 320                 }
 321                 eq
 322             },
 323             (&PatKind::Path(ref l), &PatKind::Path(ref r)) => self.eq_qpath(l, r),
 324             (&PatKind::Lit(l), &PatKind::Lit(r)) => self.eq_expr(l, r),
 325             (&PatKind::Tuple(l, ls), &PatKind::Tuple(r, rs)) => ls == rs && over(l, r, |l, r| self.eq_pat(l, r)),
 326             (&PatKind::Range(ref ls, ref le, li), &PatKind::Range(ref rs, ref re, ri)) => {
 327                 both(ls, rs, |a, b| self.eq_expr(a, b)) && both(le, re, |a, b| self.eq_expr(a, b)) && (li == ri)
 328             },
 329             (&PatKind::Ref(le, ref lm), &PatKind::Ref(re, ref rm)) => lm == rm && self.eq_pat(le, re),
 330             (&PatKind::Slice(ls, ref li, le), &PatKind::Slice(rs, ref ri, re)) => {
 331                 over(ls, rs, |l, r| self.eq_pat(l, r))
 332                     && over(le, re, |l, r| self.eq_pat(l, r))
 333                     && both(li, ri, |l, r| self.eq_pat(l, r))
 334             },
 335             (&PatKind::Wild, &PatKind::Wild) => true,
 336             _ => false,
 337         }
 338     }
 339
 340     #[allow(clippy::similar_names)]
 341     fn eq_qpath(&mut self, left: &QPath<'_>, right: &QPath<'_>) -> bool {
 342         match (left, right) {
 343             (&QPath::Resolved(ref lty, lpath), &QPath::Resolved(ref rty, rpath)) => {
 344                 both(lty, rty, |l, r| self.eq_ty(l, r)) && self.eq_path(lpath, rpath)
 345             },
 346             (&QPath::TypeRelative(lty, lseg), &QPath::TypeRelative(rty, rseg)) => {
 347                 self.eq_ty(lty, rty) && self.eq_path_segment(lseg, rseg)
 348             },
 349             (&QPath::LangItem(llang_item, _), &QPath::LangItem(rlang_item, _)) => llang_item == rlang_item,
 350             _ => false,
 351         }
 352     }
 353
 354     fn eq_path(&mut self, left: &Path<'_>, right: &Path<'_>) -> bool {
 355         match (left.res, right.res) {
 356             (Res::Local(l), Res::Local(r)) => l == r || self.locals.get(&l) == Some(&r),
 357             (Res::Local(_), _) | (_, Res::Local(_)) => false,
 358             _ => over(left.segments, right.segments, |l, r| self.eq_path_segment(l, r)),
 359         }
 360     }
 361
 362     fn eq_path_parameters(&mut self, left: &GenericArgs<'_>, right: &GenericArgs<'_>) -> bool {
 363         if !(left.parenthesized || right.parenthesized) {
 364             over(left.args, right.args, |l, r| self.eq_generic_arg(l, r)) // FIXME(flip1995): may not work
 365                 && over(left.bindings, right.bindings, |l, r| self.eq_type_binding(l, r))
 366         } else if left.parenthesized && right.parenthesized {
 367             over(left.inputs(), right.inputs(), |l, r| self.eq_ty(l, r))
 368                 && both(&Some(&left.bindings[0].ty()), &Some(&right.bindings[0].ty()), |l, r| {
 369                     self.eq_ty(l, r)
 370                 })
 371         } else {
 372             false
 373         }
 374     }
 375
 376     pub fn eq_path_segments(&mut self, left: &[PathSegment<'_>], right: &[PathSegment<'_>]) -> bool {
 377         left.len() == right.len() && left.iter().zip(right).all(|(l, r)| self.eq_path_segment(l, r))
 378     }
 379
 380     pub fn eq_path_segment(&mut self, left: &PathSegment<'_>, right: &PathSegment<'_>) -> bool {
 381         // The == of idents doesn't work with different contexts,
 382         // we have to be explicit about hygiene
 383         left.ident.name == right.ident.name && both(&left.args, &right.args, |l, r| self.eq_path_parameters(l, r))
 384     }
 385
 386     #[allow(clippy::similar_names)]
 387     fn eq_ty(&mut self, left: &Ty<'_>, right: &Ty<'_>) -> bool {
 388         match (&left.kind, &right.kind) {
 389             (&TyKind::Slice(l_vec), &TyKind::Slice(r_vec)) => self.eq_ty(l_vec, r_vec),
 390             (&TyKind::Array(lt, ref ll_id), &TyKind::Array(rt, ref rl_id)) => {
 391                 self.eq_ty(lt, rt) && self.eq_body(ll_id.body, rl_id.body)
 392             },
 393             (&TyKind::Ptr(ref l_mut), &TyKind::Ptr(ref r_mut)) => {
 394                 l_mut.mutbl == r_mut.mutbl && self.eq_ty(&*l_mut.ty, &*r_mut.ty)
 395             },
 396             (&TyKind::Rptr(_, ref l_rmut), &TyKind::Rptr(_, ref r_rmut)) => {
 397                 l_rmut.mutbl == r_rmut.mutbl && self.eq_ty(&*l_rmut.ty, &*r_rmut.ty)
 398             },
 399             (&TyKind::Path(ref l), &TyKind::Path(ref r)) => self.eq_qpath(l, r),
 400             (&TyKind::Tup(l), &TyKind::Tup(r)) => over(l, r, |l, r| self.eq_ty(l, r)),
 401             (&TyKind::Infer, &TyKind::Infer) => true,
 402             _ => false,
 403         }
 404     }
 405
 406     fn eq_type_binding(&mut self, left: &TypeBinding<'_>, right: &TypeBinding<'_>) -> bool {
 407         left.ident.name == right.ident.name && self.eq_ty(left.ty(), right.ty())
 408     }
 409 }
 410
 411 /// Some simple reductions like `{ return }` => `return`
 412 fn reduce_exprkind<'hir>(cx: &LateContext<'_>, kind: &'hir ExprKind<'hir>) -> &'hir ExprKind<'hir> {
 413     if let ExprKind::Block(block, _) = kind {
 414         match (block.stmts, block.expr) {
 415             // From an `if let` expression without an `else` block. The arm for the implicit wild pattern is an empty
 416             // block with an empty span.
 417             ([], None) if block.span.is_empty() => &ExprKind::Tup(&[]),
 418             // `{}` => `()`
 419             ([], None) => match snippet_opt(cx, block.span) {
 420                 // Don't reduce if there are any tokens contained in the braces
 421                 Some(snip)
 422                     if tokenize(&snip)
 423                         .map(|t| t.kind)
 424                         .filter(|t| {
 425                             !matches!(
 426                                 t,
 427                                 TokenKind::LineComment { .. } | TokenKind::BlockComment { .. } | TokenKind::Whitespace
 428                             )
 429                         })
 430                         .ne([TokenKind::OpenBrace, TokenKind::CloseBrace].iter().copied()) =>
 431                 {
 432                     kind
 433                 },
 434                 _ => &ExprKind::Tup(&[]),
 435             },
 436             ([], Some(expr)) => match expr.kind {
 437                 // `{ return .. }` => `return ..`
 438                 ExprKind::Ret(..) => &expr.kind,
 439                 _ => kind,
 440             },
 441             ([stmt], None) => match stmt.kind {
 442                 StmtKind::Expr(expr) | StmtKind::Semi(expr) => match expr.kind {
 443                     // `{ return ..; }` => `return ..`
 444                     ExprKind::Ret(..) => &expr.kind,
 445                     _ => kind,
 446                 },
 447                 _ => kind,
 448             },
 449             _ => kind,
 450         }
 451     } else {
 452         kind
 453     }
 454 }
 455
 456 fn swap_binop<'a>(
 457     binop: BinOpKind,
 458     lhs: &'a Expr<'a>,
 459     rhs: &'a Expr<'a>,
 460 ) -> Option<(BinOpKind, &'a Expr<'a>, &'a Expr<'a>)> {
 461     match binop {
 462         BinOpKind::Add | BinOpKind::Eq | BinOpKind::Ne | BinOpKind::BitAnd | BinOpKind::BitXor | BinOpKind::BitOr => {
 463             Some((binop, rhs, lhs))
 464         },
 465         BinOpKind::Lt => Some((BinOpKind::Gt, rhs, lhs)),
 466         BinOpKind::Le => Some((BinOpKind::Ge, rhs, lhs)),
 467         BinOpKind::Ge => Some((BinOpKind::Le, rhs, lhs)),
 468         BinOpKind::Gt => Some((BinOpKind::Lt, rhs, lhs)),
 469         BinOpKind::Mul // Not always commutative, e.g. with matrices. See issue #5698
 470         | BinOpKind::Shl
 471         | BinOpKind::Shr
 472         | BinOpKind::Rem
 473         | BinOpKind::Sub
 474         | BinOpKind::Div
 475         | BinOpKind::And
 476         | BinOpKind::Or => None,
 477     }
 478 }
 479
 480 /// Checks if the two `Option`s are both `None` or some equal values as per
 481 /// `eq_fn`.
 482 pub fn both<X>(l: &Option<X>, r: &Option<X>, mut eq_fn: impl FnMut(&X, &X) -> bool) -> bool {
 483     l.as_ref()
 484         .map_or_else(|| r.is_none(), |x| r.as_ref().map_or(false, |y| eq_fn(x, y)))
 485 }
 486
 487 /// Checks if two slices are equal as per `eq_fn`.
 488 pub fn over<X>(left: &[X], right: &[X], mut eq_fn: impl FnMut(&X, &X) -> bool) -> bool {
 489     left.len() == right.len() && left.iter().zip(right).all(|(x, y)| eq_fn(x, y))
 490 }
 491
 492 /// Counts how many elements of the slices are equal as per `eq_fn`.
 493 pub fn count_eq<X: Sized>(
 494     left: &mut dyn Iterator<Item = X>,
 495     right: &mut dyn Iterator<Item = X>,
 496     mut eq_fn: impl FnMut(&X, &X) -> bool,
 497 ) -> usize {
 498     left.zip(right).take_while(|(l, r)| eq_fn(l, r)).count()
 499 }
 500
 501 /// Checks if two expressions evaluate to the same value, and don't contain any side effects.
 502 pub fn eq_expr_value(cx: &LateContext<'_>, left: &Expr<'_>, right: &Expr<'_>) -> bool {
 503     SpanlessEq::new(cx).deny_side_effects().eq_expr(left, right)
 504 }
 505
 506 /// Type used to hash an ast element. This is different from the `Hash` trait
 507 /// on ast types as this
 508 /// trait would consider IDs and spans.
 509 ///
 510 /// All expressions kind are hashed, but some might have a weaker hash.
 511 pub struct SpanlessHash<'a, 'tcx> {
 512     /// Context used to evaluate constant expressions.
 513     cx: &'a LateContext<'tcx>,
 514     maybe_typeck_results: Option<&'tcx TypeckResults<'tcx>>,
 515     s: FxHasher,
 516 }
 517
 518 impl<'a, 'tcx> SpanlessHash<'a, 'tcx> {
 519     pub fn new(cx: &'a LateContext<'tcx>) -> Self {
 520         Self {
 521             cx,
 522             maybe_typeck_results: cx.maybe_typeck_results(),
 523             s: FxHasher::default(),
 524         }
 525     }
 526
 527     pub fn finish(self) -> u64 {
 528         self.s.finish()
 529     }
 530
 531     pub fn hash_block(&mut self, b: &Block<'_>) {
 532         for s in b.stmts {
 533             self.hash_stmt(s);
 534         }
 535
 536         if let Some(e) = b.expr {
 537             self.hash_expr(e);
 538         }
 539
 540         std::mem::discriminant(&b.rules).hash(&mut self.s);
 541     }
 542
 543     #[allow(clippy::too_many_lines)]
 544     pub fn hash_expr(&mut self, e: &Expr<'_>) {
 545         let simple_const = self
 546             .maybe_typeck_results
 547             .and_then(|typeck_results| constant_simple(self.cx, typeck_results, e));
 548
 549         // const hashing may result in the same hash as some unrelated node, so add a sort of
 550         // discriminant depending on which path we're choosing next
 551         simple_const.hash(&mut self.s);
 552         if simple_const.is_some() {
 553             return;
 554         }
 555
 556         std::mem::discriminant(&e.kind).hash(&mut self.s);
 557
 558         match e.kind {
 559             ExprKind::AddrOf(kind, m, e) => {
 560                 std::mem::discriminant(&kind).hash(&mut self.s);
 561                 m.hash(&mut self.s);
 562                 self.hash_expr(e);
 563             },
 564             ExprKind::Continue(i) => {
 565                 if let Some(i) = i.label {
 566                     self.hash_name(i.ident.name);
 567                 }
 568             },
 569             ExprKind::Assign(l, r, _) => {
 570                 self.hash_expr(l);
 571                 self.hash_expr(r);
 572             },
 573             ExprKind::AssignOp(ref o, l, r) => {
 574                 std::mem::discriminant(&o.node).hash(&mut self.s);
 575                 self.hash_expr(l);
 576                 self.hash_expr(r);
 577             },
 578             ExprKind::Block(b, _) => {
 579                 self.hash_block(b);
 580             },
 581             ExprKind::Binary(op, l, r) => {
 582                 std::mem::discriminant(&op.node).hash(&mut self.s);
 583                 self.hash_expr(l);
 584                 self.hash_expr(r);
 585             },
 586             ExprKind::Break(i, ref j) => {
 587                 if let Some(i) = i.label {
 588                     self.hash_name(i.ident.name);
 589                 }
 590                 if let Some(j) = *j {
 591                     self.hash_expr(&*j);
 592                 }
 593             },
 594             ExprKind::Box(e) | ExprKind::DropTemps(e) | ExprKind::Yield(e, _) => {
 595                 self.hash_expr(e);
 596             },
 597             ExprKind::Call(fun, args) => {
 598                 self.hash_expr(fun);
 599                 self.hash_exprs(args);
 600             },
 601             ExprKind::Cast(e, ty) | ExprKind::Type(e, ty) => {
 602                 self.hash_expr(e);
 603                 self.hash_ty(ty);
 604             },
 605             ExprKind::Closure(cap, _, eid, _, _) => {
 606                 std::mem::discriminant(&cap).hash(&mut self.s);
 607                 // closures inherit TypeckResults
 608                 self.hash_expr(&self.cx.tcx.hir().body(eid).value);
 609             },
 610             ExprKind::Field(e, ref f) => {
 611                 self.hash_expr(e);
 612                 self.hash_name(f.name);
 613             },
 614             ExprKind::Index(a, i) => {
 615                 self.hash_expr(a);
 616                 self.hash_expr(i);
 617             },
 618             ExprKind::InlineAsm(asm) => {
 619                 for piece in asm.template {
 620                     match piece {
 621                         InlineAsmTemplatePiece::String(s) => s.hash(&mut self.s),
 622                         InlineAsmTemplatePiece::Placeholder {
 623                             operand_idx,
 624                             modifier,
 625                             span: _,
 626                         } => {
 627                             operand_idx.hash(&mut self.s);
 628                             modifier.hash(&mut self.s);
 629                         },
 630                     }
 631                 }
 632                 asm.options.hash(&mut self.s);
 633                 for (op, _op_sp) in asm.operands {
 634                     match op {
 635                         InlineAsmOperand::In { reg, expr } => {
 636                             reg.hash(&mut self.s);
 637                             self.hash_expr(expr);
 638                         },
 639                         InlineAsmOperand::Out { reg, late, expr } => {
 640                             reg.hash(&mut self.s);
 641                             late.hash(&mut self.s);
 642                             if let Some(expr) = expr {
 643                                 self.hash_expr(expr);
 644                             }
 645                         },
 646                         InlineAsmOperand::InOut { reg, late, expr } => {
 647                             reg.hash(&mut self.s);
 648                             late.hash(&mut self.s);
 649                             self.hash_expr(expr);
 650                         },
 651                         InlineAsmOperand::SplitInOut {
 652                             reg,
 653                             late,
 654                             in_expr,
 655                             out_expr,
 656                         } => {
 657                             reg.hash(&mut self.s);
 658                             late.hash(&mut self.s);
 659                             self.hash_expr(in_expr);
 660                             if let Some(out_expr) = out_expr {
 661                                 self.hash_expr(out_expr);
 662                             }
 663                         },
 664                         InlineAsmOperand::Const { anon_const } => self.hash_body(anon_const.body),
 665                         InlineAsmOperand::Sym { expr } => self.hash_expr(expr),
 666                     }
 667                 }
 668             },
 669             ExprKind::Let(pat, expr, _) => {
 670                 self.hash_expr(expr);
 671                 self.hash_pat(pat);
 672             },
 673             ExprKind::LlvmInlineAsm(..) | ExprKind::Err => {},
 674             ExprKind::Lit(ref l) => {
 675                 l.node.hash(&mut self.s);
 676             },
 677             ExprKind::Loop(b, ref i, ..) => {
 678                 self.hash_block(b);
 679                 if let Some(i) = *i {
 680                     self.hash_name(i.ident.name);
 681                 }
 682             },
 683             ExprKind::If(cond, then, ref else_opt) => {
 684                 self.hash_expr(cond);
 685                 self.hash_expr(then);
 686                 if let Some(e) = *else_opt {
 687                     self.hash_expr(e);
 688                 }
 689             },
 690             ExprKind::Match(e, arms, ref s) => {
 691                 self.hash_expr(e);
 692
 693                 for arm in arms {
 694                     self.hash_pat(arm.pat);
 695                     if let Some(ref e) = arm.guard {
 696                         self.hash_guard(e);
 697                     }
 698                     self.hash_expr(arm.body);
 699                 }
 700
 701                 s.hash(&mut self.s);
 702             },
 703             ExprKind::MethodCall(path, ref _tys, args, ref _fn_span) => {
 704                 self.hash_name(path.ident.name);
 705                 self.hash_exprs(args);
 706             },
 707             ExprKind::ConstBlock(ref l_id) => {
 708                 self.hash_body(l_id.body);
 709             },
 710             ExprKind::Repeat(e, ref l_id) => {
 711                 self.hash_expr(e);
 712                 self.hash_body(l_id.body);
 713             },
 714             ExprKind::Ret(ref e) => {
 715                 if let Some(e) = *e {
 716                     self.hash_expr(e);
 717                 }
 718             },
 719             ExprKind::Path(ref qpath) => {
 720                 self.hash_qpath(qpath);
 721             },
 722             ExprKind::Struct(path, fields, ref expr) => {
 723                 self.hash_qpath(path);
 724
 725                 for f in fields {
 726                     self.hash_name(f.ident.name);
 727                     self.hash_expr(f.expr);
 728                 }
 729
 730                 if let Some(e) = *expr {
 731                     self.hash_expr(e);
 732                 }
 733             },
 734             ExprKind::Tup(tup) => {
 735                 self.hash_exprs(tup);
 736             },
 737             ExprKind::Array(v) => {
 738                 self.hash_exprs(v);
 739             },
 740             ExprKind::Unary(lop, le) => {
 741                 std::mem::discriminant(&lop).hash(&mut self.s);
 742                 self.hash_expr(le);
 743             },
 744         }
 745     }
 746
 747     pub fn hash_exprs(&mut self, e: &[Expr<'_>]) {
 748         for e in e {
 749             self.hash_expr(e);
 750         }
 751     }
 752
 753     pub fn hash_name(&mut self, n: Symbol) {
 754         n.hash(&mut self.s);
 755     }
 756
 757     pub fn hash_qpath(&mut self, p: &QPath<'_>) {
 758         match *p {
 759             QPath::Resolved(_, path) => {
 760                 self.hash_path(path);
 761             },
 762             QPath::TypeRelative(_, path) => {
 763                 self.hash_name(path.ident.name);
 764             },
 765             QPath::LangItem(lang_item, ..) => {
 766                 std::mem::discriminant(&lang_item).hash(&mut self.s);
 767             },
 768         }
 769         // self.maybe_typeck_results.unwrap().qpath_res(p, id).hash(&mut self.s);
 770     }
 771
 772     pub fn hash_pat(&mut self, pat: &Pat<'_>) {
 773         std::mem::discriminant(&pat.kind).hash(&mut self.s);
 774         match pat.kind {
 775             PatKind::Binding(ann, _, _, pat) => {
 776                 std::mem::discriminant(&ann).hash(&mut self.s);
 777                 if let Some(pat) = pat {
 778                     self.hash_pat(pat);
 779                 }
 780             },
 781             PatKind::Box(pat) => self.hash_pat(pat),
 782             PatKind::Lit(expr) => self.hash_expr(expr),
 783             PatKind::Or(pats) => {
 784                 for pat in pats {
 785                     self.hash_pat(pat);
 786                 }
 787             },
 788             PatKind::Path(ref qpath) => self.hash_qpath(qpath),
 789             PatKind::Range(s, e, i) => {
 790                 if let Some(s) = s {
 791                     self.hash_expr(s);
 792                 }
 793                 if let Some(e) = e {
 794                     self.hash_expr(e);
 795                 }
 796                 std::mem::discriminant(&i).hash(&mut self.s);
 797             },
 798             PatKind::Ref(pat, mu) => {
 799                 self.hash_pat(pat);
 800                 std::mem::discriminant(&mu).hash(&mut self.s);
 801             },
 802             PatKind::Slice(l, m, r) => {
 803                 for pat in l {
 804                     self.hash_pat(pat);
 805                 }
 806                 if let Some(pat) = m {
 807                     self.hash_pat(pat);
 808                 }
 809                 for pat in r {
 810                     self.hash_pat(pat);
 811                 }
 812             },
 813             PatKind::Struct(ref qpath, fields, e) => {
 814                 self.hash_qpath(qpath);
 815                 for f in fields {
 816                     self.hash_name(f.ident.name);
 817                     self.hash_pat(f.pat);
 818                 }
 819                 e.hash(&mut self.s);
 820             },
 821             PatKind::Tuple(pats, e) => {
 822                 for pat in pats {
 823                     self.hash_pat(pat);
 824                 }
 825                 e.hash(&mut self.s);
 826             },
 827             PatKind::TupleStruct(ref qpath, pats, e) => {
 828                 self.hash_qpath(qpath);
 829                 for pat in pats {
 830                     self.hash_pat(pat);
 831                 }
 832                 e.hash(&mut self.s);
 833             },
 834             PatKind::Wild => {},
 835         }
 836     }
 837
 838     pub fn hash_path(&mut self, path: &Path<'_>) {
 839         match path.res {
 840             // constant hash since equality is dependant on inter-expression context
 841             Res::Local(_) => 1_usize.hash(&mut self.s),
 842             _ => {
 843                 for seg in path.segments {
 844                     self.hash_name(seg.ident.name);
 845                     self.hash_generic_args(seg.args().args);
 846                 }
 847             },
 848         }
 849     }
 850
 851     pub fn hash_stmt(&mut self, b: &Stmt<'_>) {
 852         std::mem::discriminant(&b.kind).hash(&mut self.s);
 853
 854         match &b.kind {
 855             StmtKind::Local(local) => {
 856                 self.hash_pat(local.pat);
 857                 if let Some(init) = local.init {
 858                     self.hash_expr(init);
 859                 }
 860             },
 861             StmtKind::Item(..) => {},
 862             StmtKind::Expr(expr) | StmtKind::Semi(expr) => {
 863                 self.hash_expr(expr);
 864             },
 865         }
 866     }
 867
 868     pub fn hash_guard(&mut self, g: &Guard<'_>) {
 869         match g {
 870             Guard::If(expr) | Guard::IfLet(_, expr) => {
 871                 self.hash_expr(expr);
 872             },
 873         }
 874     }
 875
 876     pub fn hash_lifetime(&mut self, lifetime: Lifetime) {
 877         std::mem::discriminant(&lifetime.name).hash(&mut self.s);
 878         if let LifetimeName::Param(ref name) = lifetime.name {
 879             std::mem::discriminant(name).hash(&mut self.s);
 880             match name {
 881                 ParamName::Plain(ref ident) => {
 882                     ident.name.hash(&mut self.s);
 883                 },
 884                 ParamName::Fresh(ref size) => {
 885                     size.hash(&mut self.s);
 886                 },
 887                 ParamName::Error => {},
 888             }
 889         }
 890     }
 891
 892     pub fn hash_ty(&mut self, ty: &Ty<'_>) {
 893         std::mem::discriminant(&ty.kind).hash(&mut self.s);
 894         self.hash_tykind(&ty.kind);
 895     }
 896
 897     pub fn hash_tykind(&mut self, ty: &TyKind<'_>) {
 898         match ty {
 899             TyKind::Slice(ty) => {
 900                 self.hash_ty(ty);
 901             },
 902             TyKind::Array(ty, anon_const) => {
 903                 self.hash_ty(ty);
 904                 self.hash_body(anon_const.body);
 905             },
 906             TyKind::Ptr(ref mut_ty) => {
 907                 self.hash_ty(mut_ty.ty);
 908                 mut_ty.mutbl.hash(&mut self.s);
 909             },
 910             TyKind::Rptr(lifetime, ref mut_ty) => {
 911                 self.hash_lifetime(*lifetime);
 912                 self.hash_ty(mut_ty.ty);
 913                 mut_ty.mutbl.hash(&mut self.s);
 914             },
 915             TyKind::BareFn(bfn) => {
 916                 bfn.unsafety.hash(&mut self.s);
 917                 bfn.abi.hash(&mut self.s);
 918                 for arg in bfn.decl.inputs {
 919                     self.hash_ty(arg);
 920                 }
 921                 std::mem::discriminant(&bfn.decl.output).hash(&mut self.s);
 922                 match bfn.decl.output {
 923                     FnRetTy::DefaultReturn(_) => {},
 924                     FnRetTy::Return(ty) => {
 925                         self.hash_ty(ty);
 926                     },
 927                 }
 928                 bfn.decl.c_variadic.hash(&mut self.s);
 929             },
 930             TyKind::Tup(ty_list) => {
 931                 for ty in *ty_list {
 932                     self.hash_ty(ty);
 933                 }
 934             },
 935             TyKind::Path(ref qpath) => self.hash_qpath(qpath),
 936             TyKind::OpaqueDef(_, arg_list) => {
 937                 self.hash_generic_args(arg_list);
 938             },
 939             TyKind::TraitObject(_, lifetime, _) => {
 940                 self.hash_lifetime(*lifetime);
 941             },
 942             TyKind::Typeof(anon_const) => {
 943                 self.hash_body(anon_const.body);
 944             },
 945             TyKind::Err | TyKind::Infer | TyKind::Never => {},
 946         }
 947     }
 948
 949     pub fn hash_body(&mut self, body_id: BodyId) {
 950         // swap out TypeckResults when hashing a body
 951         let old_maybe_typeck_results = self.maybe_typeck_results.replace(self.cx.tcx.typeck_body(body_id));
 952         self.hash_expr(&self.cx.tcx.hir().body(body_id).value);
 953         self.maybe_typeck_results = old_maybe_typeck_results;
 954     }
 955
 956     fn hash_generic_args(&mut self, arg_list: &[GenericArg<'_>]) {
 957         for arg in arg_list {
 958             match *arg {
 959                 GenericArg::Lifetime(l) => self.hash_lifetime(l),
 960                 GenericArg::Type(ref ty) => self.hash_ty(ty),
 961                 GenericArg::Const(ref ca) => self.hash_body(ca.value.body),
 962                 GenericArg::Infer(ref inf) => self.hash_ty(&inf.to_ty()),
 963             }
 964         }
 965     }
 966 }