clippy_lints/src/eta_reduction.rs

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