clippy_lints/src/vec_init_then_push.rs

   1 use crate::utils::{
   2     is_type_diagnostic_item, match_def_path, path_to_local, path_to_local_id, paths, snippet, span_lint_and_sugg,
   3 };
   4 use if_chain::if_chain;
   5 use rustc_ast::ast::LitKind;
   6 use rustc_errors::Applicability;
   7 use rustc_hir::{BindingAnnotation, Block, Expr, ExprKind, HirId, Local, PatKind, QPath, Stmt, StmtKind};
   8 use rustc_lint::{LateContext, LateLintPass, LintContext};
   9 use rustc_middle::lint::in_external_macro;
  10 use rustc_session::{declare_tool_lint, impl_lint_pass};
  11 use rustc_span::{symbol::sym, Span};
  12 use std::convert::TryInto;
  13
  14 declare_clippy_lint! {
  15     /// **What it does:** Checks for calls to `push` immediately after creating a new `Vec`.
  16     ///
  17     /// **Why is this bad?** The `vec![]` macro is both more performant and easier to read than
  18     /// multiple `push` calls.
  19     ///
  20     /// **Known problems:** None.
  21     ///
  22     /// **Example:**
  23     ///
  24     /// ```rust
  25     /// let mut v = Vec::new();
  26     /// v.push(0);
  27     /// ```
  28     /// Use instead:
  29     /// ```rust
  30     /// let v = vec![0];
  31     /// ```
  32     pub VEC_INIT_THEN_PUSH,
  33     perf,
  34     "`push` immediately after `Vec` creation"
  35 }
  36
  37 impl_lint_pass!(VecInitThenPush => [VEC_INIT_THEN_PUSH]);
  38
  39 #[derive(Default)]
  40 pub struct VecInitThenPush {
  41     searcher: Option<VecPushSearcher>,
  42 }
  43
  44 #[derive(Clone, Copy)]
  45 enum VecInitKind {
  46     New,
  47     WithCapacity(u64),
  48 }
  49 struct VecPushSearcher {
  50     local_id: HirId,
  51     init: VecInitKind,
  52     lhs_is_local: bool,
  53     lhs_span: Span,
  54     err_span: Span,
  55     found: u64,
  56 }
  57 impl VecPushSearcher {
  58     fn display_err(&self, cx: &LateContext<'_>) {
  59         match self.init {
  60             _ if self.found == 0 => return,
  61             VecInitKind::WithCapacity(x) if x > self.found => return,
  62             _ => (),
  63         };
  64
  65         let mut s = if self.lhs_is_local {
  66             String::from("let ")
  67         } else {
  68             String::new()
  69         };
  70         s.push_str(&snippet(cx, self.lhs_span, ".."));
  71         s.push_str(" = vec![..];");
  72
  73         span_lint_and_sugg(
  74             cx,
  75             VEC_INIT_THEN_PUSH,
  76             self.err_span,
  77             "calls to `push` immediately after creation",
  78             "consider using the `vec![]` macro",
  79             s,
  80             Applicability::HasPlaceholders,
  81         );
  82     }
  83 }
  84
  85 impl LateLintPass<'_> for VecInitThenPush {
  86     fn check_block(&mut self, _: &LateContext<'tcx>, _: &'tcx Block<'tcx>) {
  87         self.searcher = None;
  88     }
  89
  90     fn check_local(&mut self, cx: &LateContext<'tcx>, local: &'tcx Local<'tcx>) {
  91         if_chain! {
  92             if !in_external_macro(cx.sess(), local.span);
  93             if let Some(init) = local.init;
  94             if let PatKind::Binding(BindingAnnotation::Mutable, id, _, None) = local.pat.kind;
  95             if let Some(init_kind) = get_vec_init_kind(cx, init);
  96             then {
  97                 self.searcher = Some(VecPushSearcher {
  98                         local_id: id,
  99                         init: init_kind,
 100                         lhs_is_local: true,
 101                         lhs_span: local.ty.map_or(local.pat.span, |t| local.pat.span.to(t.span)),
 102                         err_span: local.span,
 103                         found: 0,
 104                     });
 105             }
 106         }
 107     }
 108
 109     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
 110         if self.searcher.is_none() {
 111             if_chain! {
 112                 if !in_external_macro(cx.sess(), expr.span);
 113                 if let ExprKind::Assign(left, right, _) = expr.kind;
 114                 if let Some(id) = path_to_local(left);
 115                 if let Some(init_kind) = get_vec_init_kind(cx, right);
 116                 then {
 117                     self.searcher = Some(VecPushSearcher {
 118                         local_id: id,
 119                         init: init_kind,
 120                         lhs_is_local: false,
 121                         lhs_span: left.span,
 122                         err_span: expr.span,
 123                         found: 0,
 124                     });
 125                 }
 126             }
 127         }
 128     }
 129
 130     fn check_stmt(&mut self, cx: &LateContext<'tcx>, stmt: &'tcx Stmt<'_>) {
 131         if let Some(searcher) = self.searcher.take() {
 132             if_chain! {
 133                 if let StmtKind::Expr(expr) | StmtKind::Semi(expr) = stmt.kind;
 134                 if let ExprKind::MethodCall(path, _, [self_arg, _], _) = expr.kind;
 135                 if path_to_local_id(self_arg, searcher.local_id);
 136                 if path.ident.name.as_str() == "push";
 137                 then {
 138                     self.searcher = Some(VecPushSearcher {
 139                         found: searcher.found + 1,
 140                         err_span: searcher.err_span.to(stmt.span),
 141                         .. searcher
 142                     });
 143                 } else {
 144                     searcher.display_err(cx);
 145                 }
 146             }
 147         }
 148     }
 149
 150     fn check_block_post(&mut self, cx: &LateContext<'tcx>, _: &'tcx Block<'tcx>) {
 151         if let Some(searcher) = self.searcher.take() {
 152             searcher.display_err(cx);
 153         }
 154     }
 155 }
 156
 157 fn get_vec_init_kind<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'tcx>) -> Option<VecInitKind> {
 158     if let ExprKind::Call(func, args) = expr.kind {
 159         match func.kind {
 160             ExprKind::Path(QPath::TypeRelative(ty, name))
 161                 if is_type_diagnostic_item(cx, cx.typeck_results().node_type(ty.hir_id), sym::vec_type) =>
 162             {
 163                 if name.ident.name == sym::new {
 164                     return Some(VecInitKind::New);
 165                 } else if name.ident.name.as_str() == "with_capacity" {
 166                     return args.get(0).and_then(|arg| {
 167                         if_chain! {
 168                             if let ExprKind::Lit(lit) = &arg.kind;
 169                             if let LitKind::Int(num, _) = lit.node;
 170                             then {
 171                                 Some(VecInitKind::WithCapacity(num.try_into().ok()?))
 172                             } else {
 173                                 None
 174                             }
 175                         }
 176                     });
 177                 }
 178             }
 179             ExprKind::Path(QPath::Resolved(_, path))
 180                 if match_def_path(cx, path.res.opt_def_id()?, &paths::DEFAULT_TRAIT_METHOD)
 181                     && is_type_diagnostic_item(cx, cx.typeck_results().expr_ty(expr), sym::vec_type) =>
 182             {
 183                 return Some(VecInitKind::New);
 184             }
 185             _ => (),
 186         }
 187     }
 188     None
 189 }