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