1 use crate::reexport::*;
2 use if_chain::if_chain;
3 use itertools::Itertools;
4 use rustc::hir::def::Def;
5 use rustc::hir::def_id;
6 use rustc::hir::intravisit::{walk_block, walk_expr, walk_pat, walk_stmt, NestedVisitorMap, Visitor};
8 use rustc::lint::{in_external_macro, LateContext, LateLintPass, LintArray, LintContext, LintPass};
9 use rustc::middle::region;
10 use rustc::{declare_tool_lint, lint_array};
11 // use rustc::middle::region::CodeExtent;
12 use crate::consts::{constant, Constant};
13 use crate::utils::usage::mutated_variables;
14 use crate::utils::{in_macro, sext, sugg};
15 use rustc::middle::expr_use_visitor::*;
16 use rustc::middle::mem_categorization::cmt_;
17 use rustc::middle::mem_categorization::Categorization;
18 use rustc::ty::subst::Subst;
19 use rustc::ty::{self, Ty};
20 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
21 use rustc_errors::Applicability;
22 use std::iter::{once, Iterator};
25 use syntax::source_map::Span;
26 use syntax_pos::BytePos;
28 use crate::utils::paths;
30 get_enclosing_block, get_parent_expr, has_iter_method, higher, is_integer_literal, is_refutable, last_path_segment,
31 match_trait_method, match_type, match_var, multispan_sugg, snippet, snippet_opt, snippet_with_applicability,
32 span_help_and_lint, span_lint, span_lint_and_sugg, span_lint_and_then, SpanlessEq,
35 declare_clippy_lint! {
36 /// **What it does:** Checks for for-loops that manually copy items between
37 /// slices that could be optimized by having a memcpy.
39 /// **Why is this bad?** It is not as fast as a memcpy.
41 /// **Known problems:** None.
45 /// for i in 0..src.len() {
46 /// dst[i + 64] = src[i];
51 "manually copying items between slices"
54 declare_clippy_lint! {
55 /// **What it does:** Checks for looping over the range of `0..len` of some
56 /// collection just to get the values by index.
58 /// **Why is this bad?** Just iterating the collection itself makes the intent
59 /// more clear and is probably faster.
61 /// **Known problems:** None.
65 /// for i in 0..vec.len() {
66 /// println!("{}", vec[i]);
69 pub NEEDLESS_RANGE_LOOP,
71 "for-looping over a range of indices where an iterator over items would do"
74 declare_clippy_lint! {
75 /// **What it does:** Checks for loops on `x.iter()` where `&x` will do, and
76 /// suggests the latter.
78 /// **Why is this bad?** Readability.
80 /// **Known problems:** False negatives. We currently only warn on some known
85 /// // with `y` a `Vec` or slice:
86 /// for x in y.iter() {
90 /// can be rewritten to
96 pub EXPLICIT_ITER_LOOP,
98 "for-looping over `_.iter()` or `_.iter_mut()` when `&_` or `&mut _` would do"
101 declare_clippy_lint! {
102 /// **What it does:** Checks for loops on `y.into_iter()` where `y` will do, and
103 /// suggests the latter.
105 /// **Why is this bad?** Readability.
107 /// **Known problems:** None
111 /// // with `y` a `Vec` or slice:
112 /// for x in y.into_iter() {
116 /// can be rewritten to
122 pub EXPLICIT_INTO_ITER_LOOP,
124 "for-looping over `_.into_iter()` when `_` would do"
127 declare_clippy_lint! {
128 /// **What it does:** Checks for loops on `x.next()`.
130 /// **Why is this bad?** `next()` returns either `Some(value)` if there was a
131 /// value, or `None` otherwise. The insidious thing is that `Option<_>`
132 /// implements `IntoIterator`, so that possibly one value will be iterated,
133 /// leading to some hard to find bugs. No one will want to write such code
134 /// [except to win an Underhanded Rust
135 /// Contest](https://www.reddit.com/r/rust/comments/3hb0wm/underhanded_rust_contest/cu5yuhr).
137 /// **Known problems:** None.
141 /// for x in y.next() {
147 "for-looping over `_.next()` which is probably not intended"
150 declare_clippy_lint! {
151 /// **What it does:** Checks for `for` loops over `Option` values.
153 /// **Why is this bad?** Readability. This is more clearly expressed as an `if
156 /// **Known problems:** None.
160 /// for x in option {
167 /// if let Some(x) = option {
171 pub FOR_LOOP_OVER_OPTION,
173 "for-looping over an `Option`, which is more clearly expressed as an `if let`"
176 declare_clippy_lint! {
177 /// **What it does:** Checks for `for` loops over `Result` values.
179 /// **Why is this bad?** Readability. This is more clearly expressed as an `if
182 /// **Known problems:** None.
186 /// for x in result {
193 /// if let Ok(x) = result {
197 pub FOR_LOOP_OVER_RESULT,
199 "for-looping over a `Result`, which is more clearly expressed as an `if let`"
202 declare_clippy_lint! {
203 /// **What it does:** Detects `loop + match` combinations that are easier
204 /// written as a `while let` loop.
206 /// **Why is this bad?** The `while let` loop is usually shorter and more
209 /// **Known problems:** Sometimes the wrong binding is displayed (#383).
214 /// let x = match y {
218 /// // .. do something with x
220 /// // is easier written as
221 /// while let Some(x) = y {
222 /// // .. do something with x
227 "`loop { if let { ... } else break }`, which can be written as a `while let` loop"
230 declare_clippy_lint! {
231 /// **What it does:** Checks for using `collect()` on an iterator without using
234 /// **Why is this bad?** It is more idiomatic to use a `for` loop over the
235 /// iterator instead.
237 /// **Known problems:** None.
241 /// vec.iter().map(|x| /* some operation returning () */).collect::<Vec<_>>();
245 "`collect()`ing an iterator without using the result; this is usually better written as a for loop"
248 declare_clippy_lint! {
249 /// **What it does:** Checks for functions collecting an iterator when collect
252 /// **Why is this bad?** `collect` causes the allocation of a new data structure,
253 /// when this allocation may not be needed.
255 /// **Known problems:**
260 /// let len = iterator.collect::<Vec<_>>().len();
262 /// let len = iterator.count();
264 pub NEEDLESS_COLLECT,
266 "collecting an iterator when collect is not needed"
269 declare_clippy_lint! {
270 /// **What it does:** Checks for loops over ranges `x..y` where both `x` and `y`
271 /// are constant and `x` is greater or equal to `y`, unless the range is
272 /// reversed or has a negative `.step_by(_)`.
274 /// **Why is it bad?** Such loops will either be skipped or loop until
275 /// wrap-around (in debug code, this may `panic!()`). Both options are probably
278 /// **Known problems:** The lint cannot catch loops over dynamically defined
279 /// ranges. Doing this would require simulating all possible inputs and code
280 /// paths through the program, which would be complex and error-prone.
284 /// for x in 5..10 - 5 {
286 /// } // oops, stray `-`
288 pub REVERSE_RANGE_LOOP,
290 "iteration over an empty range, such as `10..0` or `5..5`"
293 declare_clippy_lint! {
294 /// **What it does:** Checks `for` loops over slices with an explicit counter
295 /// and suggests the use of `.enumerate()`.
297 /// **Why is it bad?** Not only is the version using `.enumerate()` more
298 /// readable, the compiler is able to remove bounds checks which can lead to
299 /// faster code in some instances.
301 /// **Known problems:** None.
305 /// for i in 0..v.len() { foo(v[i]);
306 /// for i in 0..v.len() { bar(i, v[i]); }
308 pub EXPLICIT_COUNTER_LOOP,
310 "for-looping with an explicit counter when `_.enumerate()` would do"
313 declare_clippy_lint! {
314 /// **What it does:** Checks for empty `loop` expressions.
316 /// **Why is this bad?** Those busy loops burn CPU cycles without doing
317 /// anything. Think of the environment and either block on something or at least
318 /// make the thread sleep for some microseconds.
320 /// **Known problems:** None.
328 "empty `loop {}`, which should block or sleep"
331 declare_clippy_lint! {
332 /// **What it does:** Checks for `while let` expressions on iterators.
334 /// **Why is this bad?** Readability. A simple `for` loop is shorter and conveys
335 /// the intent better.
337 /// **Known problems:** None.
341 /// while let Some(val) = iter() {
345 pub WHILE_LET_ON_ITERATOR,
347 "using a while-let loop instead of a for loop on an iterator"
350 declare_clippy_lint! {
351 /// **What it does:** Checks for iterating a map (`HashMap` or `BTreeMap`) and
352 /// ignoring either the keys or values.
354 /// **Why is this bad?** Readability. There are `keys` and `values` methods that
355 /// can be used to express that don't need the values or keys.
357 /// **Known problems:** None.
361 /// for (k, _) in &map {
366 /// could be replaced by
369 /// for k in map.keys() {
375 "looping on a map using `iter` when `keys` or `values` would do"
378 declare_clippy_lint! {
379 /// **What it does:** Checks for loops that will always `break`, `return` or
380 /// `continue` an outer loop.
382 /// **Why is this bad?** This loop never loops, all it does is obfuscating the
385 /// **Known problems:** None
396 "any loop that will always `break` or `return`"
399 declare_clippy_lint! {
400 /// **What it does:** Checks for loops which have a range bound that is a mutable variable
402 /// **Why is this bad?** One might think that modifying the mutable variable changes the loop bounds
404 /// **Known problems:** None
408 /// let mut foo = 42;
409 /// for i in 0..foo {
411 /// println!("{}", i); // prints numbers from 0 to 42, not 0 to 21
416 "for loop over a range where one of the bounds is a mutable variable"
419 declare_clippy_lint! {
420 /// **What it does:** Checks whether variables used within while loop condition
421 /// can be (and are) mutated in the body.
423 /// **Why is this bad?** If the condition is unchanged, entering the body of the loop
424 /// will lead to an infinite loop.
426 /// **Known problems:** If the `while`-loop is in a closure, the check for mutation of the
427 /// condition variables in the body can cause false negatives. For example when only `Upvar` `a` is
428 /// in the condition and only `Upvar` `b` gets mutated in the body, the lint will not trigger.
434 /// println!("let me loop forever!");
437 pub WHILE_IMMUTABLE_CONDITION,
439 "variables used within while expression are not mutated in the body"
442 #[derive(Copy, Clone)]
445 impl LintPass for Pass {
446 fn get_lints(&self) -> LintArray {
451 EXPLICIT_INTO_ITER_LOOP,
453 FOR_LOOP_OVER_RESULT,
454 FOR_LOOP_OVER_OPTION,
459 EXPLICIT_COUNTER_LOOP,
461 WHILE_LET_ON_ITERATOR,
465 WHILE_IMMUTABLE_CONDITION,
469 fn name(&self) -> &'static str {
474 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Pass {
475 #[allow(clippy::too_many_lines)]
476 fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
477 // we don't want to check expanded macros
478 if in_macro(expr.span) {
482 if let Some((pat, arg, body)) = higher::for_loop(expr) {
483 check_for_loop(cx, pat, arg, body, expr);
486 // check for never_loop
488 ExprKind::While(_, ref block, _) | ExprKind::Loop(ref block, _, _) => {
489 let node_id = cx.tcx.hir().hir_to_node_id(expr.hir_id);
490 match never_loop_block(block, node_id) {
491 NeverLoopResult::AlwaysBreak => {
492 span_lint(cx, NEVER_LOOP, expr.span, "this loop never actually loops")
494 NeverLoopResult::MayContinueMainLoop | NeverLoopResult::Otherwise => (),
500 // check for `loop { if let {} else break }` that could be `while let`
501 // (also matches an explicit "match" instead of "if let")
502 // (even if the "match" or "if let" is used for declaration)
503 if let ExprKind::Loop(ref block, _, LoopSource::Loop) = expr.node {
504 // also check for empty `loop {}` statements
505 if block.stmts.is_empty() && block.expr.is_none() {
510 "empty `loop {}` detected. You may want to either use `panic!()` or add \
511 `std::thread::sleep(..);` to the loop body.",
515 // extract the expression from the first statement (if any) in a block
516 let inner_stmt_expr = extract_expr_from_first_stmt(block);
517 // or extract the first expression (if any) from the block
518 if let Some(inner) = inner_stmt_expr.or_else(|| extract_first_expr(block)) {
519 if let ExprKind::Match(ref matchexpr, ref arms, ref source) = inner.node {
520 // ensure "if let" compatible match structure
522 MatchSource::Normal | MatchSource::IfLetDesugar { .. } => {
524 && arms[0].pats.len() == 1
525 && arms[0].guard.is_none()
526 && arms[1].pats.len() == 1
527 && arms[1].guard.is_none()
528 && is_simple_break_expr(&arms[1].body)
530 if in_external_macro(cx.sess(), expr.span) {
534 // NOTE: we used to make build a body here instead of using
535 // ellipsis, this was removed because:
536 // 1) it was ugly with big bodies;
537 // 2) it was not indented properly;
538 // 3) it wasn’t very smart (see #675).
539 let mut applicability = Applicability::MachineApplicable;
544 "this loop could be written as a `while let` loop",
547 "while let {} = {} {{ .. }}",
548 snippet_with_applicability(cx, arms[0].pats[0].span, "..", &mut applicability),
549 snippet_with_applicability(cx, matchexpr.span, "..", &mut applicability),
560 if let ExprKind::Match(ref match_expr, ref arms, MatchSource::WhileLetDesugar) = expr.node {
561 let pat = &arms[0].pats[0].node;
563 &PatKind::TupleStruct(ref qpath, ref pat_args, _),
564 &ExprKind::MethodCall(ref method_path, _, ref method_args),
565 ) = (pat, &match_expr.node)
567 let iter_expr = &method_args[0];
568 let lhs_constructor = last_path_segment(qpath);
569 if method_path.ident.name == "next"
570 && match_trait_method(cx, match_expr, &paths::ITERATOR)
571 && lhs_constructor.ident.name == "Some"
572 && (pat_args.is_empty()
573 || !is_refutable(cx, &pat_args[0])
574 && !is_used_inside(cx, iter_expr, &arms[0].body)
575 && !is_iterator_used_after_while_let(cx, iter_expr)
576 && !is_nested(cx, expr, &method_args[0]))
578 let iterator = snippet(cx, method_args[0].span, "_");
579 let loop_var = if pat_args.is_empty() {
582 snippet(cx, pat_args[0].span, "_").into_owned()
586 WHILE_LET_ON_ITERATOR,
588 "this loop could be written as a `for` loop",
590 format!("for {} in {} {{ .. }}", loop_var, iterator),
591 Applicability::HasPlaceholders,
597 // check for while loops which conditions never change
598 if let ExprKind::While(ref cond, _, _) = expr.node {
599 check_infinite_loop(cx, cond, expr);
602 check_needless_collect(expr, cx);
605 fn check_stmt(&mut self, cx: &LateContext<'a, 'tcx>, stmt: &'tcx Stmt) {
606 if let StmtKind::Semi(ref expr) = stmt.node {
607 if let ExprKind::MethodCall(ref method, _, ref args) = expr.node {
608 if args.len() == 1 && method.ident.name == "collect" && match_trait_method(cx, expr, &paths::ITERATOR) {
613 "you are collect()ing an iterator and throwing away the result. \
614 Consider using an explicit for loop to exhaust the iterator",
622 enum NeverLoopResult {
623 // A break/return always get triggered but not necessarily for the main loop.
625 // A continue may occur for the main loop.
630 fn absorb_break(arg: &NeverLoopResult) -> NeverLoopResult {
632 NeverLoopResult::AlwaysBreak | NeverLoopResult::Otherwise => NeverLoopResult::Otherwise,
633 NeverLoopResult::MayContinueMainLoop => NeverLoopResult::MayContinueMainLoop,
637 // Combine two results for parts that are called in order.
638 fn combine_seq(first: NeverLoopResult, second: NeverLoopResult) -> NeverLoopResult {
640 NeverLoopResult::AlwaysBreak | NeverLoopResult::MayContinueMainLoop => first,
641 NeverLoopResult::Otherwise => second,
645 // Combine two results where both parts are called but not necessarily in order.
646 fn combine_both(left: NeverLoopResult, right: NeverLoopResult) -> NeverLoopResult {
647 match (left, right) {
648 (NeverLoopResult::MayContinueMainLoop, _) | (_, NeverLoopResult::MayContinueMainLoop) => {
649 NeverLoopResult::MayContinueMainLoop
651 (NeverLoopResult::AlwaysBreak, _) | (_, NeverLoopResult::AlwaysBreak) => NeverLoopResult::AlwaysBreak,
652 (NeverLoopResult::Otherwise, NeverLoopResult::Otherwise) => NeverLoopResult::Otherwise,
656 // Combine two results where only one of the part may have been executed.
657 fn combine_branches(b1: NeverLoopResult, b2: NeverLoopResult) -> NeverLoopResult {
659 (NeverLoopResult::AlwaysBreak, NeverLoopResult::AlwaysBreak) => NeverLoopResult::AlwaysBreak,
660 (NeverLoopResult::MayContinueMainLoop, _) | (_, NeverLoopResult::MayContinueMainLoop) => {
661 NeverLoopResult::MayContinueMainLoop
663 (NeverLoopResult::Otherwise, _) | (_, NeverLoopResult::Otherwise) => NeverLoopResult::Otherwise,
667 fn never_loop_block(block: &Block, main_loop_id: NodeId) -> NeverLoopResult {
668 let stmts = block.stmts.iter().map(stmt_to_expr);
669 let expr = once(block.expr.as_ref().map(|p| &**p));
670 let mut iter = stmts.chain(expr).filter_map(|e| e);
671 never_loop_expr_seq(&mut iter, main_loop_id)
674 fn stmt_to_expr(stmt: &Stmt) -> Option<&Expr> {
676 StmtKind::Semi(ref e, ..) | StmtKind::Expr(ref e, ..) => Some(e),
677 StmtKind::Local(ref local) => local.init.as_ref().map(|p| &**p),
682 fn never_loop_expr(expr: &Expr, main_loop_id: NodeId) -> NeverLoopResult {
685 | ExprKind::Unary(_, ref e)
686 | ExprKind::Cast(ref e, _)
687 | ExprKind::Type(ref e, _)
688 | ExprKind::Field(ref e, _)
689 | ExprKind::AddrOf(_, ref e)
690 | ExprKind::Struct(_, _, Some(ref e))
691 | ExprKind::Repeat(ref e, _) => never_loop_expr(e, main_loop_id),
692 ExprKind::Array(ref es) | ExprKind::MethodCall(_, _, ref es) | ExprKind::Tup(ref es) => {
693 never_loop_expr_all(&mut es.iter(), main_loop_id)
695 ExprKind::Call(ref e, ref es) => never_loop_expr_all(&mut once(&**e).chain(es.iter()), main_loop_id),
696 ExprKind::Binary(_, ref e1, ref e2)
697 | ExprKind::Assign(ref e1, ref e2)
698 | ExprKind::AssignOp(_, ref e1, ref e2)
699 | ExprKind::Index(ref e1, ref e2) => never_loop_expr_all(&mut [&**e1, &**e2].iter().cloned(), main_loop_id),
700 ExprKind::If(ref e, ref e2, ref e3) => {
701 let e1 = never_loop_expr(e, main_loop_id);
702 let e2 = never_loop_expr(e2, main_loop_id);
705 .map_or(NeverLoopResult::Otherwise, |e| never_loop_expr(e, main_loop_id));
706 combine_seq(e1, combine_branches(e2, e3))
708 ExprKind::Loop(ref b, _, _) => {
709 // Break can come from the inner loop so remove them.
710 absorb_break(&never_loop_block(b, main_loop_id))
712 ExprKind::While(ref e, ref b, _) => {
713 let e = never_loop_expr(e, main_loop_id);
714 let result = never_loop_block(b, main_loop_id);
715 // Break can come from the inner loop so remove them.
716 combine_seq(e, absorb_break(&result))
718 ExprKind::Match(ref e, ref arms, _) => {
719 let e = never_loop_expr(e, main_loop_id);
723 let arms = never_loop_expr_branch(&mut arms.iter().map(|a| &*a.body), main_loop_id);
727 ExprKind::Block(ref b, _) => never_loop_block(b, main_loop_id),
728 ExprKind::Continue(d) => {
731 .expect("target id can only be missing in the presence of compilation errors");
732 if id == main_loop_id {
733 NeverLoopResult::MayContinueMainLoop
735 NeverLoopResult::AlwaysBreak
738 ExprKind::Break(_, _) => NeverLoopResult::AlwaysBreak,
739 ExprKind::Ret(ref e) => {
740 if let Some(ref e) = *e {
741 combine_seq(never_loop_expr(e, main_loop_id), NeverLoopResult::AlwaysBreak)
743 NeverLoopResult::AlwaysBreak
746 ExprKind::Struct(_, _, None)
748 | ExprKind::Closure(_, _, _, _, _)
749 | ExprKind::InlineAsm(_, _, _)
752 | ExprKind::Err => NeverLoopResult::Otherwise,
756 fn never_loop_expr_seq<'a, T: Iterator<Item = &'a Expr>>(es: &mut T, main_loop_id: NodeId) -> NeverLoopResult {
757 es.map(|e| never_loop_expr(e, main_loop_id))
758 .fold(NeverLoopResult::Otherwise, combine_seq)
761 fn never_loop_expr_all<'a, T: Iterator<Item = &'a Expr>>(es: &mut T, main_loop_id: NodeId) -> NeverLoopResult {
762 es.map(|e| never_loop_expr(e, main_loop_id))
763 .fold(NeverLoopResult::Otherwise, combine_both)
766 fn never_loop_expr_branch<'a, T: Iterator<Item = &'a Expr>>(e: &mut T, main_loop_id: NodeId) -> NeverLoopResult {
767 e.map(|e| never_loop_expr(e, main_loop_id))
768 .fold(NeverLoopResult::AlwaysBreak, combine_branches)
771 fn check_for_loop<'a, 'tcx>(
772 cx: &LateContext<'a, 'tcx>,
778 check_for_loop_range(cx, pat, arg, body, expr);
779 check_for_loop_reverse_range(cx, arg, expr);
780 check_for_loop_arg(cx, pat, arg, expr);
781 check_for_loop_explicit_counter(cx, arg, body, expr);
782 check_for_loop_over_map_kv(cx, pat, arg, body, expr);
783 check_for_mut_range_bound(cx, arg, body);
784 detect_manual_memcpy(cx, pat, arg, body, expr);
787 fn same_var<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &Expr, var: ast::NodeId) -> bool {
789 if let ExprKind::Path(ref qpath) = expr.node;
790 if let QPath::Resolved(None, ref path) = *qpath;
791 if path.segments.len() == 1;
792 if let Def::Local(local_id) = cx.tables.qpath_def(qpath, expr.hir_id);
809 fn negative(s: String) -> Self {
810 Self { value: s, negate: true }
813 fn positive(s: String) -> Self {
821 struct FixedOffsetVar {
826 fn is_slice_like<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'_>) -> bool {
827 let is_slice = match ty.sty {
828 ty::Ref(_, subty, _) => is_slice_like(cx, subty),
829 ty::Slice(..) | ty::Array(..) => true,
833 is_slice || match_type(cx, ty, &paths::VEC) || match_type(cx, ty, &paths::VEC_DEQUE)
836 fn get_fixed_offset_var<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &Expr, var: ast::NodeId) -> Option<FixedOffsetVar> {
837 fn extract_offset<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, e: &Expr, var: ast::NodeId) -> Option<String> {
839 ExprKind::Lit(ref l) => match l.node {
840 ast::LitKind::Int(x, _ty) => Some(x.to_string()),
843 ExprKind::Path(..) if !same_var(cx, e, var) => Some(snippet_opt(cx, e.span).unwrap_or_else(|| "??".into())),
848 if let ExprKind::Index(ref seqexpr, ref idx) = expr.node {
849 let ty = cx.tables.expr_ty(seqexpr);
850 if !is_slice_like(cx, ty) {
854 let offset = match idx.node {
855 ExprKind::Binary(op, ref lhs, ref rhs) => match op.node {
857 let offset_opt = if same_var(cx, lhs, var) {
858 extract_offset(cx, rhs, var)
859 } else if same_var(cx, rhs, var) {
860 extract_offset(cx, lhs, var)
865 offset_opt.map(Offset::positive)
867 BinOpKind::Sub if same_var(cx, lhs, var) => extract_offset(cx, rhs, var).map(Offset::negative),
870 ExprKind::Path(..) => {
871 if same_var(cx, idx, var) {
872 Some(Offset::positive("0".into()))
880 offset.map(|o| FixedOffsetVar {
881 var_name: snippet_opt(cx, seqexpr.span).unwrap_or_else(|| "???".into()),
889 fn fetch_cloned_fixed_offset_var<'a, 'tcx>(
890 cx: &LateContext<'a, 'tcx>,
893 ) -> Option<FixedOffsetVar> {
895 if let ExprKind::MethodCall(ref method, _, ref args) = expr.node;
896 if method.ident.name == "clone";
898 if let Some(arg) = args.get(0);
900 return get_fixed_offset_var(cx, arg, var);
904 get_fixed_offset_var(cx, expr, var)
907 fn get_indexed_assignments<'a, 'tcx>(
908 cx: &LateContext<'a, 'tcx>,
911 ) -> Vec<(FixedOffsetVar, FixedOffsetVar)> {
912 fn get_assignment<'a, 'tcx>(
913 cx: &LateContext<'a, 'tcx>,
916 ) -> Option<(FixedOffsetVar, FixedOffsetVar)> {
917 if let ExprKind::Assign(ref lhs, ref rhs) = e.node {
919 get_fixed_offset_var(cx, lhs, var),
920 fetch_cloned_fixed_offset_var(cx, rhs, var),
922 (Some(offset_left), Some(offset_right)) => {
923 // Source and destination must be different
924 if offset_left.var_name == offset_right.var_name {
927 Some((offset_left, offset_right))
937 if let ExprKind::Block(ref b, _) = body.node {
939 ref stmts, ref expr, ..
944 .map(|stmt| match stmt.node {
945 StmtKind::Local(..) | StmtKind::Item(..) => None,
946 StmtKind::Expr(ref e) | StmtKind::Semi(ref e) => Some(get_assignment(cx, e, var)),
948 .chain(expr.as_ref().into_iter().map(|e| Some(get_assignment(cx, &*e, var))))
950 .collect::<Option<Vec<_>>>()
951 .unwrap_or_else(|| vec![])
953 get_assignment(cx, body, var).into_iter().collect()
957 /// Check for for loops that sequentially copy items from one slice-like
958 /// object to another.
959 fn detect_manual_memcpy<'a, 'tcx>(
960 cx: &LateContext<'a, 'tcx>,
966 if let Some(higher::Range {
970 }) = higher::range(cx, arg)
972 // the var must be a single name
973 if let PatKind::Binding(_, canonical_id, _, _, _) = pat.node {
974 let print_sum = |arg1: &Offset, arg2: &Offset| -> String {
975 match (&arg1.value[..], arg1.negate, &arg2.value[..], arg2.negate) {
976 ("0", _, "0", _) => "".into(),
977 ("0", _, x, false) | (x, false, "0", false) => x.into(),
978 ("0", _, x, true) | (x, false, "0", true) => format!("-{}", x),
979 (x, false, y, false) => format!("({} + {})", x, y),
980 (x, false, y, true) => {
984 format!("({} - {})", x, y)
987 (x, true, y, false) => {
991 format!("({} - {})", y, x)
994 (x, true, y, true) => format!("-({} + {})", x, y),
998 let print_limit = |end: &Option<&Expr>, offset: Offset, var_name: &str| {
999 if let Some(end) = *end {
1001 if let ExprKind::MethodCall(ref method, _, ref len_args) = end.node;
1002 if method.ident.name == "len";
1003 if len_args.len() == 1;
1004 if let Some(arg) = len_args.get(0);
1005 if snippet(cx, arg.span, "??") == var_name;
1007 return if offset.negate {
1008 format!("({} - {})", snippet(cx, end.span, "<src>.len()"), offset.value)
1015 let end_str = match limits {
1016 ast::RangeLimits::Closed => {
1017 let end = sugg::Sugg::hir(cx, end, "<count>");
1018 format!("{}", end + sugg::ONE)
1020 ast::RangeLimits::HalfOpen => format!("{}", snippet(cx, end.span, "..")),
1023 print_sum(&Offset::positive(end_str), &offset)
1029 // The only statements in the for loops can be indexed assignments from
1030 // indexed retrievals.
1031 let manual_copies = get_indexed_assignments(cx, body, canonical_id);
1033 let big_sugg = manual_copies
1035 .map(|(dst_var, src_var)| {
1036 let start_str = Offset::positive(snippet(cx, start.span, "").to_string());
1037 let dst_offset = print_sum(&start_str, &dst_var.offset);
1038 let dst_limit = print_limit(end, dst_var.offset, &dst_var.var_name);
1039 let src_offset = print_sum(&start_str, &src_var.offset);
1040 let src_limit = print_limit(end, src_var.offset, &src_var.var_name);
1041 let dst = if dst_offset == "" && dst_limit == "" {
1044 format!("{}[{}..{}]", dst_var.var_name, dst_offset, dst_limit)
1048 "{}.clone_from_slice(&{}[{}..{}])",
1049 dst, src_var.var_name, src_offset, src_limit
1054 if !big_sugg.is_empty() {
1059 "it looks like you're manually copying between slices",
1060 "try replacing the loop by",
1062 Applicability::Unspecified,
1069 /// Check for looping over a range and then indexing a sequence with it.
1070 /// The iteratee must be a range literal.
1071 #[allow(clippy::too_many_lines)]
1072 fn check_for_loop_range<'a, 'tcx>(
1073 cx: &LateContext<'a, 'tcx>,
1079 if in_macro(expr.span) {
1083 if let Some(higher::Range {
1087 }) = higher::range(cx, arg)
1089 // the var must be a single name
1090 if let PatKind::Binding(_, canonical_id, _, ident, _) = pat.node {
1091 let mut visitor = VarVisitor {
1094 indexed_mut: FxHashSet::default(),
1095 indexed_indirectly: FxHashMap::default(),
1096 indexed_directly: FxHashMap::default(),
1097 referenced: FxHashSet::default(),
1099 prefer_mutable: false,
1101 walk_expr(&mut visitor, body);
1103 // linting condition: we only indexed one variable, and indexed it directly
1104 if visitor.indexed_indirectly.is_empty() && visitor.indexed_directly.len() == 1 {
1105 let (indexed, (indexed_extent, indexed_ty)) = visitor
1109 .expect("already checked that we have exactly 1 element");
1111 // ensure that the indexed variable was declared before the loop, see #601
1112 if let Some(indexed_extent) = indexed_extent {
1113 let parent_id = cx.tcx.hir().get_parent_item(expr.hir_id);
1114 let parent_def_id = cx.tcx.hir().local_def_id_from_hir_id(parent_id);
1115 let region_scope_tree = cx.tcx.region_scope_tree(parent_def_id);
1116 let pat_extent = region_scope_tree.var_scope(pat.hir_id.local_id);
1117 if region_scope_tree.is_subscope_of(indexed_extent, pat_extent) {
1122 // don't lint if the container that is indexed does not have .iter() method
1123 let has_iter = has_iter_method(cx, indexed_ty);
1124 if has_iter.is_none() {
1128 // don't lint if the container that is indexed into is also used without
1130 if visitor.referenced.contains(&indexed) {
1134 let starts_at_zero = is_integer_literal(start, 0);
1136 let skip = if starts_at_zero {
1139 format!(".skip({})", snippet(cx, start.span, ".."))
1142 let mut end_is_start_plus_val = false;
1144 let take = if let Some(end) = *end {
1145 let mut take_expr = end;
1147 if let ExprKind::Binary(ref op, ref left, ref right) = end.node {
1148 if let BinOpKind::Add = op.node {
1149 let start_equal_left = SpanlessEq::new(cx).eq_expr(start, left);
1150 let start_equal_right = SpanlessEq::new(cx).eq_expr(start, right);
1152 if start_equal_left {
1154 } else if start_equal_right {
1158 end_is_start_plus_val = start_equal_left | start_equal_right;
1162 if is_len_call(end, indexed) || is_end_eq_array_len(cx, end, limits, indexed_ty) {
1166 ast::RangeLimits::Closed => {
1167 let take_expr = sugg::Sugg::hir(cx, take_expr, "<count>");
1168 format!(".take({})", take_expr + sugg::ONE)
1170 ast::RangeLimits::HalfOpen => format!(".take({})", snippet(cx, take_expr.span, "..")),
1177 let (ref_mut, method) = if visitor.indexed_mut.contains(&indexed) {
1178 ("mut ", "iter_mut")
1183 let take_is_empty = take.is_empty();
1184 let mut method_1 = take;
1185 let mut method_2 = skip;
1187 if end_is_start_plus_val {
1188 mem::swap(&mut method_1, &mut method_2);
1191 if visitor.nonindex {
1194 NEEDLESS_RANGE_LOOP,
1196 &format!("the loop variable `{}` is used to index `{}`", ident.name, indexed),
1200 "consider using an iterator".to_string(),
1202 (pat.span, format!("({}, <item>)", ident.name)),
1205 format!("{}.{}().enumerate(){}{}", indexed, method, method_1, method_2),
1212 let repl = if starts_at_zero && take_is_empty {
1213 format!("&{}{}", ref_mut, indexed)
1215 format!("{}.{}(){}{}", indexed, method, method_1, method_2)
1220 NEEDLESS_RANGE_LOOP,
1223 "the loop variable `{}` is only used to index `{}`.",
1229 "consider using an iterator".to_string(),
1230 vec![(pat.span, "<item>".to_string()), (arg.span, repl)],
1240 fn is_len_call(expr: &Expr, var: Name) -> bool {
1242 if let ExprKind::MethodCall(ref method, _, ref len_args) = expr.node;
1243 if len_args.len() == 1;
1244 if method.ident.name == "len";
1245 if let ExprKind::Path(QPath::Resolved(_, ref path)) = len_args[0].node;
1246 if path.segments.len() == 1;
1247 if path.segments[0].ident.name == var;
1256 fn is_end_eq_array_len(cx: &LateContext<'_, '_>, end: &Expr, limits: ast::RangeLimits, indexed_ty: Ty<'_>) -> bool {
1258 if let ExprKind::Lit(ref lit) = end.node;
1259 if let ast::LitKind::Int(end_int, _) = lit.node;
1260 if let ty::Array(_, arr_len_const) = indexed_ty.sty;
1261 if let Some(arr_len) = arr_len_const.assert_usize(cx.tcx);
1263 return match limits {
1264 ast::RangeLimits::Closed => end_int + 1 >= arr_len.into(),
1265 ast::RangeLimits::HalfOpen => end_int >= arr_len.into(),
1273 fn check_for_loop_reverse_range<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, arg: &'tcx Expr, expr: &'tcx Expr) {
1274 // if this for loop is iterating over a two-sided range...
1275 if let Some(higher::Range {
1279 }) = higher::range(cx, arg)
1281 // ...and both sides are compile-time constant integers...
1282 if let Some((start_idx, _)) = constant(cx, cx.tables, start) {
1283 if let Some((end_idx, _)) = constant(cx, cx.tables, end) {
1284 // ...and the start index is greater than the end index,
1285 // this loop will never run. This is often confusing for developers
1286 // who think that this will iterate from the larger value to the
1288 let ty = cx.tables.expr_ty(start);
1289 let (sup, eq) = match (start_idx, end_idx) {
1290 (Constant::Int(start_idx), Constant::Int(end_idx)) => (
1292 ty::Int(ity) => sext(cx.tcx, start_idx, ity) > sext(cx.tcx, end_idx, ity),
1293 ty::Uint(_) => start_idx > end_idx,
1296 start_idx == end_idx,
1298 _ => (false, false),
1302 let start_snippet = snippet(cx, start.span, "_");
1303 let end_snippet = snippet(cx, end.span, "_");
1304 let dots = if limits == ast::RangeLimits::Closed {
1314 "this range is empty so this for loop will never run",
1318 "consider using the following if you are attempting to iterate over this \
1321 "({end}{dots}{start}).rev()",
1324 start = start_snippet
1326 Applicability::MaybeIncorrect,
1330 } else if eq && limits != ast::RangeLimits::Closed {
1331 // if they are equal, it's also problematic - this loop
1337 "this range is empty so this for loop will never run",
1345 fn lint_iter_method(cx: &LateContext<'_, '_>, args: &[Expr], arg: &Expr, method_name: &str) {
1346 let mut applicability = Applicability::MachineApplicable;
1347 let object = snippet_with_applicability(cx, args[0].span, "_", &mut applicability);
1348 let muta = if method_name == "iter_mut" { "mut " } else { "" };
1353 "it is more concise to loop over references to containers instead of using explicit \
1355 "to write this more concisely, try",
1356 format!("&{}{}", muta, object),
1361 fn check_for_loop_arg(cx: &LateContext<'_, '_>, pat: &Pat, arg: &Expr, expr: &Expr) {
1362 let mut next_loop_linted = false; // whether or not ITER_NEXT_LOOP lint was used
1363 if let ExprKind::MethodCall(ref method, _, ref args) = arg.node {
1364 // just the receiver, no arguments
1365 if args.len() == 1 {
1366 let method_name = &*method.ident.as_str();
1367 // check for looping over x.iter() or x.iter_mut(), could use &x or &mut x
1368 if method_name == "iter" || method_name == "iter_mut" {
1369 if is_ref_iterable_type(cx, &args[0]) {
1370 lint_iter_method(cx, args, arg, method_name);
1372 } else if method_name == "into_iter" && match_trait_method(cx, arg, &paths::INTO_ITERATOR) {
1373 let def_id = cx.tables.type_dependent_defs()[arg.hir_id].def_id();
1374 let substs = cx.tables.node_substs(arg.hir_id);
1375 let method_type = cx.tcx.type_of(def_id).subst(cx.tcx, substs);
1377 let fn_arg_tys = method_type.fn_sig(cx.tcx).inputs();
1378 assert_eq!(fn_arg_tys.skip_binder().len(), 1);
1379 if fn_arg_tys.skip_binder()[0].is_region_ptr() {
1380 match cx.tables.expr_ty(&args[0]).sty {
1381 // If the length is greater than 32 no traits are implemented for array and
1382 // therefore we cannot use `&`.
1383 ty::Array(_, size) if size.assert_usize(cx.tcx).expect("array size") > 32 => (),
1384 _ => lint_iter_method(cx, args, arg, method_name),
1387 let mut applicability = Applicability::MachineApplicable;
1388 let object = snippet_with_applicability(cx, args[0].span, "_", &mut applicability);
1391 EXPLICIT_INTO_ITER_LOOP,
1393 "it is more concise to loop over containers instead of using explicit \
1394 iteration methods`",
1395 "to write this more concisely, try",
1400 } else if method_name == "next" && match_trait_method(cx, arg, &paths::ITERATOR) {
1405 "you are iterating over `Iterator::next()` which is an Option; this will compile but is \
1406 probably not what you want",
1408 next_loop_linted = true;
1412 if !next_loop_linted {
1413 check_arg_type(cx, pat, arg);
1417 /// Check for `for` loops over `Option`s and `Results`
1418 fn check_arg_type(cx: &LateContext<'_, '_>, pat: &Pat, arg: &Expr) {
1419 let ty = cx.tables.expr_ty(arg);
1420 if match_type(cx, ty, &paths::OPTION) {
1423 FOR_LOOP_OVER_OPTION,
1426 "for loop over `{0}`, which is an `Option`. This is more readably written as an \
1427 `if let` statement.",
1428 snippet(cx, arg.span, "_")
1431 "consider replacing `for {0} in {1}` with `if let Some({0}) = {1}`",
1432 snippet(cx, pat.span, "_"),
1433 snippet(cx, arg.span, "_")
1436 } else if match_type(cx, ty, &paths::RESULT) {
1439 FOR_LOOP_OVER_RESULT,
1442 "for loop over `{0}`, which is a `Result`. This is more readably written as an \
1443 `if let` statement.",
1444 snippet(cx, arg.span, "_")
1447 "consider replacing `for {0} in {1}` with `if let Ok({0}) = {1}`",
1448 snippet(cx, pat.span, "_"),
1449 snippet(cx, arg.span, "_")
1455 fn check_for_loop_explicit_counter<'a, 'tcx>(
1456 cx: &LateContext<'a, 'tcx>,
1461 // Look for variables that are incremented once per loop iteration.
1462 let mut visitor = IncrementVisitor {
1464 states: FxHashMap::default(),
1468 walk_expr(&mut visitor, body);
1470 // For each candidate, check the parent block to see if
1471 // it's initialized to zero at the start of the loop.
1472 let map = &cx.tcx.hir();
1473 let expr_node_id = map.hir_to_node_id(expr.hir_id);
1474 let parent_scope = map
1475 .get_enclosing_scope(expr_node_id)
1476 .and_then(|id| map.get_enclosing_scope(id));
1477 if let Some(parent_id) = parent_scope {
1478 if let Node::Block(block) = map.get(parent_id) {
1479 for (id, _) in visitor.states.iter().filter(|&(_, v)| *v == VarState::IncrOnce) {
1480 let mut visitor2 = InitializeVisitor {
1484 state: VarState::IncrOnce,
1489 walk_block(&mut visitor2, block);
1491 if visitor2.state == VarState::Warn {
1492 if let Some(name) = visitor2.name {
1495 EXPLICIT_COUNTER_LOOP,
1498 "the variable `{0}` is used as a loop counter. Consider using `for ({0}, \
1499 item) in {1}.enumerate()` or similar iterators",
1501 snippet(cx, arg.span, "_")
1511 /// Check for the `FOR_KV_MAP` lint.
1512 fn check_for_loop_over_map_kv<'a, 'tcx>(
1513 cx: &LateContext<'a, 'tcx>,
1519 let pat_span = pat.span;
1521 if let PatKind::Tuple(ref pat, _) = pat.node {
1523 let arg_span = arg.span;
1524 let (new_pat_span, kind, ty, mutbl) = match cx.tables.expr_ty(arg).sty {
1525 ty::Ref(_, ty, mutbl) => match (&pat[0].node, &pat[1].node) {
1526 (key, _) if pat_is_wild(key, body) => (pat[1].span, "value", ty, mutbl),
1527 (_, value) if pat_is_wild(value, body) => (pat[0].span, "key", ty, MutImmutable),
1532 let mutbl = match mutbl {
1534 MutMutable => "_mut",
1536 let arg = match arg.node {
1537 ExprKind::AddrOf(_, ref expr) => &**expr,
1541 if match_type(cx, ty, &paths::HASHMAP) || match_type(cx, ty, &paths::BTREEMAP) {
1546 &format!("you seem to want to iterate on a map's {}s", kind),
1548 let map = sugg::Sugg::hir(cx, arg, "map");
1551 "use the corresponding method".into(),
1553 (pat_span, snippet(cx, new_pat_span, kind).into_owned()),
1554 (arg_span, format!("{}.{}s{}()", map.maybe_par(), kind, mutbl)),
1564 struct MutatePairDelegate {
1565 hir_id_low: Option<HirId>,
1566 hir_id_high: Option<HirId>,
1567 span_low: Option<Span>,
1568 span_high: Option<Span>,
1571 impl<'tcx> Delegate<'tcx> for MutatePairDelegate {
1572 fn consume(&mut self, _: HirId, _: Span, _: &cmt_<'tcx>, _: ConsumeMode) {}
1574 fn matched_pat(&mut self, _: &Pat, _: &cmt_<'tcx>, _: MatchMode) {}
1576 fn consume_pat(&mut self, _: &Pat, _: &cmt_<'tcx>, _: ConsumeMode) {}
1578 fn borrow(&mut self, _: HirId, sp: Span, cmt: &cmt_<'tcx>, _: ty::Region<'_>, bk: ty::BorrowKind, _: LoanCause) {
1579 if let ty::BorrowKind::MutBorrow = bk {
1580 if let Categorization::Local(id) = cmt.cat {
1581 if Some(id) == self.hir_id_low {
1582 self.span_low = Some(sp)
1584 if Some(id) == self.hir_id_high {
1585 self.span_high = Some(sp)
1591 fn mutate(&mut self, _: HirId, sp: Span, cmt: &cmt_<'tcx>, _: MutateMode) {
1592 if let Categorization::Local(id) = cmt.cat {
1593 if Some(id) == self.hir_id_low {
1594 self.span_low = Some(sp)
1596 if Some(id) == self.hir_id_high {
1597 self.span_high = Some(sp)
1602 fn decl_without_init(&mut self, _: HirId, _: Span) {}
1605 impl<'tcx> MutatePairDelegate {
1606 fn mutation_span(&self) -> (Option<Span>, Option<Span>) {
1607 (self.span_low, self.span_high)
1611 fn check_for_mut_range_bound(cx: &LateContext<'_, '_>, arg: &Expr, body: &Expr) {
1612 if let Some(higher::Range {
1616 }) = higher::range(cx, arg)
1618 let mut_ids = vec![check_for_mutability(cx, start), check_for_mutability(cx, end)];
1619 if mut_ids[0].is_some() || mut_ids[1].is_some() {
1620 let (span_low, span_high) = check_for_mutation(cx, body, &mut_ids);
1621 mut_warn_with_span(cx, span_low);
1622 mut_warn_with_span(cx, span_high);
1627 fn mut_warn_with_span(cx: &LateContext<'_, '_>, span: Option<Span>) {
1628 if let Some(sp) = span {
1633 "attempt to mutate range bound within loop; note that the range of the loop is unchanged",
1638 fn check_for_mutability(cx: &LateContext<'_, '_>, bound: &Expr) -> Option<HirId> {
1640 if let ExprKind::Path(ref qpath) = bound.node;
1641 if let QPath::Resolved(None, _) = *qpath;
1643 let def = cx.tables.qpath_def(qpath, bound.hir_id);
1644 if let Def::Local(node_id) = def {
1645 let node_str = cx.tcx.hir().get(node_id);
1647 if let Node::Binding(pat) = node_str;
1648 if let PatKind::Binding(bind_ann, ..) = pat.node;
1649 if let BindingAnnotation::Mutable = bind_ann;
1651 return Some(cx.tcx.hir().node_to_hir_id(node_id));
1660 fn check_for_mutation(
1661 cx: &LateContext<'_, '_>,
1663 bound_ids: &[Option<HirId>],
1664 ) -> (Option<Span>, Option<Span>) {
1665 let mut delegate = MutatePairDelegate {
1666 hir_id_low: bound_ids[0],
1667 hir_id_high: bound_ids[1],
1671 let def_id = def_id::DefId::local(body.hir_id.owner);
1672 let region_scope_tree = &cx.tcx.region_scope_tree(def_id);
1673 ExprUseVisitor::new(&mut delegate, cx.tcx, cx.param_env, region_scope_tree, cx.tables, None).walk_expr(body);
1674 delegate.mutation_span()
1677 /// Return true if the pattern is a `PatWild` or an ident prefixed with `'_'`.
1678 fn pat_is_wild<'tcx>(pat: &'tcx PatKind, body: &'tcx Expr) -> bool {
1680 PatKind::Wild => true,
1681 PatKind::Binding(.., ident, None) if ident.as_str().starts_with('_') => {
1682 let mut visitor = UsedVisitor {
1686 walk_expr(&mut visitor, body);
1693 struct UsedVisitor {
1694 var: ast::Name, // var to look for
1695 used: bool, // has the var been used otherwise?
1698 impl<'tcx> Visitor<'tcx> for UsedVisitor {
1699 fn visit_expr(&mut self, expr: &'tcx Expr) {
1700 if match_var(expr, self.var) {
1703 walk_expr(self, expr);
1707 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1708 NestedVisitorMap::None
1712 struct LocalUsedVisitor<'a, 'tcx: 'a> {
1713 cx: &'a LateContext<'a, 'tcx>,
1718 impl<'a, 'tcx: 'a> Visitor<'tcx> for LocalUsedVisitor<'a, 'tcx> {
1719 fn visit_expr(&mut self, expr: &'tcx Expr) {
1720 if same_var(self.cx, expr, self.local) {
1723 walk_expr(self, expr);
1727 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1728 NestedVisitorMap::None
1732 struct VarVisitor<'a, 'tcx: 'a> {
1733 /// context reference
1734 cx: &'a LateContext<'a, 'tcx>,
1735 /// var name to look for as index
1737 /// indexed variables that are used mutably
1738 indexed_mut: FxHashSet<Name>,
1739 /// indirectly indexed variables (`v[(i + 4) % N]`), the extend is `None` for global
1740 indexed_indirectly: FxHashMap<Name, Option<region::Scope>>,
1741 /// subset of `indexed` of vars that are indexed directly: `v[i]`
1742 /// this will not contain cases like `v[calc_index(i)]` or `v[(i + 4) % N]`
1743 indexed_directly: FxHashMap<Name, (Option<region::Scope>, Ty<'tcx>)>,
1744 /// Any names that are used outside an index operation.
1745 /// Used to detect things like `&mut vec` used together with `vec[i]`
1746 referenced: FxHashSet<Name>,
1747 /// has the loop variable been used in expressions other than the index of
1750 /// Whether we are inside the `$` in `&mut $` or `$ = foo` or `$.bar`, where bar
1751 /// takes `&mut self`
1752 prefer_mutable: bool,
1755 impl<'a, 'tcx> VarVisitor<'a, 'tcx> {
1756 fn check(&mut self, idx: &'tcx Expr, seqexpr: &'tcx Expr, expr: &'tcx Expr) -> bool {
1758 // the indexed container is referenced by a name
1759 if let ExprKind::Path(ref seqpath) = seqexpr.node;
1760 if let QPath::Resolved(None, ref seqvar) = *seqpath;
1761 if seqvar.segments.len() == 1;
1763 let index_used_directly = same_var(self.cx, idx, self.var);
1764 let indexed_indirectly = {
1765 let mut used_visitor = LocalUsedVisitor {
1770 walk_expr(&mut used_visitor, idx);
1774 if indexed_indirectly || index_used_directly {
1775 if self.prefer_mutable {
1776 self.indexed_mut.insert(seqvar.segments[0].ident.name);
1778 let def = self.cx.tables.qpath_def(seqpath, seqexpr.hir_id);
1780 Def::Local(node_id) | Def::Upvar(node_id, ..) => {
1781 let hir_id = self.cx.tcx.hir().node_to_hir_id(node_id);
1783 let parent_id = self.cx.tcx.hir().get_parent_item(expr.hir_id);
1784 let parent_def_id = self.cx.tcx.hir().local_def_id_from_hir_id(parent_id);
1785 let extent = self.cx.tcx.region_scope_tree(parent_def_id).var_scope(hir_id.local_id);
1786 if indexed_indirectly {
1787 self.indexed_indirectly.insert(seqvar.segments[0].ident.name, Some(extent));
1789 if index_used_directly {
1790 self.indexed_directly.insert(
1791 seqvar.segments[0].ident.name,
1792 (Some(extent), self.cx.tables.node_type(seqexpr.hir_id)),
1795 return false; // no need to walk further *on the variable*
1797 Def::Static(..) | Def::Const(..) => {
1798 if indexed_indirectly {
1799 self.indexed_indirectly.insert(seqvar.segments[0].ident.name, None);
1801 if index_used_directly {
1802 self.indexed_directly.insert(
1803 seqvar.segments[0].ident.name,
1804 (None, self.cx.tables.node_type(seqexpr.hir_id)),
1807 return false; // no need to walk further *on the variable*
1818 impl<'a, 'tcx> Visitor<'tcx> for VarVisitor<'a, 'tcx> {
1819 fn visit_expr(&mut self, expr: &'tcx Expr) {
1822 if let ExprKind::MethodCall(ref meth, _, ref args) = expr.node;
1823 if (meth.ident.name == "index" && match_trait_method(self.cx, expr, &paths::INDEX))
1824 || (meth.ident.name == "index_mut" && match_trait_method(self.cx, expr, &paths::INDEX_MUT));
1825 if !self.check(&args[1], &args[0], expr);
1831 if let ExprKind::Index(ref seqexpr, ref idx) = expr.node;
1832 if !self.check(idx, seqexpr, expr);
1837 // directly using a variable
1838 if let ExprKind::Path(ref qpath) = expr.node;
1839 if let QPath::Resolved(None, ref path) = *qpath;
1840 if path.segments.len() == 1;
1842 match self.cx.tables.qpath_def(qpath, expr.hir_id) {
1843 Def::Upvar(local_id, ..) => {
1844 if local_id == self.var {
1845 // we are not indexing anything, record that
1846 self.nonindex = true;
1849 Def::Local(local_id) =>
1852 if local_id == self.var {
1853 self.nonindex = true;
1855 // not the correct variable, but still a variable
1856 self.referenced.insert(path.segments[0].ident.name);
1864 let old = self.prefer_mutable;
1866 ExprKind::AssignOp(_, ref lhs, ref rhs) | ExprKind::Assign(ref lhs, ref rhs) => {
1867 self.prefer_mutable = true;
1868 self.visit_expr(lhs);
1869 self.prefer_mutable = false;
1870 self.visit_expr(rhs);
1872 ExprKind::AddrOf(mutbl, ref expr) => {
1873 if mutbl == MutMutable {
1874 self.prefer_mutable = true;
1876 self.visit_expr(expr);
1878 ExprKind::Call(ref f, ref args) => {
1881 let ty = self.cx.tables.expr_ty_adjusted(expr);
1882 self.prefer_mutable = false;
1883 if let ty::Ref(_, _, mutbl) = ty.sty {
1884 if mutbl == MutMutable {
1885 self.prefer_mutable = true;
1888 self.visit_expr(expr);
1891 ExprKind::MethodCall(_, _, ref args) => {
1892 let def_id = self.cx.tables.type_dependent_defs()[expr.hir_id].def_id();
1893 for (ty, expr) in self.cx.tcx.fn_sig(def_id).inputs().skip_binder().iter().zip(args) {
1894 self.prefer_mutable = false;
1895 if let ty::Ref(_, _, mutbl) = ty.sty {
1896 if mutbl == MutMutable {
1897 self.prefer_mutable = true;
1900 self.visit_expr(expr);
1903 ExprKind::Closure(_, _, body_id, ..) => {
1904 let body = self.cx.tcx.hir().body(body_id);
1905 self.visit_expr(&body.value);
1907 _ => walk_expr(self, expr),
1909 self.prefer_mutable = old;
1911 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1912 NestedVisitorMap::None
1916 fn is_used_inside<'a, 'tcx: 'a>(cx: &'a LateContext<'a, 'tcx>, expr: &'tcx Expr, container: &'tcx Expr) -> bool {
1917 let def_id = match var_def_id(cx, expr) {
1919 None => return false,
1921 if let Some(used_mutably) = mutated_variables(container, cx) {
1922 if used_mutably.contains(&def_id) {
1929 fn is_iterator_used_after_while_let<'a, 'tcx: 'a>(cx: &LateContext<'a, 'tcx>, iter_expr: &'tcx Expr) -> bool {
1930 let def_id = match var_def_id(cx, iter_expr) {
1932 None => return false,
1934 let mut visitor = VarUsedAfterLoopVisitor {
1937 iter_expr_id: iter_expr.hir_id,
1938 past_while_let: false,
1939 var_used_after_while_let: false,
1941 if let Some(enclosing_block) = get_enclosing_block(cx, def_id) {
1942 walk_block(&mut visitor, enclosing_block);
1944 visitor.var_used_after_while_let
1947 struct VarUsedAfterLoopVisitor<'a, 'tcx: 'a> {
1948 cx: &'a LateContext<'a, 'tcx>,
1950 iter_expr_id: HirId,
1951 past_while_let: bool,
1952 var_used_after_while_let: bool,
1955 impl<'a, 'tcx> Visitor<'tcx> for VarUsedAfterLoopVisitor<'a, 'tcx> {
1956 fn visit_expr(&mut self, expr: &'tcx Expr) {
1957 if self.past_while_let {
1958 if Some(self.def_id) == var_def_id(self.cx, expr) {
1959 self.var_used_after_while_let = true;
1961 } else if self.iter_expr_id == expr.hir_id {
1962 self.past_while_let = true;
1964 walk_expr(self, expr);
1966 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1967 NestedVisitorMap::None
1971 /// Return true if the type of expr is one that provides `IntoIterator` impls
1972 /// for `&T` and `&mut T`, such as `Vec`.
1974 fn is_ref_iterable_type(cx: &LateContext<'_, '_>, e: &Expr) -> bool {
1975 // no walk_ptrs_ty: calling iter() on a reference can make sense because it
1976 // will allow further borrows afterwards
1977 let ty = cx.tables.expr_ty(e);
1978 is_iterable_array(ty, cx) ||
1979 match_type(cx, ty, &paths::VEC) ||
1980 match_type(cx, ty, &paths::LINKED_LIST) ||
1981 match_type(cx, ty, &paths::HASHMAP) ||
1982 match_type(cx, ty, &paths::HASHSET) ||
1983 match_type(cx, ty, &paths::VEC_DEQUE) ||
1984 match_type(cx, ty, &paths::BINARY_HEAP) ||
1985 match_type(cx, ty, &paths::BTREEMAP) ||
1986 match_type(cx, ty, &paths::BTREESET)
1989 fn is_iterable_array(ty: Ty<'_>, cx: &LateContext<'_, '_>) -> bool {
1990 // IntoIterator is currently only implemented for array sizes <= 32 in rustc
1992 ty::Array(_, n) => (0..=32).contains(&n.assert_usize(cx.tcx).expect("array length")),
1997 /// If a block begins with a statement (possibly a `let` binding) and has an
1998 /// expression, return it.
1999 fn extract_expr_from_first_stmt(block: &Block) -> Option<&Expr> {
2000 if block.stmts.is_empty() {
2003 if let StmtKind::Local(ref local) = block.stmts[0].node {
2004 if let Some(ref expr) = local.init {
2014 /// If a block begins with an expression (with or without semicolon), return it.
2015 fn extract_first_expr(block: &Block) -> Option<&Expr> {
2017 Some(ref expr) if block.stmts.is_empty() => Some(expr),
2018 None if !block.stmts.is_empty() => match block.stmts[0].node {
2019 StmtKind::Expr(ref expr) | StmtKind::Semi(ref expr) => Some(expr),
2020 StmtKind::Local(..) | StmtKind::Item(..) => None,
2026 /// Return true if expr contains a single break expr without destination label
2028 /// passed expression. The expression may be within a block.
2029 fn is_simple_break_expr(expr: &Expr) -> bool {
2031 ExprKind::Break(dest, ref passed_expr) if dest.label.is_none() && passed_expr.is_none() => true,
2032 ExprKind::Block(ref b, _) => match extract_first_expr(b) {
2033 Some(subexpr) => is_simple_break_expr(subexpr),
2040 // To trigger the EXPLICIT_COUNTER_LOOP lint, a variable must be
2041 // incremented exactly once in the loop body, and initialized to zero
2042 // at the start of the loop.
2043 #[derive(PartialEq)]
2045 Initial, // Not examined yet
2046 IncrOnce, // Incremented exactly once, may be a loop counter
2047 Declared, // Declared but not (yet) initialized to zero
2052 /// Scan a for loop for variables that are incremented exactly once.
2053 struct IncrementVisitor<'a, 'tcx: 'a> {
2054 cx: &'a LateContext<'a, 'tcx>, // context reference
2055 states: FxHashMap<HirId, VarState>, // incremented variables
2056 depth: u32, // depth of conditional expressions
2060 impl<'a, 'tcx> Visitor<'tcx> for IncrementVisitor<'a, 'tcx> {
2061 fn visit_expr(&mut self, expr: &'tcx Expr) {
2066 // If node is a variable
2067 if let Some(def_id) = var_def_id(self.cx, expr) {
2068 if let Some(parent) = get_parent_expr(self.cx, expr) {
2069 let state = self.states.entry(def_id).or_insert(VarState::Initial);
2072 ExprKind::AssignOp(op, ref lhs, ref rhs) => {
2073 if lhs.hir_id == expr.hir_id {
2074 if op.node == BinOpKind::Add && is_integer_literal(rhs, 1) {
2075 *state = match *state {
2076 VarState::Initial if self.depth == 0 => VarState::IncrOnce,
2077 _ => VarState::DontWarn,
2080 // Assigned some other value
2081 *state = VarState::DontWarn;
2085 ExprKind::Assign(ref lhs, _) if lhs.hir_id == expr.hir_id => *state = VarState::DontWarn,
2086 ExprKind::AddrOf(mutability, _) if mutability == MutMutable => *state = VarState::DontWarn,
2090 } else if is_loop(expr) || is_conditional(expr) {
2092 walk_expr(self, expr);
2095 } else if let ExprKind::Continue(_) = expr.node {
2099 walk_expr(self, expr);
2101 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
2102 NestedVisitorMap::None
2106 /// Check whether a variable is initialized to zero at the start of a loop.
2107 struct InitializeVisitor<'a, 'tcx: 'a> {
2108 cx: &'a LateContext<'a, 'tcx>, // context reference
2109 end_expr: &'tcx Expr, // the for loop. Stop scanning here.
2113 depth: u32, // depth of conditional expressions
2117 impl<'a, 'tcx> Visitor<'tcx> for InitializeVisitor<'a, 'tcx> {
2118 fn visit_stmt(&mut self, stmt: &'tcx Stmt) {
2119 // Look for declarations of the variable
2120 if let StmtKind::Local(ref local) = stmt.node {
2121 if local.pat.hir_id == self.var_id {
2122 if let PatKind::Binding(.., ident, _) = local.pat.node {
2123 self.name = Some(ident.name);
2125 self.state = if let Some(ref init) = local.init {
2126 if is_integer_literal(init, 0) {
2137 walk_stmt(self, stmt);
2140 fn visit_expr(&mut self, expr: &'tcx Expr) {
2141 if self.state == VarState::DontWarn {
2144 if SpanlessEq::new(self.cx).eq_expr(&expr, self.end_expr) {
2145 self.past_loop = true;
2148 // No need to visit expressions before the variable is
2150 if self.state == VarState::IncrOnce {
2154 // If node is the desired variable, see how it's used
2155 if var_def_id(self.cx, expr) == Some(self.var_id) {
2156 if let Some(parent) = get_parent_expr(self.cx, expr) {
2158 ExprKind::AssignOp(_, ref lhs, _) if lhs.hir_id == expr.hir_id => {
2159 self.state = VarState::DontWarn;
2161 ExprKind::Assign(ref lhs, ref rhs) if lhs.hir_id == expr.hir_id => {
2162 self.state = if is_integer_literal(rhs, 0) && self.depth == 0 {
2168 ExprKind::AddrOf(mutability, _) if mutability == MutMutable => self.state = VarState::DontWarn,
2174 self.state = VarState::DontWarn;
2177 } else if !self.past_loop && is_loop(expr) {
2178 self.state = VarState::DontWarn;
2180 } else if is_conditional(expr) {
2182 walk_expr(self, expr);
2186 walk_expr(self, expr);
2188 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
2189 NestedVisitorMap::None
2193 fn var_def_id(cx: &LateContext<'_, '_>, expr: &Expr) -> Option<HirId> {
2194 if let ExprKind::Path(ref qpath) = expr.node {
2195 let path_res = cx.tables.qpath_def(qpath, expr.hir_id);
2196 if let Def::Local(node_id) = path_res {
2197 return Some(cx.tcx.hir().node_to_hir_id(node_id));
2203 fn is_loop(expr: &Expr) -> bool {
2205 ExprKind::Loop(..) | ExprKind::While(..) => true,
2210 fn is_conditional(expr: &Expr) -> bool {
2212 ExprKind::If(..) | ExprKind::Match(..) => true,
2217 fn is_nested(cx: &LateContext<'_, '_>, match_expr: &Expr, iter_expr: &Expr) -> bool {
2219 if let Some(loop_block) = get_enclosing_block(cx, match_expr.hir_id);
2220 let parent_node = cx.tcx.hir().get_parent_node_by_hir_id(loop_block.hir_id);
2221 if let Some(Node::Expr(loop_expr)) = cx.tcx.hir().find_by_hir_id(parent_node);
2223 return is_loop_nested(cx, loop_expr, iter_expr)
2229 fn is_loop_nested(cx: &LateContext<'_, '_>, loop_expr: &Expr, iter_expr: &Expr) -> bool {
2230 let mut id = loop_expr.hir_id;
2231 let iter_name = if let Some(name) = path_name(iter_expr) {
2237 let parent = cx.tcx.hir().get_parent_node_by_hir_id(id);
2241 match cx.tcx.hir().find_by_hir_id(parent) {
2242 Some(Node::Expr(expr)) => match expr.node {
2243 ExprKind::Loop(..) | ExprKind::While(..) => {
2248 Some(Node::Block(block)) => {
2249 let mut block_visitor = LoopNestVisitor {
2251 iterator: iter_name,
2254 walk_block(&mut block_visitor, block);
2255 if block_visitor.nesting == RuledOut {
2259 Some(Node::Stmt(_)) => (),
2268 #[derive(PartialEq, Eq)]
2270 Unknown, // no nesting detected yet
2271 RuledOut, // the iterator is initialized or assigned within scope
2272 LookFurther, // no nesting detected, no further walk required
2275 use self::Nesting::{LookFurther, RuledOut, Unknown};
2277 struct LoopNestVisitor {
2283 impl<'tcx> Visitor<'tcx> for LoopNestVisitor {
2284 fn visit_stmt(&mut self, stmt: &'tcx Stmt) {
2285 if stmt.hir_id == self.hir_id {
2286 self.nesting = LookFurther;
2287 } else if self.nesting == Unknown {
2288 walk_stmt(self, stmt);
2292 fn visit_expr(&mut self, expr: &'tcx Expr) {
2293 if self.nesting != Unknown {
2296 if expr.hir_id == self.hir_id {
2297 self.nesting = LookFurther;
2301 ExprKind::Assign(ref path, _) | ExprKind::AssignOp(_, ref path, _) => {
2302 if match_var(path, self.iterator) {
2303 self.nesting = RuledOut;
2306 _ => walk_expr(self, expr),
2310 fn visit_pat(&mut self, pat: &'tcx Pat) {
2311 if self.nesting != Unknown {
2314 if let PatKind::Binding(.., span_name, _) = pat.node {
2315 if self.iterator == span_name.name {
2316 self.nesting = RuledOut;
2323 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
2324 NestedVisitorMap::None
2328 fn path_name(e: &Expr) -> Option<Name> {
2329 if let ExprKind::Path(QPath::Resolved(_, ref path)) = e.node {
2330 let segments = &path.segments;
2331 if segments.len() == 1 {
2332 return Some(segments[0].ident.name);
2338 fn check_infinite_loop<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, cond: &'tcx Expr, expr: &'tcx Expr) {
2339 if constant(cx, cx.tables, cond).is_some() {
2340 // A pure constant condition (e.g. while false) is not linted.
2344 let mut var_visitor = VarCollectorVisitor {
2346 ids: FxHashSet::default(),
2347 def_ids: FxHashMap::default(),
2350 var_visitor.visit_expr(cond);
2351 if var_visitor.skip {
2354 let used_in_condition = &var_visitor.ids;
2355 let no_cond_variable_mutated = if let Some(used_mutably) = mutated_variables(expr, cx) {
2356 used_in_condition.is_disjoint(&used_mutably)
2360 let mutable_static_in_cond = var_visitor.def_ids.iter().any(|(_, v)| *v);
2361 if no_cond_variable_mutated && !mutable_static_in_cond {
2364 WHILE_IMMUTABLE_CONDITION,
2366 "Variable in the condition are not mutated in the loop body. \
2367 This either leads to an infinite or to a never running loop.",
2372 /// Collects the set of variables in an expression
2373 /// Stops analysis if a function call is found
2374 /// Note: In some cases such as `self`, there are no mutable annotation,
2375 /// All variables definition IDs are collected
2376 struct VarCollectorVisitor<'a, 'tcx: 'a> {
2377 cx: &'a LateContext<'a, 'tcx>,
2378 ids: FxHashSet<HirId>,
2379 def_ids: FxHashMap<def_id::DefId, bool>,
2383 impl<'a, 'tcx> VarCollectorVisitor<'a, 'tcx> {
2384 fn insert_def_id(&mut self, ex: &'tcx Expr) {
2386 if let ExprKind::Path(ref qpath) = ex.node;
2387 if let QPath::Resolved(None, _) = *qpath;
2388 let def = self.cx.tables.qpath_def(qpath, ex.hir_id);
2391 Def::Local(node_id) | Def::Upvar(node_id, ..) => {
2392 self.ids.insert(self.cx.tcx.hir().node_to_hir_id(node_id));
2394 Def::Static(def_id, mutable) => {
2395 self.def_ids.insert(def_id, mutable);
2404 impl<'a, 'tcx> Visitor<'tcx> for VarCollectorVisitor<'a, 'tcx> {
2405 fn visit_expr(&mut self, ex: &'tcx Expr) {
2407 ExprKind::Path(_) => self.insert_def_id(ex),
2408 // If there is any function/method call… we just stop analysis
2409 ExprKind::Call(..) | ExprKind::MethodCall(..) => self.skip = true,
2411 _ => walk_expr(self, ex),
2415 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
2416 NestedVisitorMap::None
2420 const NEEDLESS_COLLECT_MSG: &str = "avoid using `collect()` when not needed";
2422 fn check_needless_collect<'a, 'tcx>(expr: &'tcx Expr, cx: &LateContext<'a, 'tcx>) {
2424 if let ExprKind::MethodCall(ref method, _, ref args) = expr.node;
2425 if let ExprKind::MethodCall(ref chain_method, _, _) = args[0].node;
2426 if chain_method.ident.name == "collect" && match_trait_method(cx, &args[0], &paths::ITERATOR);
2427 if let Some(ref generic_args) = chain_method.args;
2428 if let Some(GenericArg::Type(ref ty)) = generic_args.args.get(0);
2430 let ty = cx.tables.node_type(ty.hir_id);
2431 if match_type(cx, ty, &paths::VEC) ||
2432 match_type(cx, ty, &paths::VEC_DEQUE) ||
2433 match_type(cx, ty, &paths::BTREEMAP) ||
2434 match_type(cx, ty, &paths::HASHMAP) {
2435 if method.ident.name == "len" {
2436 let span = shorten_needless_collect_span(expr);
2437 span_lint_and_then(cx, NEEDLESS_COLLECT, span, NEEDLESS_COLLECT_MSG, |db| {
2441 ".count()".to_string(),
2442 Applicability::MachineApplicable,
2446 if method.ident.name == "is_empty" {
2447 let span = shorten_needless_collect_span(expr);
2448 span_lint_and_then(cx, NEEDLESS_COLLECT, span, NEEDLESS_COLLECT_MSG, |db| {
2452 ".next().is_none()".to_string(),
2453 Applicability::MachineApplicable,
2457 if method.ident.name == "contains" {
2458 let contains_arg = snippet(cx, args[1].span, "??");
2459 let span = shorten_needless_collect_span(expr);
2460 span_lint_and_then(cx, NEEDLESS_COLLECT, span, NEEDLESS_COLLECT_MSG, |db| {
2465 ".any(|&x| x == {})",
2466 if contains_arg.starts_with('&') { &contains_arg[1..] } else { &contains_arg }
2468 Applicability::MachineApplicable,
2477 fn shorten_needless_collect_span(expr: &Expr) -> Span {
2479 if let ExprKind::MethodCall(_, _, ref args) = expr.node;
2480 if let ExprKind::MethodCall(_, ref span, _) = args[0].node;
2482 return expr.span.with_lo(span.lo() - BytePos(1));