clippy_lints/src/eta_reduction.rs

   1 use if_chain::if_chain;
   2 use rustc_errors::Applicability;
   3 use rustc_hir::{def_id, Expr, ExprKind, Param, PatKind, QPath};
   4 use rustc_lint::{LateContext, LateLintPass, LintContext};
   5 use rustc_middle::lint::in_external_macro;
   6 use rustc_middle::ty::{self, Ty};
   7 use rustc_session::{declare_lint_pass, declare_tool_lint};
   8
   9 use crate::utils::{
  10     implements_trait, is_adjusted, iter_input_pats, snippet_opt, span_lint_and_sugg, span_lint_and_then,
  11     type_is_unsafe_function,
  12 };
  13
  14 declare_clippy_lint! {
  15     /// **What it does:** Checks for closures which just call another function where
  16     /// the function can be called directly. `unsafe` functions or calls where types
  17     /// get adjusted are ignored.
  18     ///
  19     /// **Why is this bad?** Needlessly creating a closure adds code for no benefit
  20     /// and gives the optimizer more work.
  21     ///
  22     /// **Known problems:** If creating the closure inside the closure has a side-
  23     /// effect then moving the closure creation out will change when that side-
  24     /// effect runs.
  25     /// See rust-lang/rust-clippy#1439 for more details.
  26     ///
  27     /// **Example:**
  28     /// ```rust,ignore
  29     /// // Bad
  30     /// xs.map(|x| foo(x))
  31     ///
  32     /// // Good
  33     /// xs.map(foo)
  34     /// ```
  35     /// where `foo(_)` is a plain function that takes the exact argument type of
  36     /// `x`.
  37     pub REDUNDANT_CLOSURE,
  38     style,
  39     "redundant closures, i.e., `|a| foo(a)` (which can be written as just `foo`)"
  40 }
  41
  42 declare_clippy_lint! {
  43     /// **What it does:** Checks for closures which only invoke a method on the closure
  44     /// argument and can be replaced by referencing the method directly.
  45     ///
  46     /// **Why is this bad?** It's unnecessary to create the closure.
  47     ///
  48     /// **Known problems:** rust-lang/rust-clippy#3071, rust-lang/rust-clippy#4002,
  49     /// rust-lang/rust-clippy#3942
  50     ///
  51     ///
  52     /// **Example:**
  53     /// ```rust,ignore
  54     /// Some('a').map(|s| s.to_uppercase());
  55     /// ```
  56     /// may be rewritten as
  57     /// ```rust,ignore
  58     /// Some('a').map(char::to_uppercase);
  59     /// ```
  60     pub REDUNDANT_CLOSURE_FOR_METHOD_CALLS,
  61     pedantic,
  62     "redundant closures for method calls"
  63 }
  64
  65 declare_lint_pass!(EtaReduction => [REDUNDANT_CLOSURE, REDUNDANT_CLOSURE_FOR_METHOD_CALLS]);
  66
  67 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for EtaReduction {
  68     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>) {
  69         if in_external_macro(cx.sess(), expr.span) {
  70             return;
  71         }
  72
  73         match expr.kind {
  74             ExprKind::Call(_, args) | ExprKind::MethodCall(_, _, args, _) => {
  75                 for arg in args {
  76                     check_closure(cx, arg)
  77                 }
  78             },
  79             _ => (),
  80         }
  81     }
  82 }
  83
  84 fn check_closure(cx: &LateContext<'_, '_>, expr: &Expr<'_>) {
  85     if let ExprKind::Closure(_, ref decl, eid, _, _) = expr.kind {
  86         let body = cx.tcx.hir().body(eid);
  87         let ex = &body.value;
  88
  89         if_chain!(
  90             if let ExprKind::Call(ref caller, ref args) = ex.kind;
  91
  92             if let ExprKind::Path(_) = caller.kind;
  93
  94             // Not the same number of arguments, there is no way the closure is the same as the function return;
  95             if args.len() == decl.inputs.len();
  96
  97             // Are the expression or the arguments type-adjusted? Then we need the closure
  98             if !(is_adjusted(cx, ex) || args.iter().any(|arg| is_adjusted(cx, arg)));
  99
 100             let fn_ty = cx.tables().expr_ty(caller);
 101
 102             if matches!(fn_ty.kind, ty::FnDef(_, _) | ty::FnPtr(_) | ty::Closure(_, _));
 103
 104             if !type_is_unsafe_function(cx, fn_ty);
 105
 106             if compare_inputs(&mut iter_input_pats(decl, body), &mut args.iter());
 107
 108             then {
 109                 span_lint_and_then(cx, REDUNDANT_CLOSURE, expr.span, "redundant closure found", |diag| {
 110                     if let Some(snippet) = snippet_opt(cx, caller.span) {
 111                         diag.span_suggestion(
 112                             expr.span,
 113                             "remove closure as shown",
 114                             snippet,
 115                             Applicability::MachineApplicable,
 116                         );
 117                     }
 118                 });
 119             }
 120         );
 121
 122         if_chain!(
 123             if let ExprKind::MethodCall(ref path, _, ref args, _) = ex.kind;
 124
 125             // Not the same number of arguments, there is no way the closure is the same as the function return;
 126             if args.len() == decl.inputs.len();
 127
 128             // Are the expression or the arguments type-adjusted? Then we need the closure
 129             if !(is_adjusted(cx, ex) || args.iter().skip(1).any(|arg| is_adjusted(cx, arg)));
 130
 131             let method_def_id = cx.tables().type_dependent_def_id(ex.hir_id).unwrap();
 132             if !type_is_unsafe_function(cx, cx.tcx.type_of(method_def_id));
 133
 134             if compare_inputs(&mut iter_input_pats(decl, body), &mut args.iter());
 135
 136             if let Some(name) = get_ufcs_type_name(cx, method_def_id, &args[0]);
 137
 138             then {
 139                 span_lint_and_sugg(
 140                     cx,
 141                     REDUNDANT_CLOSURE_FOR_METHOD_CALLS,
 142                     expr.span,
 143                     "redundant closure found",
 144                     "remove closure as shown",
 145                     format!("{}::{}", name, path.ident.name),
 146                     Applicability::MachineApplicable,
 147                 );
 148             }
 149         );
 150     }
 151 }
 152
 153 /// Tries to determine the type for universal function call to be used instead of the closure
 154 fn get_ufcs_type_name(cx: &LateContext<'_, '_>, method_def_id: def_id::DefId, self_arg: &Expr<'_>) -> Option<String> {
 155     let expected_type_of_self = &cx.tcx.fn_sig(method_def_id).inputs_and_output().skip_binder()[0];
 156     let actual_type_of_self = &cx.tables().node_type(self_arg.hir_id);
 157
 158     if let Some(trait_id) = cx.tcx.trait_of_item(method_def_id) {
 159         if match_borrow_depth(expected_type_of_self, &actual_type_of_self)
 160             && implements_trait(cx, actual_type_of_self, trait_id, &[])
 161         {
 162             return Some(cx.tcx.def_path_str(trait_id));
 163         }
 164     }
 165
 166     cx.tcx.impl_of_method(method_def_id).and_then(|_| {
 167         //a type may implicitly implement other type's methods (e.g. Deref)
 168         if match_types(expected_type_of_self, &actual_type_of_self) {
 169             return Some(get_type_name(cx, &actual_type_of_self));
 170         }
 171         None
 172     })
 173 }
 174
 175 fn match_borrow_depth(lhs: Ty<'_>, rhs: Ty<'_>) -> bool {
 176     match (&lhs.kind, &rhs.kind) {
 177         (ty::Ref(_, t1, mut1), ty::Ref(_, t2, mut2)) => mut1 == mut2 && match_borrow_depth(&t1, &t2),
 178         (l, r) => match (l, r) {
 179             (ty::Ref(_, _, _), _) | (_, ty::Ref(_, _, _)) => false,
 180             (_, _) => true,
 181         },
 182     }
 183 }
 184
 185 fn match_types(lhs: Ty<'_>, rhs: Ty<'_>) -> bool {
 186     match (&lhs.kind, &rhs.kind) {
 187         (ty::Bool, ty::Bool)
 188         | (ty::Char, ty::Char)
 189         | (ty::Int(_), ty::Int(_))
 190         | (ty::Uint(_), ty::Uint(_))
 191         | (ty::Str, ty::Str) => true,
 192         (ty::Ref(_, t1, mut1), ty::Ref(_, t2, mut2)) => mut1 == mut2 && match_types(t1, t2),
 193         (ty::Array(t1, _), ty::Array(t2, _)) | (ty::Slice(t1), ty::Slice(t2)) => match_types(t1, t2),
 194         (ty::Adt(def1, _), ty::Adt(def2, _)) => def1 == def2,
 195         (_, _) => false,
 196     }
 197 }
 198
 199 fn get_type_name(cx: &LateContext<'_, '_>, ty: Ty<'_>) -> String {
 200     match ty.kind {
 201         ty::Adt(t, _) => cx.tcx.def_path_str(t.did),
 202         ty::Ref(_, r, _) => get_type_name(cx, &r),
 203         _ => ty.to_string(),
 204     }
 205 }
 206
 207 fn compare_inputs(
 208     closure_inputs: &mut dyn Iterator<Item = &Param<'_>>,
 209     call_args: &mut dyn Iterator<Item = &Expr<'_>>,
 210 ) -> bool {
 211     for (closure_input, function_arg) in closure_inputs.zip(call_args) {
 212         if let PatKind::Binding(_, _, ident, _) = closure_input.pat.kind {
 213             // XXXManishearth Should I be checking the binding mode here?
 214             if let ExprKind::Path(QPath::Resolved(None, ref p)) = function_arg.kind {
 215                 if p.segments.len() != 1 {
 216                     // If it's a proper path, it can't be a local variable
 217                     return false;
 218                 }
 219                 if p.segments[0].ident.name != ident.name {
 220                     // The two idents should be the same
 221                     return false;
 222                 }
 223             } else {
 224                 return false;
 225             }
 226         } else {
 227             return false;
 228         }
 229     }
 230     true
 231 }