+use clippy_utils::diagnostics::{span_lint_and_sugg, span_lint_and_then};
+use clippy_utils::higher::VecArgs;
+use clippy_utils::source::snippet_opt;
+use clippy_utils::ty::is_type_diagnostic_item;
+use clippy_utils::usage::local_used_after_expr;
+use clippy_utils::{higher, is_adjusted, path_to_local, path_to_local_id};
use if_chain::if_chain;
-use matches::matches;
-use rustc::declare_lint_pass;
-use rustc::hir::*;
-use rustc::lint::{in_external_macro, LateContext, LateLintPass, LintArray, LintContext, LintPass};
-use rustc::ty::{self, Ty};
use rustc_errors::Applicability;
-use rustc_session::declare_tool_lint;
-
-use crate::utils::{
- implements_trait, is_adjusted, iter_input_pats, snippet_opt, span_lint_and_then, type_is_unsafe_function,
-};
+use rustc_hir::def_id::DefId;
+use rustc_hir::{Closure, Expr, ExprKind, Param, PatKind, Unsafety};
+use rustc_lint::{LateContext, LateLintPass};
+use rustc_middle::ty::adjustment::{Adjust, Adjustment, AutoBorrow};
+use rustc_middle::ty::binding::BindingMode;
+use rustc_middle::ty::subst::Subst;
+use rustc_middle::ty::{self, ClosureKind, Ty, TypeVisitable};
+use rustc_session::{declare_lint_pass, declare_tool_lint};
+use rustc_span::symbol::sym;
declare_clippy_lint! {
- /// **What it does:** Checks for closures which just call another function where
+ /// ### What it does
+ /// Checks for closures which just call another function where
/// the function can be called directly. `unsafe` functions or calls where types
/// get adjusted are ignored.
///
- /// **Why is this bad?** Needlessly creating a closure adds code for no benefit
+ /// ### Why is this bad?
+ /// Needlessly creating a closure adds code for no benefit
/// and gives the optimizer more work.
///
- /// **Known problems:** If creating the closure inside the closure has a side-
+ /// ### Known problems
+ /// If creating the closure inside the closure has a side-
/// effect then moving the closure creation out will change when that side-
/// effect runs.
- /// See rust-lang/rust-clippy#1439 for more details.
+ /// See [#1439](https://github.com/rust-lang/rust-clippy/issues/1439) for more details.
///
- /// **Example:**
+ /// ### Example
/// ```rust,ignore
/// xs.map(|x| foo(x))
/// ```
- /// where `foo(_)` is a plain function that takes the exact argument type of
- /// `x`.
+ ///
+ /// Use instead:
+ /// ```rust,ignore
+ /// // where `foo(_)` is a plain function that takes the exact argument type of `x`.
+ /// xs.map(foo)
+ /// ```
+ #[clippy::version = "pre 1.29.0"]
pub REDUNDANT_CLOSURE,
style,
"redundant closures, i.e., `|a| foo(a)` (which can be written as just `foo`)"
}
declare_clippy_lint! {
- /// **What it does:** Checks for closures which only invoke a method on the closure
+ /// ### What it does
+ /// Checks for closures which only invoke a method on the closure
/// argument and can be replaced by referencing the method directly.
///
- /// **Why is this bad?** It's unnecessary to create the closure.
- ///
- /// **Known problems:** rust-lang/rust-clippy#3071, rust-lang/rust-clippy#4002,
- /// rust-lang/rust-clippy#3942
- ///
+ /// ### Why is this bad?
+ /// It's unnecessary to create the closure.
///
- /// **Example:**
+ /// ### Example
/// ```rust,ignore
/// Some('a').map(|s| s.to_uppercase());
/// ```
/// ```rust,ignore
/// Some('a').map(char::to_uppercase);
/// ```
+ #[clippy::version = "1.35.0"]
pub REDUNDANT_CLOSURE_FOR_METHOD_CALLS,
pedantic,
"redundant closures for method calls"
declare_lint_pass!(EtaReduction => [REDUNDANT_CLOSURE, REDUNDANT_CLOSURE_FOR_METHOD_CALLS]);
-impl<'a, 'tcx> LateLintPass<'a, 'tcx> for EtaReduction {
- fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>) {
- if in_external_macro(cx.sess(), expr.span) {
+impl<'tcx> LateLintPass<'tcx> for EtaReduction {
+ fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
+ if expr.span.from_expansion() {
return;
}
-
- match expr.kind {
- ExprKind::Call(_, args) | ExprKind::MethodCall(_, _, args) => {
- for arg in args {
- check_closure(cx, arg)
+ let body = match expr.kind {
+ ExprKind::Closure(&Closure { body, .. }) => cx.tcx.hir().body(body),
+ _ => return,
+ };
+ if body.value.span.from_expansion() {
+ if body.params.is_empty() {
+ if let Some(VecArgs::Vec(&[])) = higher::VecArgs::hir(cx, &body.value) {
+ // replace `|| vec![]` with `Vec::new`
+ span_lint_and_sugg(
+ cx,
+ REDUNDANT_CLOSURE,
+ expr.span,
+ "redundant closure",
+ "replace the closure with `Vec::new`",
+ "std::vec::Vec::new".into(),
+ Applicability::MachineApplicable,
+ );
}
- },
- _ => (),
+ }
+ // skip `foo(|| macro!())`
+ return;
}
- }
-}
-fn check_closure(cx: &LateContext<'_, '_>, expr: &Expr<'_>) {
- if let ExprKind::Closure(_, ref decl, eid, _, _) = expr.kind {
- let body = cx.tcx.hir().body(eid);
- let ex = &body.value;
+ let closure_ty = cx.typeck_results().expr_ty(expr);
if_chain!(
- if let ExprKind::Call(ref caller, ref args) = ex.kind;
-
- if let ExprKind::Path(_) = caller.kind;
-
- // Not the same number of arguments, there is no way the closure is the same as the function return;
- if args.len() == decl.inputs.len();
-
- // Are the expression or the arguments type-adjusted? Then we need the closure
- if !(is_adjusted(cx, ex) || args.iter().any(|arg| is_adjusted(cx, arg)));
-
- let fn_ty = cx.tables.expr_ty(caller);
-
- if matches!(fn_ty.kind, ty::FnDef(_, _) | ty::FnPtr(_) | ty::Closure(_, _));
-
- if !type_is_unsafe_function(cx, fn_ty);
-
- if compare_inputs(&mut iter_input_pats(decl, body), &mut args.iter());
-
+ if !is_adjusted(cx, &body.value);
+ if let ExprKind::Call(callee, args) = body.value.kind;
+ if let ExprKind::Path(_) = callee.kind;
+ if check_inputs(cx, body.params, args);
+ let callee_ty = cx.typeck_results().expr_ty_adjusted(callee);
+ let call_ty = cx.typeck_results().type_dependent_def_id(body.value.hir_id)
+ .map_or(callee_ty, |id| cx.tcx.type_of(id));
+ if check_sig(cx, closure_ty, call_ty);
+ let substs = cx.typeck_results().node_substs(callee.hir_id);
+ // This fixes some false positives that I don't entirely understand
+ if substs.is_empty() || !cx.typeck_results().expr_ty(expr).has_late_bound_regions();
+ // A type param function ref like `T::f` is not 'static, however
+ // it is if cast like `T::f as fn()`. This seems like a rustc bug.
+ if !substs.types().any(|t| matches!(t.kind(), ty::Param(_)));
+ let callee_ty_unadjusted = cx.typeck_results().expr_ty(callee).peel_refs();
+ if !is_type_diagnostic_item(cx, callee_ty_unadjusted, sym::Arc);
+ if !is_type_diagnostic_item(cx, callee_ty_unadjusted, sym::Rc);
then {
- span_lint_and_then(cx, REDUNDANT_CLOSURE, expr.span, "redundant closure found", |db| {
- if let Some(snippet) = snippet_opt(cx, caller.span) {
- db.span_suggestion(
+ span_lint_and_then(cx, REDUNDANT_CLOSURE, expr.span, "redundant closure", |diag| {
+ if let Some(mut snippet) = snippet_opt(cx, callee.span) {
+ if_chain! {
+ if let ty::Closure(_, substs) = callee_ty.peel_refs().kind();
+ if substs.as_closure().kind() == ClosureKind::FnMut;
+ if path_to_local(callee).map_or(false, |l| local_used_after_expr(cx, l, expr));
+
+ then {
+ // Mutable closure is used after current expr; we cannot consume it.
+ snippet = format!("&mut {}", snippet);
+ }
+ }
+ diag.span_suggestion(
expr.span,
- "remove closure as shown",
+ "replace the closure with the function itself",
snippet,
Applicability::MachineApplicable,
);
);
if_chain!(
- if let ExprKind::MethodCall(ref path, _, ref args) = ex.kind;
-
- // Not the same number of arguments, there is no way the closure is the same as the function return;
- if args.len() == decl.inputs.len();
-
- // Are the expression or the arguments type-adjusted? Then we need the closure
- if !(is_adjusted(cx, ex) || args.iter().skip(1).any(|arg| is_adjusted(cx, arg)));
-
- let method_def_id = cx.tables.type_dependent_def_id(ex.hir_id).unwrap();
- if !type_is_unsafe_function(cx, cx.tcx.type_of(method_def_id));
-
- if compare_inputs(&mut iter_input_pats(decl, body), &mut args.iter());
-
- if let Some(name) = get_ufcs_type_name(cx, method_def_id, &args[0]);
-
+ if !is_adjusted(cx, &body.value);
+ if let ExprKind::MethodCall(path, args, _) = body.value.kind;
+ if check_inputs(cx, body.params, args);
+ let method_def_id = cx.typeck_results().type_dependent_def_id(body.value.hir_id).unwrap();
+ let substs = cx.typeck_results().node_substs(body.value.hir_id);
+ let call_ty = cx.tcx.bound_type_of(method_def_id).subst(cx.tcx, substs);
+ if check_sig(cx, closure_ty, call_ty);
then {
- span_lint_and_then(cx, REDUNDANT_CLOSURE_FOR_METHOD_CALLS, expr.span, "redundant closure found", |db| {
- db.span_suggestion(
+ span_lint_and_then(cx, REDUNDANT_CLOSURE_FOR_METHOD_CALLS, expr.span, "redundant closure", |diag| {
+ let name = get_ufcs_type_name(cx, method_def_id);
+ diag.span_suggestion(
expr.span,
- "remove closure as shown",
+ "replace the closure with the method itself",
format!("{}::{}", name, path.ident.name),
Applicability::MachineApplicable,
);
- });
+ })
}
);
}
}
-/// Tries to determine the type for universal function call to be used instead of the closure
-fn get_ufcs_type_name(cx: &LateContext<'_, '_>, method_def_id: def_id::DefId, self_arg: &Expr<'_>) -> Option<String> {
- let expected_type_of_self = &cx.tcx.fn_sig(method_def_id).inputs_and_output().skip_binder()[0];
- let actual_type_of_self = &cx.tables.node_type(self_arg.hir_id);
-
- if let Some(trait_id) = cx.tcx.trait_of_item(method_def_id) {
- if match_borrow_depth(expected_type_of_self, &actual_type_of_self)
- && implements_trait(cx, actual_type_of_self, trait_id, &[])
- {
- return Some(cx.tcx.def_path_str(trait_id));
- }
+fn check_inputs(cx: &LateContext<'_>, params: &[Param<'_>], call_args: &[Expr<'_>]) -> bool {
+ if params.len() != call_args.len() {
+ return false;
}
+ let binding_modes = cx.typeck_results().pat_binding_modes();
+ std::iter::zip(params, call_args).all(|(param, arg)| {
+ match param.pat.kind {
+ PatKind::Binding(_, id, ..) if path_to_local_id(arg, id) => {},
+ _ => return false,
+ }
+ // checks that parameters are not bound as `ref` or `ref mut`
+ if let Some(BindingMode::BindByReference(_)) = binding_modes.get(param.pat.hir_id) {
+ return false;
+ }
- cx.tcx.impl_of_method(method_def_id).and_then(|_| {
- //a type may implicitly implement other type's methods (e.g. Deref)
- if match_types(expected_type_of_self, &actual_type_of_self) {
- return Some(get_type_name(cx, &actual_type_of_self));
+ match *cx.typeck_results().expr_adjustments(arg) {
+ [] => true,
+ [
+ Adjustment {
+ kind: Adjust::Deref(None),
+ ..
+ },
+ Adjustment {
+ kind: Adjust::Borrow(AutoBorrow::Ref(_, mu2)),
+ ..
+ },
+ ] => {
+ // re-borrow with the same mutability is allowed
+ let ty = cx.typeck_results().expr_ty(arg);
+ matches!(*ty.kind(), ty::Ref(.., mu1) if mu1 == mu2.into())
+ },
+ _ => false,
}
- None
})
}
-fn match_borrow_depth(lhs: Ty<'_>, rhs: Ty<'_>) -> bool {
- match (&lhs.kind, &rhs.kind) {
- (ty::Ref(_, t1, mut1), ty::Ref(_, t2, mut2)) => mut1 == mut2 && match_borrow_depth(&t1, &t2),
- (l, r) => match (l, r) {
- (ty::Ref(_, _, _), _) | (_, ty::Ref(_, _, _)) => false,
- (_, _) => true,
- },
- }
-}
-
-fn match_types(lhs: Ty<'_>, rhs: Ty<'_>) -> bool {
- match (&lhs.kind, &rhs.kind) {
- (ty::Bool, ty::Bool)
- | (ty::Char, ty::Char)
- | (ty::Int(_), ty::Int(_))
- | (ty::Uint(_), ty::Uint(_))
- | (ty::Str, ty::Str) => true,
- (ty::Ref(_, t1, mut1), ty::Ref(_, t2, mut2)) => mut1 == mut2 && match_types(t1, t2),
- (ty::Array(t1, _), ty::Array(t2, _)) | (ty::Slice(t1), ty::Slice(t2)) => match_types(t1, t2),
- (ty::Adt(def1, _), ty::Adt(def2, _)) => def1 == def2,
- (_, _) => false,
+fn check_sig<'tcx>(cx: &LateContext<'tcx>, closure_ty: Ty<'tcx>, call_ty: Ty<'tcx>) -> bool {
+ let call_sig = call_ty.fn_sig(cx.tcx);
+ if call_sig.unsafety() == Unsafety::Unsafe {
+ return false;
}
-}
-
-fn get_type_name(cx: &LateContext<'_, '_>, ty: Ty<'_>) -> String {
- match ty.kind {
- ty::Adt(t, _) => cx.tcx.def_path_str(t.did),
- ty::Ref(_, r, _) => get_type_name(cx, &r),
- _ => ty.to_string(),
+ if !closure_ty.has_late_bound_regions() {
+ return true;
}
+ let substs = match closure_ty.kind() {
+ ty::Closure(_, substs) => substs,
+ _ => return false,
+ };
+ let closure_sig = cx.tcx.signature_unclosure(substs.as_closure().sig(), Unsafety::Normal);
+ cx.tcx.erase_late_bound_regions(closure_sig) == cx.tcx.erase_late_bound_regions(call_sig)
}
-fn compare_inputs(
- closure_inputs: &mut dyn Iterator<Item = &Param<'_>>,
- call_args: &mut dyn Iterator<Item = &Expr<'_>>,
-) -> bool {
- for (closure_input, function_arg) in closure_inputs.zip(call_args) {
- if let PatKind::Binding(_, _, ident, _) = closure_input.pat.kind {
- // XXXManishearth Should I be checking the binding mode here?
- if let ExprKind::Path(QPath::Resolved(None, ref p)) = function_arg.kind {
- if p.segments.len() != 1 {
- // If it's a proper path, it can't be a local variable
- return false;
- }
- if p.segments[0].ident.name != ident.name {
- // The two idents should be the same
- return false;
- }
- } else {
- return false;
+fn get_ufcs_type_name(cx: &LateContext<'_>, method_def_id: DefId) -> String {
+ match cx.tcx.associated_item(method_def_id).container {
+ ty::TraitContainer(def_id) => cx.tcx.def_path_str(def_id),
+ ty::ImplContainer(def_id) => {
+ let ty = cx.tcx.type_of(def_id);
+ match ty.kind() {
+ ty::Adt(adt, _) => cx.tcx.def_path_str(adt.did()),
+ _ => ty.to_string(),
}
- } else {
- return false;
- }
+ },
}
- true
}