use clippy_utils::diagnostics::{span_lint_and_help, span_lint_and_sugg}; use clippy_utils::source::{snippet, snippet_with_applicability}; use clippy_utils::ty::is_type_diagnostic_item; use clippy_utils::{get_parent_expr_for_hir, is_trait_method, strip_pat_refs}; use if_chain::if_chain; use rustc_errors::Applicability; use rustc_hir as hir; use rustc_hir::{self, Expr, ExprKind, HirId, PatKind}; use rustc_infer::infer::TyCtxtInferExt; use rustc_lint::LateContext; use rustc_middle::hir::place::ProjectionKind; use rustc_middle::mir::{FakeReadCause, Mutability}; use rustc_middle::ty; use rustc_span::source_map::{BytePos, Span}; use rustc_span::symbol::sym; use rustc_typeck::expr_use_visitor::{Delegate, ExprUseVisitor, PlaceBase, PlaceWithHirId}; use super::SEARCH_IS_SOME; /// lint searching an Iterator followed by `is_some()` /// or calling `find()` on a string followed by `is_some()` or `is_none()` #[allow(clippy::too_many_arguments, clippy::too_many_lines)] pub(super) fn check<'tcx>( cx: &LateContext<'_>, expr: &'tcx hir::Expr<'_>, search_method: &str, is_some: bool, search_recv: &hir::Expr<'_>, search_arg: &'tcx hir::Expr<'_>, is_some_recv: &hir::Expr<'_>, method_span: Span, ) { let option_check_method = if is_some { "is_some" } else { "is_none" }; // lint if caller of search is an Iterator if is_trait_method(cx, is_some_recv, sym::Iterator) { let msg = format!( "called `{}()` after searching an `Iterator` with `{}`", option_check_method, search_method ); let search_snippet = snippet(cx, search_arg.span, ".."); if search_snippet.lines().count() <= 1 { // suggest `any(|x| ..)` instead of `any(|&x| ..)` for `find(|&x| ..).is_some()` // suggest `any(|..| *..)` instead of `any(|..| **..)` for `find(|..| **..).is_some()` let any_search_snippet = if_chain! { if search_method == "find"; if let hir::ExprKind::Closure(_, _, body_id, ..) = search_arg.kind; let closure_body = cx.tcx.hir().body(body_id); if let Some(closure_arg) = closure_body.params.get(0); then { if let hir::PatKind::Ref(..) = closure_arg.pat.kind { Some(search_snippet.replacen('&', "", 1)) } else if let PatKind::Binding(..) = strip_pat_refs(closure_arg.pat).kind { get_closure_suggestion(cx, search_arg, closure_body) .or_else(|| Some(search_snippet.to_string())) } else { None } } else { None } }; // add note if not multi-line if is_some { span_lint_and_sugg( cx, SEARCH_IS_SOME, method_span.with_hi(expr.span.hi()), &msg, "use `any()` instead", format!( "any({})", any_search_snippet.as_ref().map_or(&*search_snippet, String::as_str) ), Applicability::MachineApplicable, ); } else { let iter = snippet(cx, search_recv.span, ".."); span_lint_and_sugg( cx, SEARCH_IS_SOME, expr.span, &msg, "use `!_.any()` instead", format!( "!{}.any({})", iter, any_search_snippet.as_ref().map_or(&*search_snippet, String::as_str) ), Applicability::MachineApplicable, ); } } else { let hint = format!( "this is more succinctly expressed by calling `any()`{}", if option_check_method == "is_none" { " with negation" } else { "" } ); span_lint_and_help(cx, SEARCH_IS_SOME, expr.span, &msg, None, &hint); } } // lint if `find()` is called by `String` or `&str` else if search_method == "find" { let is_string_or_str_slice = |e| { let self_ty = cx.typeck_results().expr_ty(e).peel_refs(); if is_type_diagnostic_item(cx, self_ty, sym::String) { true } else { *self_ty.kind() == ty::Str } }; if_chain! { if is_string_or_str_slice(search_recv); if is_string_or_str_slice(search_arg); then { let msg = format!("called `{}()` after calling `find()` on a string", option_check_method); match option_check_method { "is_some" => { let mut applicability = Applicability::MachineApplicable; let find_arg = snippet_with_applicability(cx, search_arg.span, "..", &mut applicability); span_lint_and_sugg( cx, SEARCH_IS_SOME, method_span.with_hi(expr.span.hi()), &msg, "use `contains()` instead", format!("contains({})", find_arg), applicability, ); }, "is_none" => { let string = snippet(cx, search_recv.span, ".."); let mut applicability = Applicability::MachineApplicable; let find_arg = snippet_with_applicability(cx, search_arg.span, "..", &mut applicability); span_lint_and_sugg( cx, SEARCH_IS_SOME, expr.span, &msg, "use `!_.contains()` instead", format!("!{}.contains({})", string, find_arg), applicability, ); }, _ => (), } } } } } fn get_closure_suggestion<'tcx>( cx: &LateContext<'_>, search_arg: &'tcx hir::Expr<'_>, closure_body: &hir::Body<'_>, ) -> Option { let mut visitor = DerefDelegate { cx, closure_span: search_arg.span, next_pos: None, suggestion_start: String::new(), suggestion_end: String::new(), }; let fn_def_id = cx.tcx.hir().local_def_id(search_arg.hir_id); cx.tcx.infer_ctxt().enter(|infcx| { ExprUseVisitor::new(&mut visitor, &infcx, fn_def_id, cx.param_env, cx.typeck_results()) .consume_body(closure_body); }); if visitor.suggestion_start.is_empty() { None } else { Some(format!("{}{}", visitor.suggestion_start, visitor.suggestion_end)) } } struct DerefDelegate<'a, 'tcx> { cx: &'a LateContext<'tcx>, closure_span: Span, next_pos: Option, suggestion_start: String, suggestion_end: String, } impl<'tcx> Delegate<'tcx> for DerefDelegate<'_, 'tcx> { fn consume(&mut self, _: &PlaceWithHirId<'tcx>, _: HirId) {} fn borrow(&mut self, cmt: &PlaceWithHirId<'tcx>, _: HirId, _: ty::BorrowKind) { if let PlaceBase::Local(id) = cmt.place.base { let map = self.cx.tcx.hir(); let ident_str = map.name(id).to_string(); let span = map.span(cmt.hir_id); let start_span = if let Some(next_pos) = self.next_pos { Span::new(next_pos, span.lo(), span.ctxt()) } else { self.closure_span.until(span) }; let start_snip = snippet(self.cx, start_span, ".."); let end_span = Span::new(span.hi(), self.closure_span.hi(), span.ctxt()); let end_snip = snippet(self.cx, end_span, ".."); if cmt.place.projections.is_empty() { self.suggestion_start.push_str(&format!("{}&{}", start_snip, ident_str)); } else { let parent_expr = get_parent_expr_for_hir(self.cx, cmt.hir_id); if let Some(Expr { hir_id: _, kind, .. }) = parent_expr { if let ExprKind::Call(_, args) | ExprKind::MethodCall(_, _, args, _) = kind { let args_to_handle = args.iter().filter(|arg| arg.hir_id == cmt.hir_id).collect::>(); if !args_to_handle.is_empty() { for arg in &args_to_handle { let arg_ty_kind = self.cx.typeck_results().expr_ty(arg).kind(); if matches!(arg_ty_kind, ty::Ref(_, _, Mutability::Not)) { let start_span = if let Some(next_pos) = self.next_pos { Span::new(next_pos, span.lo(), span.ctxt()) } else { self.closure_span.until(span) }; let start_snip = snippet(self.cx, start_span, ".."); self.suggestion_start.push_str(&format!("{}&{}", start_snip, ident_str)); self.suggestion_end = end_snip.to_string(); self.next_pos = Some(span.hi()); } } return; } } } let mut replacement_str = ident_str; let last_deref = cmt .place .projections .iter() .rposition(|proj| proj.kind == ProjectionKind::Deref); if let Some(pos) = last_deref { let mut projections = cmt.place.projections.clone(); projections.truncate(pos); for item in projections { if item.kind == ProjectionKind::Deref { replacement_str = format!("*{}", replacement_str); } } } self.suggestion_start .push_str(&format!("{}{}", start_snip, replacement_str)); self.suggestion_end = end_snip.to_string(); } self.next_pos = Some(span.hi()); } } fn mutate(&mut self, _: &PlaceWithHirId<'tcx>, _: HirId) {} fn fake_read(&mut self, _: rustc_typeck::expr_use_visitor::Place<'tcx>, _: FakeReadCause, _: HirId) {} }