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};
10 implements_trait, is_adjusted, iter_input_pats, snippet_opt, span_lint_and_sugg, span_lint_and_then,
11 type_is_unsafe_function,
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.
19 /// **Why is this bad?** Needlessly creating a closure adds code for no benefit
20 /// and gives the optimizer more work.
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-
25 /// See rust-lang/rust-clippy#1439 for more details.
29 /// xs.map(|x| foo(x))
31 /// where `foo(_)` is a plain function that takes the exact argument type of
33 pub REDUNDANT_CLOSURE,
35 "redundant closures, i.e., `|a| foo(a)` (which can be written as just `foo`)"
38 declare_clippy_lint! {
39 /// **What it does:** Checks for closures which only invoke a method on the closure
40 /// argument and can be replaced by referencing the method directly.
42 /// **Why is this bad?** It's unnecessary to create the closure.
44 /// **Known problems:** rust-lang/rust-clippy#3071, rust-lang/rust-clippy#4002,
45 /// rust-lang/rust-clippy#3942
50 /// Some('a').map(|s| s.to_uppercase());
52 /// may be rewritten as
54 /// Some('a').map(char::to_uppercase);
56 pub REDUNDANT_CLOSURE_FOR_METHOD_CALLS,
58 "redundant closures for method calls"
61 declare_lint_pass!(EtaReduction => [REDUNDANT_CLOSURE, REDUNDANT_CLOSURE_FOR_METHOD_CALLS]);
63 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for EtaReduction {
64 fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>) {
65 if in_external_macro(cx.sess(), expr.span) {
70 ExprKind::Call(_, args) | ExprKind::MethodCall(_, _, args) => {
72 check_closure(cx, arg)
80 fn check_closure(cx: &LateContext<'_, '_>, expr: &Expr<'_>) {
81 if let ExprKind::Closure(_, ref decl, eid, _, _) = expr.kind {
82 let body = cx.tcx.hir().body(eid);
86 if let ExprKind::Call(ref caller, ref args) = ex.kind;
88 if let ExprKind::Path(_) = caller.kind;
90 // Not the same number of arguments, there is no way the closure is the same as the function return;
91 if args.len() == decl.inputs.len();
93 // Are the expression or the arguments type-adjusted? Then we need the closure
94 if !(is_adjusted(cx, ex) || args.iter().any(|arg| is_adjusted(cx, arg)));
96 let fn_ty = cx.tables.expr_ty(caller);
98 if matches!(fn_ty.kind, ty::FnDef(_, _) | ty::FnPtr(_) | ty::Closure(_, _));
100 if !type_is_unsafe_function(cx, fn_ty);
102 if compare_inputs(&mut iter_input_pats(decl, body), &mut args.iter());
105 span_lint_and_then(cx, REDUNDANT_CLOSURE, expr.span, "redundant closure found", |diag| {
106 if let Some(snippet) = snippet_opt(cx, caller.span) {
107 diag.span_suggestion(
109 "remove closure as shown",
111 Applicability::MachineApplicable,
119 if let ExprKind::MethodCall(ref path, _, ref args) = ex.kind;
121 // Not the same number of arguments, there is no way the closure is the same as the function return;
122 if args.len() == decl.inputs.len();
124 // Are the expression or the arguments type-adjusted? Then we need the closure
125 if !(is_adjusted(cx, ex) || args.iter().skip(1).any(|arg| is_adjusted(cx, arg)));
127 let method_def_id = cx.tables.type_dependent_def_id(ex.hir_id).unwrap();
128 if !type_is_unsafe_function(cx, cx.tcx.type_of(method_def_id));
130 if compare_inputs(&mut iter_input_pats(decl, body), &mut args.iter());
132 if let Some(name) = get_ufcs_type_name(cx, method_def_id, &args[0]);
137 REDUNDANT_CLOSURE_FOR_METHOD_CALLS,
139 "redundant closure found",
140 "remove closure as shown",
141 format!("{}::{}", name, path.ident.name),
142 Applicability::MachineApplicable,
149 /// Tries to determine the type for universal function call to be used instead of the closure
150 fn get_ufcs_type_name(cx: &LateContext<'_, '_>, method_def_id: def_id::DefId, self_arg: &Expr<'_>) -> Option<String> {
151 let expected_type_of_self = &cx.tcx.fn_sig(method_def_id).inputs_and_output().skip_binder()[0];
152 let actual_type_of_self = &cx.tables.node_type(self_arg.hir_id);
154 if let Some(trait_id) = cx.tcx.trait_of_item(method_def_id) {
155 if match_borrow_depth(expected_type_of_self, &actual_type_of_self)
156 && implements_trait(cx, actual_type_of_self, trait_id, &[])
158 return Some(cx.tcx.def_path_str(trait_id));
162 cx.tcx.impl_of_method(method_def_id).and_then(|_| {
163 //a type may implicitly implement other type's methods (e.g. Deref)
164 if match_types(expected_type_of_self, &actual_type_of_self) {
165 return Some(get_type_name(cx, &actual_type_of_self));
171 fn match_borrow_depth(lhs: Ty<'_>, rhs: Ty<'_>) -> bool {
172 match (&lhs.kind, &rhs.kind) {
173 (ty::Ref(_, t1, mut1), ty::Ref(_, t2, mut2)) => mut1 == mut2 && match_borrow_depth(&t1, &t2),
174 (l, r) => match (l, r) {
175 (ty::Ref(_, _, _), _) | (_, ty::Ref(_, _, _)) => false,
181 fn match_types(lhs: Ty<'_>, rhs: Ty<'_>) -> bool {
182 match (&lhs.kind, &rhs.kind) {
184 | (ty::Char, ty::Char)
185 | (ty::Int(_), ty::Int(_))
186 | (ty::Uint(_), ty::Uint(_))
187 | (ty::Str, ty::Str) => true,
188 (ty::Ref(_, t1, mut1), ty::Ref(_, t2, mut2)) => mut1 == mut2 && match_types(t1, t2),
189 (ty::Array(t1, _), ty::Array(t2, _)) | (ty::Slice(t1), ty::Slice(t2)) => match_types(t1, t2),
190 (ty::Adt(def1, _), ty::Adt(def2, _)) => def1 == def2,
195 fn get_type_name(cx: &LateContext<'_, '_>, ty: Ty<'_>) -> String {
197 ty::Adt(t, _) => cx.tcx.def_path_str(t.did),
198 ty::Ref(_, r, _) => get_type_name(cx, &r),
204 closure_inputs: &mut dyn Iterator<Item = &Param<'_>>,
205 call_args: &mut dyn Iterator<Item = &Expr<'_>>,
207 for (closure_input, function_arg) in closure_inputs.zip(call_args) {
208 if let PatKind::Binding(_, _, ident, _) = closure_input.pat.kind {
209 // XXXManishearth Should I be checking the binding mode here?
210 if let ExprKind::Path(QPath::Resolved(None, ref p)) = function_arg.kind {
211 if p.segments.len() != 1 {
212 // If it's a proper path, it can't be a local variable
215 if p.segments[0].ident.name != ident.name {
216 // The two idents should be the same