1 use crate::utils::{get_item_name, in_macro, snippet_with_applicability, span_lint, span_lint_and_sugg, walk_ptrs_ty};
2 use rustc::hir::def_id::DefId;
4 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
6 use rustc::{declare_lint_pass, declare_tool_lint};
7 use rustc_data_structures::fx::FxHashSet;
8 use rustc_errors::Applicability;
9 use syntax::ast::{Lit, LitKind, Name};
10 use syntax::source_map::{Span, Spanned};
12 declare_clippy_lint! {
13 /// **What it does:** Checks for getting the length of something via `.len()`
14 /// just to compare to zero, and suggests using `.is_empty()` where applicable.
16 /// **Why is this bad?** Some structures can answer `.is_empty()` much faster
17 /// than calculating their length. Notably, for slices, getting the length
18 /// requires a subtraction whereas `.is_empty()` is just a comparison. So it is
19 /// good to get into the habit of using `.is_empty()`, and having it is cheap.
20 /// Besides, it makes the intent clearer than a manual comparison.
22 /// **Known problems:** None.
38 /// if !y.is_empty() {
44 "checking `.len() == 0` or `.len() > 0` (or similar) when `.is_empty()` could be used instead"
47 declare_clippy_lint! {
48 /// **What it does:** Checks for items that implement `.len()` but not
51 /// **Why is this bad?** It is good custom to have both methods, because for
52 /// some data structures, asking about the length will be a costly operation,
53 /// whereas `.is_empty()` can usually answer in constant time. Also it used to
54 /// lead to false positives on the [`len_zero`](#len_zero) lint – currently that
55 /// lint will ignore such entities.
57 /// **Known problems:** None.
62 /// pub fn len(&self) -> usize {
67 pub LEN_WITHOUT_IS_EMPTY,
69 "traits or impls with a public `len` method but no corresponding `is_empty` method"
72 declare_lint_pass!(LenZero => [LEN_ZERO, LEN_WITHOUT_IS_EMPTY]);
74 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for LenZero {
75 fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, item: &'tcx Item) {
76 if in_macro(item.span) {
81 ItemKind::Trait(_, _, _, _, ref trait_items) => check_trait_items(cx, item, trait_items),
82 ItemKind::Impl(_, _, _, _, None, _, ref impl_items) => check_impl_items(cx, item, impl_items),
87 fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
88 if in_macro(expr.span) {
92 if let ExprKind::Binary(Spanned { node: cmp, .. }, ref left, ref right) = expr.node {
95 check_cmp(cx, expr.span, left, right, "", 0); // len == 0
96 check_cmp(cx, expr.span, right, left, "", 0); // 0 == len
99 check_cmp(cx, expr.span, left, right, "!", 0); // len != 0
100 check_cmp(cx, expr.span, right, left, "!", 0); // 0 != len
103 check_cmp(cx, expr.span, left, right, "!", 0); // len > 0
104 check_cmp(cx, expr.span, right, left, "", 1); // 1 > len
107 check_cmp(cx, expr.span, left, right, "", 1); // len < 1
108 check_cmp(cx, expr.span, right, left, "!", 0); // 0 < len
110 BinOpKind::Ge => check_cmp(cx, expr.span, left, right, "!", 1), // len >= 1
111 BinOpKind::Le => check_cmp(cx, expr.span, right, left, "!", 1), // 1 <= len
118 fn check_trait_items(cx: &LateContext<'_, '_>, visited_trait: &Item, trait_items: &[TraitItemRef]) {
119 fn is_named_self(cx: &LateContext<'_, '_>, item: &TraitItemRef, name: &str) -> bool {
120 item.ident.name == name
121 && if let AssociatedItemKind::Method { has_self } = item.kind {
123 let did = cx.tcx.hir().local_def_id_from_hir_id(item.id.hir_id);
124 cx.tcx.fn_sig(did).inputs().skip_binder().len() == 1
131 // fill the set with current and super traits
132 fn fill_trait_set(traitt: DefId, set: &mut FxHashSet<DefId>, cx: &LateContext<'_, '_>) {
133 if set.insert(traitt) {
134 for supertrait in rustc::traits::supertrait_def_ids(cx.tcx, traitt) {
135 fill_trait_set(supertrait, set, cx);
140 if cx.access_levels.is_exported(visited_trait.hir_id) && trait_items.iter().any(|i| is_named_self(cx, i, "len")) {
141 let mut current_and_super_traits = FxHashSet::default();
142 let visited_trait_def_id = cx.tcx.hir().local_def_id_from_hir_id(visited_trait.hir_id);
143 fill_trait_set(visited_trait_def_id, &mut current_and_super_traits, cx);
145 let is_empty_method_found = current_and_super_traits
147 .flat_map(|&i| cx.tcx.associated_items(i))
149 i.kind == ty::AssociatedKind::Method
150 && i.method_has_self_argument
151 && i.ident.name == "is_empty"
152 && cx.tcx.fn_sig(i.def_id).inputs().skip_binder().len() == 1
155 if !is_empty_method_found {
158 LEN_WITHOUT_IS_EMPTY,
161 "trait `{}` has a `len` method but no (possibly inherited) `is_empty` method",
162 visited_trait.ident.name
169 fn check_impl_items(cx: &LateContext<'_, '_>, item: &Item, impl_items: &[ImplItemRef]) {
170 fn is_named_self(cx: &LateContext<'_, '_>, item: &ImplItemRef, name: &str) -> bool {
171 item.ident.name == name
172 && if let AssociatedItemKind::Method { has_self } = item.kind {
174 let did = cx.tcx.hir().local_def_id_from_hir_id(item.id.hir_id);
175 cx.tcx.fn_sig(did).inputs().skip_binder().len() == 1
182 let is_empty = if let Some(is_empty) = impl_items.iter().find(|i| is_named_self(cx, i, "is_empty")) {
183 if cx.access_levels.is_exported(is_empty.id.hir_id) {
192 if let Some(i) = impl_items.iter().find(|i| is_named_self(cx, i, "len")) {
193 if cx.access_levels.is_exported(i.id.hir_id) {
194 let def_id = cx.tcx.hir().local_def_id_from_hir_id(item.hir_id);
195 let ty = cx.tcx.type_of(def_id);
199 LEN_WITHOUT_IS_EMPTY,
202 "item `{}` has a public `len` method but {} `is_empty` method",
210 fn check_cmp(cx: &LateContext<'_, '_>, span: Span, method: &Expr, lit: &Expr, op: &str, compare_to: u32) {
211 if let (&ExprKind::MethodCall(ref method_path, _, ref args), &ExprKind::Lit(ref lit)) = (&method.node, &lit.node) {
212 // check if we are in an is_empty() method
213 if let Some(name) = get_item_name(cx, method) {
214 if name == "is_empty" {
219 check_len(cx, span, method_path.ident.name, args, lit, op, compare_to)
224 cx: &LateContext<'_, '_>,
233 node: LitKind::Int(lit, _),
237 // check if length is compared to the specified number
238 if lit != u128::from(compare_to) {
242 if method_name == "len" && args.len() == 1 && has_is_empty(cx, &args[0]) {
243 let mut applicability = Applicability::MachineApplicable;
248 &format!("length comparison to {}", if compare_to == 0 { "zero" } else { "one" }),
249 "using `is_empty` is clearer and more explicit",
253 snippet_with_applicability(cx, args[0].span, "_", &mut applicability)
261 /// Checks if this type has an `is_empty` method.
262 fn has_is_empty(cx: &LateContext<'_, '_>, expr: &Expr) -> bool {
263 /// Gets an `AssociatedItem` and return true if it matches `is_empty(self)`.
264 fn is_is_empty(cx: &LateContext<'_, '_>, item: &ty::AssociatedItem) -> bool {
265 if let ty::AssociatedKind::Method = item.kind {
266 if item.ident.name == "is_empty" {
267 let sig = cx.tcx.fn_sig(item.def_id);
268 let ty = sig.skip_binder();
269 ty.inputs().len() == 1
278 /// Checks the inherent impl's items for an `is_empty(self)` method.
279 fn has_is_empty_impl(cx: &LateContext<'_, '_>, id: DefId) -> bool {
283 .any(|imp| cx.tcx.associated_items(*imp).any(|item| is_is_empty(cx, &item)))
286 let ty = &walk_ptrs_ty(cx.tables.expr_ty(expr));
288 ty::Dynamic(ref tt, ..) => {
289 if let Some(principal) = tt.principal() {
291 .associated_items(principal.def_id())
292 .any(|item| is_is_empty(cx, &item))
297 ty::Projection(ref proj) => has_is_empty_impl(cx, proj.item_def_id),
298 ty::Adt(id, _) => has_is_empty_impl(cx, id.did),
299 ty::Array(..) | ty::Slice(..) | ty::Str => true,