1 use crate::utils::ptr::get_spans;
3 get_trait_def_id, implements_trait, in_macro, is_copy, is_self, match_type, multispan_sugg, paths, snippet,
4 snippet_opt, span_lint_and_then,
6 use if_chain::if_chain;
8 use rustc::hir::intravisit::FnKind;
10 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
11 use rustc::middle::expr_use_visitor as euv;
12 use rustc::middle::mem_categorization as mc;
14 use rustc::ty::{self, RegionKind, TypeFoldable};
15 use rustc::{declare_tool_lint, lint_array};
16 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
17 use rustc_errors::Applicability;
18 use rustc_target::spec::abi::Abi;
20 use syntax::ast::Attribute;
21 use syntax::errors::DiagnosticBuilder;
24 declare_clippy_lint! {
25 /// **What it does:** Checks for functions taking arguments by value, but not
26 /// consuming them in its
29 /// **Why is this bad?** Taking arguments by reference is more flexible and can
31 /// unnecessary allocations.
33 /// **Known problems:**
34 /// * This lint suggests taking an argument by reference,
35 /// however sometimes it is better to let users decide the argument type
36 /// (by using `Borrow` trait, for example), depending on how the function is used.
40 /// fn foo(v: Vec<i32>) {
41 /// assert_eq!(v.len(), 42);
44 /// fn foo(v: &[i32]) {
45 /// assert_eq!(v.len(), 42);
48 pub NEEDLESS_PASS_BY_VALUE,
50 "functions taking arguments by value, but not consuming them in its body"
53 pub struct NeedlessPassByValue;
55 impl LintPass for NeedlessPassByValue {
56 fn get_lints(&self) -> LintArray {
57 lint_array![NEEDLESS_PASS_BY_VALUE]
60 fn name(&self) -> &'static str {
75 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for NeedlessPassByValue {
76 #[allow(clippy::too_many_lines)]
79 cx: &LateContext<'a, 'tcx>,
91 FnKind::ItemFn(.., header, _, attrs) => {
92 if header.abi != Abi::Rust || requires_exact_signature(attrs) {
96 FnKind::Method(..) => (),
100 // Exclude non-inherent impls
101 if let Some(Node::Item(item)) = cx
104 .find_by_hir_id(cx.tcx.hir().get_parent_node_by_hir_id(hir_id))
106 if matches!(item.node, ItemKind::Impl(_, _, _, _, Some(_), _, _) |
113 // Allow `Borrow` or functions to be taken by value
114 let borrow_trait = need!(get_trait_def_id(cx, &paths::BORROW_TRAIT));
115 let whitelisted_traits = [
116 need!(cx.tcx.lang_items().fn_trait()),
117 need!(cx.tcx.lang_items().fn_once_trait()),
118 need!(cx.tcx.lang_items().fn_mut_trait()),
119 need!(get_trait_def_id(cx, &paths::RANGE_ARGUMENT_TRAIT)),
122 let sized_trait = need!(cx.tcx.lang_items().sized_trait());
124 let fn_def_id = cx.tcx.hir().local_def_id_from_hir_id(hir_id);
126 let preds = traits::elaborate_predicates(cx.tcx, cx.param_env.caller_bounds.to_vec())
127 .filter(|p| !p.is_global())
129 if let ty::Predicate::Trait(poly_trait_ref) = pred {
130 if poly_trait_ref.def_id() == sized_trait || poly_trait_ref.skip_binder().has_escaping_bound_vars()
139 .collect::<Vec<_>>();
141 // Collect moved variables and spans which will need dereferencings from the
143 let MovedVariablesCtxt {
148 let mut ctx = MovedVariablesCtxt::new(cx);
149 let region_scope_tree = &cx.tcx.region_scope_tree(fn_def_id);
150 euv::ExprUseVisitor::new(&mut ctx, cx.tcx, cx.param_env, region_scope_tree, cx.tables, None)
155 let fn_sig = cx.tcx.fn_sig(fn_def_id);
156 let fn_sig = cx.tcx.erase_late_bound_regions(&fn_sig);
158 for (idx, ((input, &ty), arg)) in decl.inputs.iter().zip(fn_sig.inputs()).zip(&body.arguments).enumerate() {
159 // All spans generated from a proc-macro invocation are the same...
160 if span == input.span {
166 if let PatKind::Binding(.., ident, _) = arg.pat.node {
167 if ident.as_str() == "self" {
174 // * Exclude a type that is specifically bounded by `Borrow`.
175 // * Exclude a type whose reference also fulfills its bound. (e.g., `std::convert::AsRef`,
176 // `serde::Serialize`)
177 let (implements_borrow_trait, all_borrowable_trait) = {
180 .filter(|t| t.skip_binder().self_ty() == ty)
181 .collect::<Vec<_>>();
184 preds.iter().any(|t| t.def_id() == borrow_trait),
186 && preds.iter().all(|t| {
194 .collect::<Vec<_>>();
195 implements_trait(cx, cx.tcx.mk_imm_ref(&RegionKind::ReEmpty, ty), t.def_id(), ty_params)
202 if !ty.is_mutable_pointer();
204 if !whitelisted_traits.iter().any(|&t| implements_trait(cx, ty, t, &[]));
205 if !implements_borrow_trait;
206 if !all_borrowable_trait;
208 if let PatKind::Binding(mode, canonical_id, ..) = arg.pat.node;
209 if !moved_vars.contains(&canonical_id);
211 if mode == BindingAnnotation::Mutable || mode == BindingAnnotation::RefMut {
215 // Dereference suggestion
216 let sugg = |db: &mut DiagnosticBuilder<'_>| {
217 if let ty::Adt(def, ..) = ty.sty {
218 if let Some(span) = cx.tcx.hir().span_if_local(def.did) {
219 if cx.param_env.can_type_implement_copy(cx.tcx, ty).is_ok() {
220 db.span_help(span, "consider marking this type as Copy");
225 let deref_span = spans_need_deref.get(&canonical_id);
227 if match_type(cx, ty, &paths::VEC);
228 if let Some(clone_spans) =
229 get_spans(cx, Some(body.id()), idx, &[("clone", ".to_owned()")]);
230 if let TyKind::Path(QPath::Resolved(_, ref path)) = input.node;
231 if let Some(elem_ty) = path.segments.iter()
232 .find(|seg| seg.ident.name == "Vec")
233 .and_then(|ps| ps.args.as_ref())
234 .map(|params| params.args.iter().find_map(|arg| match arg {
235 GenericArg::Type(ty) => Some(ty),
239 let slice_ty = format!("&[{}]", snippet(cx, elem_ty.span, "_"));
242 "consider changing the type to",
244 Applicability::Unspecified,
247 for (span, suggestion) in clone_spans {
250 &snippet_opt(cx, span)
252 "change the call to".into(),
253 |x| Cow::from(format!("change `{}` to", x)),
256 Applicability::Unspecified,
260 // cannot be destructured, no need for `*` suggestion
261 assert!(deref_span.is_none());
266 if match_type(cx, ty, &paths::STRING) {
267 if let Some(clone_spans) =
268 get_spans(cx, Some(body.id()), idx, &[("clone", ".to_string()"), ("as_str", "")]) {
271 "consider changing the type to",
273 Applicability::Unspecified,
276 for (span, suggestion) in clone_spans {
279 &snippet_opt(cx, span)
281 "change the call to".into(),
282 |x| Cow::from(format!("change `{}` to", x))
285 Applicability::Unspecified,
289 assert!(deref_span.is_none());
294 let mut spans = vec![(input.span, format!("&{}", snippet(cx, input.span, "_")))];
296 // Suggests adding `*` to dereference the added reference.
297 if let Some(deref_span) = deref_span {
302 .map(|span| (span, format!("*{}", snippet(cx, span, "<expr>")))),
304 spans.sort_by_key(|&(span, _)| span);
306 multispan_sugg(db, "consider taking a reference instead".to_string(), spans);
311 NEEDLESS_PASS_BY_VALUE,
313 "this argument is passed by value, but not consumed in the function body",
322 /// Functions marked with these attributes must have the exact signature.
323 fn requires_exact_signature(attrs: &[Attribute]) -> bool {
324 attrs.iter().any(|attr| {
325 ["proc_macro", "proc_macro_attribute", "proc_macro_derive"]
327 .any(|&allow| attr.check_name(allow))
331 struct MovedVariablesCtxt<'a, 'tcx: 'a> {
332 cx: &'a LateContext<'a, 'tcx>,
333 moved_vars: FxHashSet<HirId>,
334 /// Spans which need to be prefixed with `*` for dereferencing the
335 /// suggested additional reference.
336 spans_need_deref: FxHashMap<HirId, FxHashSet<Span>>,
339 impl<'a, 'tcx> MovedVariablesCtxt<'a, 'tcx> {
340 fn new(cx: &'a LateContext<'a, 'tcx>) -> Self {
343 moved_vars: FxHashSet::default(),
344 spans_need_deref: FxHashMap::default(),
348 fn move_common(&mut self, _consume_id: HirId, _span: Span, cmt: &mc::cmt_<'tcx>) {
349 let cmt = unwrap_downcast_or_interior(cmt);
351 if let mc::Categorization::Local(vid) = cmt.cat {
352 self.moved_vars.insert(vid);
356 fn non_moving_pat(&mut self, matched_pat: &Pat, cmt: &mc::cmt_<'tcx>) {
357 let cmt = unwrap_downcast_or_interior(cmt);
359 if let mc::Categorization::Local(vid) = cmt.cat {
360 let mut id = matched_pat.hir_id;
362 let parent = self.cx.tcx.hir().get_parent_node_by_hir_id(id);
369 if let Some(node) = self.cx.tcx.hir().find_by_hir_id(id) {
372 // `match` and `if let`
373 if let ExprKind::Match(ref c, ..) = e.node {
374 self.spans_need_deref
376 .or_insert_with(FxHashSet::default)
384 if let StmtKind::Local(ref local) = s.node;
386 self.spans_need_deref
388 .or_insert_with(FxHashSet::default)
392 .expect("`let` stmt without init aren't caught by match_pat"));
405 impl<'a, 'tcx> euv::Delegate<'tcx> for MovedVariablesCtxt<'a, 'tcx> {
406 fn consume(&mut self, consume_id: HirId, consume_span: Span, cmt: &mc::cmt_<'tcx>, mode: euv::ConsumeMode) {
407 if let euv::ConsumeMode::Move(_) = mode {
408 self.move_common(consume_id, consume_span, cmt);
412 fn matched_pat(&mut self, matched_pat: &Pat, cmt: &mc::cmt_<'tcx>, mode: euv::MatchMode) {
413 if let euv::MatchMode::MovingMatch = mode {
414 self.move_common(matched_pat.hir_id, matched_pat.span, cmt);
416 self.non_moving_pat(matched_pat, cmt);
420 fn consume_pat(&mut self, consume_pat: &Pat, cmt: &mc::cmt_<'tcx>, mode: euv::ConsumeMode) {
421 if let euv::ConsumeMode::Move(_) = mode {
422 self.move_common(consume_pat.hir_id, consume_pat.span, cmt);
437 fn mutate(&mut self, _: HirId, _: Span, _: &mc::cmt_<'tcx>, _: euv::MutateMode) {}
439 fn decl_without_init(&mut self, _: HirId, _: Span) {}
442 fn unwrap_downcast_or_interior<'a, 'tcx>(mut cmt: &'a mc::cmt_<'tcx>) -> mc::cmt_<'tcx> {
445 mc::Categorization::Downcast(ref c, _) | mc::Categorization::Interior(ref c, _) => {
448 _ => return (*cmt).clone(),