clippy_lints/src/vec.rs

   1 use crate::consts::constant;
   2 use crate::utils::{higher, is_copy, snippet_with_applicability, span_lint_and_sugg};
   3 use if_chain::if_chain;
   4 use rustc::hir::*;
   5 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
   6 use rustc::ty::{self, Ty};
   7 use rustc::{declare_tool_lint, lint_array};
   8 use rustc_errors::Applicability;
   9 use syntax::source_map::Span;
  10
  11 /// **What it does:** Checks for usage of `&vec![..]` when using `&[..]` would
  12 /// be possible.
  13 ///
  14 /// **Why is this bad?** This is less efficient.
  15 ///
  16 /// **Known problems:** None.
  17 ///
  18 /// **Example:**
  19 /// ```rust,ignore
  20 /// foo(&vec![1, 2])
  21 /// ```
  22 declare_clippy_lint! {
  23     pub USELESS_VEC,
  24     perf,
  25     "useless `vec!`"
  26 }
  27
  28 #[derive(Copy, Clone, Debug)]
  29 pub struct Pass;
  30
  31 impl LintPass for Pass {
  32     fn get_lints(&self) -> LintArray {
  33         lint_array!(USELESS_VEC)
  34     }
  35
  36     fn name(&self) -> &'static str {
  37         "UselessVec"
  38     }
  39 }
  40
  41 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Pass {
  42     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
  43         // search for `&vec![_]` expressions where the adjusted type is `&[_]`
  44         if_chain! {
  45             if let ty::Ref(_, ty, _) = cx.tables.expr_ty_adjusted(expr).sty;
  46             if let ty::Slice(..) = ty.sty;
  47             if let ExprKind::AddrOf(_, ref addressee) = expr.node;
  48             if let Some(vec_args) = higher::vec_macro(cx, addressee);
  49             then {
  50                 check_vec_macro(cx, &vec_args, expr.span);
  51             }
  52         }
  53
  54         // search for `for _ in vec![…]`
  55         if_chain! {
  56             if let Some((_, arg, _)) = higher::for_loop(expr);
  57             if let Some(vec_args) = higher::vec_macro(cx, arg);
  58             if is_copy(cx, vec_type(cx.tables.expr_ty_adjusted(arg)));
  59             then {
  60                 // report the error around the `vec!` not inside `<std macros>:`
  61                 let span = arg.span
  62                     .ctxt()
  63                     .outer()
  64                     .expn_info()
  65                     .map(|info| info.call_site)
  66                     .expect("unable to get call_site");
  67                 check_vec_macro(cx, &vec_args, span);
  68             }
  69         }
  70     }
  71 }
  72
  73 fn check_vec_macro<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, vec_args: &higher::VecArgs<'tcx>, span: Span) {
  74     let mut applicability = Applicability::MachineApplicable;
  75     let snippet = match *vec_args {
  76         higher::VecArgs::Repeat(elem, len) => {
  77             if constant(cx, cx.tables, len).is_some() {
  78                 format!(
  79                     "&[{}; {}]",
  80                     snippet_with_applicability(cx, elem.span, "elem", &mut applicability),
  81                     snippet_with_applicability(cx, len.span, "len", &mut applicability)
  82                 )
  83             } else {
  84                 return;
  85             }
  86         },
  87         higher::VecArgs::Vec(args) => {
  88             if let Some(last) = args.iter().last() {
  89                 let span = args[0].span.to(last.span);
  90
  91                 format!("&[{}]", snippet_with_applicability(cx, span, "..", &mut applicability))
  92             } else {
  93                 "&[]".into()
  94             }
  95         },
  96     };
  97
  98     span_lint_and_sugg(
  99         cx,
 100         USELESS_VEC,
 101         span,
 102         "useless use of `vec!`",
 103         "you can use a slice directly",
 104         snippet,
 105         applicability,
 106     );
 107 }
 108
 109 /// Return the item type of the vector (ie. the `T` in `Vec<T>`).
 110 fn vec_type(ty: Ty<'_>) -> Ty<'_> {
 111     if let ty::Adt(_, substs) = ty.sty {
 112         substs.type_at(0)
 113     } else {
 114         panic!("The type of `vec!` is a not a struct?");
 115     }
 116 }