1 use crate::utils::ptr::get_spans;
3 get_trait_def_id, implements_trait, is_copy, is_self, is_type_diagnostic_item, multispan_sugg, paths, snippet,
4 snippet_opt, span_lint_and_then,
6 use if_chain::if_chain;
7 use rustc_ast::ast::Attribute;
8 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
9 use rustc_errors::{Applicability, DiagnosticBuilder};
10 use rustc_hir::intravisit::FnKind;
11 use rustc_hir::{BindingAnnotation, Body, FnDecl, GenericArg, HirId, ItemKind, Node, PatKind, QPath, TyKind};
12 use rustc_infer::infer::TyCtxtInferExt;
13 use rustc_lint::{LateContext, LateLintPass};
14 use rustc_middle::ty::{self, TypeFoldable};
15 use rustc_session::{declare_lint_pass, declare_tool_lint};
16 use rustc_span::{sym, Span};
17 use rustc_target::spec::abi::Abi;
18 use rustc_trait_selection::traits;
19 use rustc_trait_selection::traits::misc::can_type_implement_copy;
20 use rustc_typeck::expr_use_visitor as euv;
23 declare_clippy_lint! {
24 /// **What it does:** Checks for functions taking arguments by value, but not
25 /// consuming them in its
28 /// **Why is this bad?** Taking arguments by reference is more flexible and can
30 /// unnecessary allocations.
32 /// **Known problems:**
33 /// * This lint suggests taking an argument by reference,
34 /// however sometimes it is better to let users decide the argument type
35 /// (by using `Borrow` trait, for example), depending on how the function is used.
39 /// fn foo(v: Vec<i32>) {
40 /// assert_eq!(v.len(), 42);
45 /// fn foo(v: &[i32]) {
46 /// assert_eq!(v.len(), 42);
49 pub NEEDLESS_PASS_BY_VALUE,
51 "functions taking arguments by value, but not consuming them in its body"
54 declare_lint_pass!(NeedlessPassByValue => [NEEDLESS_PASS_BY_VALUE]);
66 impl<'tcx> LateLintPass<'tcx> for NeedlessPassByValue {
67 #[allow(clippy::too_many_lines)]
70 cx: &LateContext<'tcx>,
72 decl: &'tcx FnDecl<'_>,
77 if span.from_expansion() {
82 FnKind::ItemFn(.., header, _, attrs) => {
83 if header.abi != Abi::Rust || requires_exact_signature(attrs) {
87 FnKind::Method(..) => (),
88 FnKind::Closure(..) => return,
91 // Exclude non-inherent impls
92 if let Some(Node::Item(item)) = cx.tcx.hir().find(cx.tcx.hir().get_parent_node(hir_id)) {
95 ItemKind::Impl { of_trait: Some(_), .. } | ItemKind::Trait(..)
101 // Allow `Borrow` or functions to be taken by value
102 let borrow_trait = need!(get_trait_def_id(cx, &paths::BORROW_TRAIT));
103 let allowed_traits = [
104 need!(cx.tcx.lang_items().fn_trait()),
105 need!(cx.tcx.lang_items().fn_once_trait()),
106 need!(cx.tcx.lang_items().fn_mut_trait()),
107 need!(get_trait_def_id(cx, &paths::RANGE_ARGUMENT_TRAIT)),
110 let sized_trait = need!(cx.tcx.lang_items().sized_trait());
112 let fn_def_id = cx.tcx.hir().local_def_id(hir_id);
114 let preds = traits::elaborate_predicates(cx.tcx, cx.param_env.caller_bounds().iter())
115 .filter(|p| !p.is_global())
116 .filter_map(|obligation| {
117 // Note that we do not want to deal with qualified predicates here.
118 if let ty::PredicateKind::Atom(ty::PredicateAtom::Trait(pred, _)) = obligation.predicate.kind() {
119 if pred.def_id() == sized_trait {
127 .collect::<Vec<_>>();
129 // Collect moved variables and spans which will need dereferencings from the
131 let MovedVariablesCtxt {
136 let mut ctx = MovedVariablesCtxt::default();
137 cx.tcx.infer_ctxt().enter(|infcx| {
138 euv::ExprUseVisitor::new(&mut ctx, &infcx, fn_def_id, cx.param_env, cx.typeck_results())
144 let fn_sig = cx.tcx.fn_sig(fn_def_id);
145 let fn_sig = cx.tcx.erase_late_bound_regions(fn_sig);
147 for (idx, ((input, &ty), arg)) in decl.inputs.iter().zip(fn_sig.inputs()).zip(body.params).enumerate() {
148 // All spans generated from a proc-macro invocation are the same...
149 if span == input.span {
155 if let PatKind::Binding(.., ident, _) = arg.pat.kind {
156 if ident.as_str() == "self" {
163 // * Exclude a type that is specifically bounded by `Borrow`.
164 // * Exclude a type whose reference also fulfills its bound. (e.g., `std::convert::AsRef`,
165 // `serde::Serialize`)
166 let (implements_borrow_trait, all_borrowable_trait) = {
167 let preds = preds.iter().filter(|t| t.self_ty() == ty).collect::<Vec<_>>();
170 preds.iter().any(|t| t.def_id() == borrow_trait),
171 !preds.is_empty() && {
172 let ty_empty_region = cx.tcx.mk_imm_ref(cx.tcx.lifetimes.re_root_empty, ty);
173 preds.iter().all(|t| {
174 let ty_params = t.trait_ref.substs.iter().skip(1).collect::<Vec<_>>();
175 implements_trait(cx, ty_empty_region, t.def_id(), &ty_params)
183 if !ty.is_mutable_ptr();
185 if !allowed_traits.iter().any(|&t| implements_trait(cx, ty, t, &[]));
186 if !implements_borrow_trait;
187 if !all_borrowable_trait;
189 if let PatKind::Binding(mode, canonical_id, ..) = arg.pat.kind;
190 if !moved_vars.contains(&canonical_id);
192 if mode == BindingAnnotation::Mutable || mode == BindingAnnotation::RefMut {
196 // Dereference suggestion
197 let sugg = |diag: &mut DiagnosticBuilder<'_>| {
198 if let ty::Adt(def, ..) = ty.kind() {
199 if let Some(span) = cx.tcx.hir().span_if_local(def.did) {
200 if can_type_implement_copy(cx.tcx, cx.param_env, ty).is_ok() {
201 diag.span_help(span, "consider marking this type as `Copy`");
206 let deref_span = spans_need_deref.get(&canonical_id);
208 if is_type_diagnostic_item(cx, ty, sym::vec_type);
209 if let Some(clone_spans) =
210 get_spans(cx, Some(body.id()), idx, &[("clone", ".to_owned()")]);
211 if let TyKind::Path(QPath::Resolved(_, ref path)) = input.kind;
212 if let Some(elem_ty) = path.segments.iter()
213 .find(|seg| seg.ident.name == sym::Vec)
214 .and_then(|ps| ps.args.as_ref())
215 .map(|params| params.args.iter().find_map(|arg| match arg {
216 GenericArg::Type(ty) => Some(ty),
220 let slice_ty = format!("&[{}]", snippet(cx, elem_ty.span, "_"));
221 diag.span_suggestion(
223 "consider changing the type to",
225 Applicability::Unspecified,
228 for (span, suggestion) in clone_spans {
229 diag.span_suggestion(
231 &snippet_opt(cx, span)
233 "change the call to".into(),
234 |x| Cow::from(format!("change `{}` to", x)),
237 Applicability::Unspecified,
241 // cannot be destructured, no need for `*` suggestion
242 assert!(deref_span.is_none());
247 if is_type_diagnostic_item(cx, ty, sym::string_type) {
248 if let Some(clone_spans) =
249 get_spans(cx, Some(body.id()), idx, &[("clone", ".to_string()"), ("as_str", "")]) {
250 diag.span_suggestion(
252 "consider changing the type to",
254 Applicability::Unspecified,
257 for (span, suggestion) in clone_spans {
258 diag.span_suggestion(
260 &snippet_opt(cx, span)
262 "change the call to".into(),
263 |x| Cow::from(format!("change `{}` to", x))
266 Applicability::Unspecified,
270 assert!(deref_span.is_none());
275 let mut spans = vec![(input.span, format!("&{}", snippet(cx, input.span, "_")))];
277 // Suggests adding `*` to dereference the added reference.
278 if let Some(deref_span) = deref_span {
283 .map(|span| (span, format!("*{}", snippet(cx, span, "<expr>")))),
285 spans.sort_by_key(|&(span, _)| span);
287 multispan_sugg(diag, "consider taking a reference instead", spans);
292 NEEDLESS_PASS_BY_VALUE,
294 "this argument is passed by value, but not consumed in the function body",
303 /// Functions marked with these attributes must have the exact signature.
304 fn requires_exact_signature(attrs: &[Attribute]) -> bool {
305 attrs.iter().any(|attr| {
306 [sym::proc_macro, sym::proc_macro_attribute, sym::proc_macro_derive]
308 .any(|&allow| attr.has_name(allow))
313 struct MovedVariablesCtxt {
314 moved_vars: FxHashSet<HirId>,
315 /// Spans which need to be prefixed with `*` for dereferencing the
316 /// suggested additional reference.
317 spans_need_deref: FxHashMap<HirId, FxHashSet<Span>>,
320 impl MovedVariablesCtxt {
321 fn move_common(&mut self, cmt: &euv::PlaceWithHirId<'_>) {
322 if let euv::PlaceBase::Local(vid) = cmt.place.base {
323 self.moved_vars.insert(vid);
328 impl<'tcx> euv::Delegate<'tcx> for MovedVariablesCtxt {
329 fn consume(&mut self, cmt: &euv::PlaceWithHirId<'tcx>, _: HirId, mode: euv::ConsumeMode) {
330 if let euv::ConsumeMode::Move = mode {
331 self.move_common(cmt);
335 fn borrow(&mut self, _: &euv::PlaceWithHirId<'tcx>, _: HirId, _: ty::BorrowKind) {}
337 fn mutate(&mut self, _: &euv::PlaceWithHirId<'tcx>, _: HirId) {}