clippy_lints/src/len_zero.rs

   1 use rustc::lint::*;
   2 use rustc::hir::def_id::DefId;
   3 use rustc::ty;
   4 use rustc::hir::*;
   5 use syntax::ast::{Lit, LitKind, Name};
   6 use syntax::codemap::{Span, Spanned};
   7 use utils::{get_item_name, in_macro, snippet, span_lint, span_lint_and_sugg, walk_ptrs_ty};
   8
   9 /// **What it does:** Checks for getting the length of something via `.len()`
  10 /// just to compare to zero, and suggests using `.is_empty()` where applicable.
  11 ///
  12 /// **Why is this bad?** Some structures can answer `.is_empty()` much faster
  13 /// than calculating their length. So it is good to get into the habit of using
  14 /// `.is_empty()`, and having it is cheap. Besides, it makes the intent clearer
  15 /// than a comparison.
  16 ///
  17 /// **Known problems:** None.
  18 ///
  19 /// **Example:**
  20 /// ```rust
  21 /// if x.len() == 0 { .. }
  22 /// ```
  23 declare_lint! {
  24     pub LEN_ZERO,
  25     Warn,
  26     "checking `.len() == 0` or `.len() > 0` (or similar) when `.is_empty()` \
  27      could be used instead"
  28 }
  29
  30 /// **What it does:** Checks for items that implement `.len()` but not
  31 /// `.is_empty()`.
  32 ///
  33 /// **Why is this bad?** It is good custom to have both methods, because for
  34 /// some data structures, asking about the length will be a costly operation,
  35 /// whereas `.is_empty()` can usually answer in constant time. Also it used to
  36 /// lead to false positives on the [`len_zero`](#len_zero) lint – currently that
  37 /// lint will ignore such entities.
  38 ///
  39 /// **Known problems:** None.
  40 ///
  41 /// **Example:**
  42 /// ```rust
  43 /// impl X {
  44 ///     pub fn len(&self) -> usize { .. }
  45 /// }
  46 /// ```
  47 declare_lint! {
  48     pub LEN_WITHOUT_IS_EMPTY,
  49     Warn,
  50     "traits or impls with a public `len` method but no corresponding `is_empty` method"
  51 }
  52
  53 #[derive(Copy,Clone)]
  54 pub struct LenZero;
  55
  56 impl LintPass for LenZero {
  57     fn get_lints(&self) -> LintArray {
  58         lint_array!(LEN_ZERO, LEN_WITHOUT_IS_EMPTY)
  59     }
  60 }
  61
  62 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for LenZero {
  63     fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx Item) {
  64         if in_macro(item.span) {
  65             return;
  66         }
  67
  68         match item.node {
  69             ItemTrait(_, _, _, ref trait_items) => check_trait_items(cx, item, trait_items),
  70             ItemImpl(_, _, _, _, None, _, ref impl_items) => check_impl_items(cx, item, impl_items),
  71             _ => (),
  72         }
  73     }
  74
  75     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
  76         if in_macro(expr.span) {
  77             return;
  78         }
  79
  80         if let ExprBinary(Spanned { node: cmp, .. }, ref left, ref right) = expr.node {
  81             match cmp {
  82                 BiEq => check_cmp(cx, expr.span, left, right, ""),
  83                 BiGt | BiNe => check_cmp(cx, expr.span, left, right, "!"),
  84                 _ => (),
  85             }
  86         }
  87     }
  88 }
  89
  90 fn check_trait_items(cx: &LateContext, item: &Item, trait_items: &[TraitItemRef]) {
  91     fn is_named_self(cx: &LateContext, item: &TraitItemRef, name: &str) -> bool {
  92         item.name == name &&
  93         if let AssociatedItemKind::Method { has_self } = item.kind {
  94             has_self &&
  95             {
  96                 let did = cx.tcx.hir.local_def_id(item.id.node_id);
  97                 cx.tcx.fn_sig(did).inputs().skip_binder().len() == 1
  98             }
  99         } else {
 100             false
 101         }
 102     }
 103
 104     if !trait_items.iter().any(|i| is_named_self(cx, i, "is_empty")) {
 105         if let Some(i) = trait_items.iter().find(|i| is_named_self(cx, i, "len")) {
 106             if cx.access_levels.is_exported(i.id.node_id) {
 107                 span_lint(cx,
 108                           LEN_WITHOUT_IS_EMPTY,
 109                           item.span,
 110                           &format!("trait `{}` has a `len` method but no `is_empty` method", item.name));
 111             }
 112         }
 113     }
 114 }
 115
 116 fn check_impl_items(cx: &LateContext, item: &Item, impl_items: &[ImplItemRef]) {
 117     fn is_named_self(cx: &LateContext, item: &ImplItemRef, name: &str) -> bool {
 118         item.name == name &&
 119         if let AssociatedItemKind::Method { has_self } = item.kind {
 120             has_self &&
 121             {
 122                 let did = cx.tcx.hir.local_def_id(item.id.node_id);
 123                 cx.tcx.fn_sig(did).inputs().skip_binder().len() == 1
 124             }
 125         } else {
 126             false
 127         }
 128     }
 129
 130     let is_empty = if let Some(is_empty) = impl_items.iter().find(|i| is_named_self(cx, i, "is_empty")) {
 131         if cx.access_levels.is_exported(is_empty.id.node_id) {
 132             return;
 133         } else {
 134             "a private"
 135         }
 136     } else {
 137         "no corresponding"
 138     };
 139
 140     if let Some(i) = impl_items.iter().find(|i| is_named_self(cx, i, "len")) {
 141         if cx.access_levels.is_exported(i.id.node_id) {
 142             let def_id = cx.tcx.hir.local_def_id(item.id);
 143             let ty = cx.tcx.type_of(def_id);
 144
 145             span_lint(cx,
 146                       LEN_WITHOUT_IS_EMPTY,
 147                       item.span,
 148                       &format!("item `{}` has a public `len` method but {} `is_empty` method", ty, is_empty));
 149         }
 150     }
 151 }
 152
 153 fn check_cmp(cx: &LateContext, span: Span, left: &Expr, right: &Expr, op: &str) {
 154     // check if we are in an is_empty() method
 155     if let Some(name) = get_item_name(cx, left) {
 156         if name == "is_empty" {
 157             return;
 158         }
 159     }
 160     match (&left.node, &right.node) {
 161         (&ExprLit(ref lit), &ExprMethodCall(ref method, _, ref args)) |
 162         (&ExprMethodCall(ref method, _, ref args), &ExprLit(ref lit)) => {
 163             check_len_zero(cx, span, method.node, args, lit, op)
 164         },
 165         _ => (),
 166     }
 167 }
 168
 169 fn check_len_zero(cx: &LateContext, span: Span, name: Name, args: &[Expr], lit: &Lit, op: &str) {
 170     if let Spanned { node: LitKind::Int(0, _), .. } = *lit {
 171         if name == "len" && args.len() == 1 && has_is_empty(cx, &args[0]) {
 172             span_lint_and_sugg(cx,
 173                                LEN_ZERO,
 174                                span,
 175                                "length comparison to zero",
 176                                "using `is_empty` is more concise:",
 177                                format!("{}{}.is_empty()", op, snippet(cx, args[0].span, "_")));
 178         }
 179     }
 180 }
 181
 182 /// Check if this type has an `is_empty` method.
 183 fn has_is_empty(cx: &LateContext, expr: &Expr) -> bool {
 184     /// Get an `AssociatedItem` and return true if it matches `is_empty(self)`.
 185     fn is_is_empty(cx: &LateContext, item: &ty::AssociatedItem) -> bool {
 186         if let ty::AssociatedKind::Method = item.kind {
 187             if item.name == "is_empty" {
 188                 let sig = cx.tcx.fn_sig(item.def_id);
 189                 let ty = sig.skip_binder();
 190                 ty.inputs().len() == 1
 191             } else {
 192                 false
 193             }
 194         } else {
 195             false
 196         }
 197     }
 198
 199     /// Check the inherent impl's items for an `is_empty(self)` method.
 200     fn has_is_empty_impl(cx: &LateContext, id: DefId) -> bool {
 201         cx.tcx
 202             .inherent_impls(id)
 203             .iter()
 204             .any(|imp| cx.tcx.associated_items(*imp).any(|item| is_is_empty(cx, &item)))
 205     }
 206
 207     let ty = &walk_ptrs_ty(cx.tables.expr_ty(expr));
 208     match ty.sty {
 209         ty::TyDynamic(..) => {
 210             cx.tcx
 211                 .associated_items(ty.ty_to_def_id().expect("trait impl not found"))
 212                 .any(|item| is_is_empty(cx, &item))
 213         },
 214         ty::TyProjection(_) => ty.ty_to_def_id().map_or(false, |id| has_is_empty_impl(cx, id)),
 215         ty::TyAdt(id, _) => has_is_empty_impl(cx, id.did),
 216         ty::TyArray(..) | ty::TySlice(..) | ty::TyStr => true,
 217         _ => false,
 218     }
 219 }