clippy_lints/src/entry.rs

   1 use crate::utils::SpanlessEq;
   2 use crate::utils::{get_item_name, is_type_diagnostic_item, match_type, paths, snippet, snippet_opt};
   3 use crate::utils::{snippet_with_applicability, span_lint_and_then};
   4 use if_chain::if_chain;
   5 use rustc_errors::Applicability;
   6 use rustc_hir::intravisit::{walk_expr, NestedVisitorMap, Visitor};
   7 use rustc_hir::{BorrowKind, Expr, ExprKind, UnOp};
   8 use rustc_lint::{LateContext, LateLintPass};
   9 use rustc_middle::hir::map::Map;
  10 use rustc_session::{declare_lint_pass, declare_tool_lint};
  11 use rustc_span::source_map::Span;
  12
  13 declare_clippy_lint! {
  14     /// **What it does:** Checks for uses of `contains_key` + `insert` on `HashMap`
  15     /// or `BTreeMap`.
  16     ///
  17     /// **Why is this bad?** Using `entry` is more efficient.
  18     ///
  19     /// **Known problems:** Some false negatives, eg.:
  20     /// ```rust
  21     /// # use std::collections::HashMap;
  22     /// # let mut map = HashMap::new();
  23     /// # let v = 1;
  24     /// # let k = 1;
  25     /// if !map.contains_key(&k) {
  26     ///     map.insert(k.clone(), v);
  27     /// }
  28     /// ```
  29     ///
  30     /// **Example:**
  31     /// ```rust
  32     /// # use std::collections::HashMap;
  33     /// # let mut map = HashMap::new();
  34     /// # let k = 1;
  35     /// # let v = 1;
  36     /// if !map.contains_key(&k) {
  37     ///     map.insert(k, v);
  38     /// }
  39     /// ```
  40     /// can both be rewritten as:
  41     /// ```rust
  42     /// # use std::collections::HashMap;
  43     /// # let mut map = HashMap::new();
  44     /// # let k = 1;
  45     /// # let v = 1;
  46     /// map.entry(k).or_insert(v);
  47     /// ```
  48     pub MAP_ENTRY,
  49     perf,
  50     "use of `contains_key` followed by `insert` on a `HashMap` or `BTreeMap`"
  51 }
  52
  53 declare_lint_pass!(HashMapPass => [MAP_ENTRY]);
  54
  55 impl<'tcx> LateLintPass<'tcx> for HashMapPass {
  56     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
  57         if let ExprKind::If(ref check, ref then_block, ref else_block) = expr.kind {
  58             if let ExprKind::Unary(UnOp::UnNot, ref check) = check.kind {
  59                 if let Some((ty, map, key)) = check_cond(cx, check) {
  60                     // in case of `if !m.contains_key(&k) { m.insert(k, v); }`
  61                     // we can give a better error message
  62                     let sole_expr = {
  63                         else_block.is_none()
  64                             && if let ExprKind::Block(ref then_block, _) = then_block.kind {
  65                                 (then_block.expr.is_some() as usize) + then_block.stmts.len() == 1
  66                             } else {
  67                                 true
  68                             }
  69                         // XXXManishearth we can also check for if/else blocks containing `None`.
  70                     };
  71
  72                     let mut visitor = InsertVisitor {
  73                         cx,
  74                         span: expr.span,
  75                         ty,
  76                         map,
  77                         key,
  78                         sole_expr,
  79                     };
  80
  81                     walk_expr(&mut visitor, &**then_block);
  82                 }
  83             } else if let Some(ref else_block) = *else_block {
  84                 if let Some((ty, map, key)) = check_cond(cx, check) {
  85                     let mut visitor = InsertVisitor {
  86                         cx,
  87                         span: expr.span,
  88                         ty,
  89                         map,
  90                         key,
  91                         sole_expr: false,
  92                     };
  93
  94                     walk_expr(&mut visitor, else_block);
  95                 }
  96             }
  97         }
  98     }
  99 }
 100
 101 fn check_cond<'a>(cx: &LateContext<'_>, check: &'a Expr<'a>) -> Option<(&'static str, &'a Expr<'a>, &'a Expr<'a>)> {
 102     if_chain! {
 103         if let ExprKind::MethodCall(ref path, _, ref params, _) = check.kind;
 104         if params.len() >= 2;
 105         if path.ident.name == sym!(contains_key);
 106         if let ExprKind::AddrOf(BorrowKind::Ref, _, ref key) = params[1].kind;
 107         then {
 108             let map = &params[0];
 109             let obj_ty = cx.typeck_results().expr_ty(map).peel_refs();
 110
 111             return if match_type(cx, obj_ty, &paths::BTREEMAP) {
 112                 Some(("BTreeMap", map, key))
 113             }
 114             else if is_type_diagnostic_item(cx, obj_ty, sym!(hashmap_type)) {
 115                 Some(("HashMap", map, key))
 116             }
 117             else {
 118                 None
 119             };
 120         }
 121     }
 122
 123     None
 124 }
 125
 126 struct InsertVisitor<'a, 'tcx, 'b> {
 127     cx: &'a LateContext<'tcx>,
 128     span: Span,
 129     ty: &'static str,
 130     map: &'b Expr<'b>,
 131     key: &'b Expr<'b>,
 132     sole_expr: bool,
 133 }
 134
 135 impl<'a, 'tcx, 'b> Visitor<'tcx> for InsertVisitor<'a, 'tcx, 'b> {
 136     type Map = Map<'tcx>;
 137
 138     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
 139         if_chain! {
 140             if let ExprKind::MethodCall(ref path, _, ref params, _) = expr.kind;
 141             if params.len() == 3;
 142             if path.ident.name == sym!(insert);
 143             if get_item_name(self.cx, self.map) == get_item_name(self.cx, &params[0]);
 144             if SpanlessEq::new(self.cx).eq_expr(self.key, &params[1]);
 145             if snippet_opt(self.cx, self.map.span) == snippet_opt(self.cx, params[0].span);
 146             then {
 147                 span_lint_and_then(self.cx, MAP_ENTRY, self.span,
 148                                    &format!("usage of `contains_key` followed by `insert` on a `{}`", self.ty), |diag| {
 149                     if self.sole_expr {
 150                         let mut app = Applicability::MachineApplicable;
 151                         let help = format!("{}.entry({}).or_insert({});",
 152                                            snippet_with_applicability(self.cx, self.map.span, "map", &mut app),
 153                                            snippet_with_applicability(self.cx, params[1].span, "..", &mut app),
 154                                            snippet_with_applicability(self.cx, params[2].span, "..", &mut app));
 155
 156                         diag.span_suggestion(
 157                             self.span,
 158                             "consider using",
 159                             help,
 160                             Applicability::MachineApplicable, // snippet
 161                         );
 162                     }
 163                     else {
 164                         let help = format!("consider using `{}.entry({})`",
 165                                            snippet(self.cx, self.map.span, "map"),
 166                                            snippet(self.cx, params[1].span, ".."));
 167
 168                         diag.span_label(
 169                             self.span,
 170                             &help,
 171                         );
 172                     }
 173                 });
 174             }
 175         }
 176
 177         if !self.sole_expr {
 178             walk_expr(self, expr);
 179         }
 180     }
 181     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
 182         NestedVisitorMap::None
 183     }
 184 }