clippy_lints/src/loops.rs

   1 use crate::reexport::*;
   2 use if_chain::if_chain;
   3 use itertools::Itertools;
   4 use rustc::hir::def::{DefKind, Res};
   5 use rustc::hir::def_id;
   6 use rustc::hir::intravisit::{walk_block, walk_expr, walk_pat, walk_stmt, NestedVisitorMap, Visitor};
   7 use rustc::hir::*;
   8 use rustc::lint::{in_external_macro, LateContext, LateLintPass, LintArray, LintContext, LintPass};
   9 use rustc::middle::region;
  10 use rustc::{declare_lint_pass, declare_tool_lint};
  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_or_desugar, 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};
  23 use std::mem;
  24 use syntax::ast;
  25 use syntax::source_map::Span;
  26 use syntax_pos::BytePos;
  27
  28 use crate::utils::paths;
  29 use crate::utils::{
  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,
  33 };
  34
  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.
  38     ///
  39     /// **Why is this bad?** It is not as fast as a memcpy.
  40     ///
  41     /// **Known problems:** None.
  42     ///
  43     /// **Example:**
  44     /// ```rust
  45     /// # let src = vec![1];
  46     /// # let mut dst = vec![0; 65];
  47     /// for i in 0..src.len() {
  48     ///     dst[i + 64] = src[i];
  49     /// }
  50     /// ```
  51     /// Could be written as:
  52     /// ```rust
  53     /// # let src = vec![1];
  54     /// # let mut dst = vec![0; 65];
  55     /// dst[64..(src.len() + 64)].clone_from_slice(&src[..]);
  56     /// ```
  57     pub MANUAL_MEMCPY,
  58     perf,
  59     "manually copying items between slices"
  60 }
  61
  62 declare_clippy_lint! {
  63     /// **What it does:** Checks for looping over the range of `0..len` of some
  64     /// collection just to get the values by index.
  65     ///
  66     /// **Why is this bad?** Just iterating the collection itself makes the intent
  67     /// more clear and is probably faster.
  68     ///
  69     /// **Known problems:** None.
  70     ///
  71     /// **Example:**
  72     /// ```rust
  73     /// let vec = vec!['a', 'b', 'c'];
  74     /// for i in 0..vec.len() {
  75     ///     println!("{}", vec[i]);
  76     /// }
  77     /// ```
  78     /// Could be written as:
  79     /// ```rust
  80     /// let vec = vec!['a', 'b', 'c'];
  81     /// for i in vec {
  82     ///     println!("{}", i);
  83     /// }
  84     /// ```
  85     pub NEEDLESS_RANGE_LOOP,
  86     style,
  87     "for-looping over a range of indices where an iterator over items would do"
  88 }
  89
  90 declare_clippy_lint! {
  91     /// **What it does:** Checks for loops on `x.iter()` where `&x` will do, and
  92     /// suggests the latter.
  93     ///
  94     /// **Why is this bad?** Readability.
  95     ///
  96     /// **Known problems:** False negatives. We currently only warn on some known
  97     /// types.
  98     ///
  99     /// **Example:**
 100     /// ```rust
 101     /// // with `y` a `Vec` or slice:
 102     /// # let y = vec![1];
 103     /// for x in y.iter() {
 104     ///     // ..
 105     /// }
 106     /// ```
 107     /// can be rewritten to
 108     /// ```rust
 109     /// # let y = vec![1];
 110     /// for x in &y {
 111     ///     // ..
 112     /// }
 113     /// ```
 114     pub EXPLICIT_ITER_LOOP,
 115     pedantic,
 116     "for-looping over `_.iter()` or `_.iter_mut()` when `&_` or `&mut _` would do"
 117 }
 118
 119 declare_clippy_lint! {
 120     /// **What it does:** Checks for loops on `y.into_iter()` where `y` will do, and
 121     /// suggests the latter.
 122     ///
 123     /// **Why is this bad?** Readability.
 124     ///
 125     /// **Known problems:** None
 126     ///
 127     /// **Example:**
 128     /// ```rust
 129     /// # let y = vec![1];
 130     /// // with `y` a `Vec` or slice:
 131     /// for x in y.into_iter() {
 132     ///     // ..
 133     /// }
 134     /// ```
 135     /// can be rewritten to
 136     /// ```rust
 137     /// # let y = vec![1];
 138     /// for x in y {
 139     ///     // ..
 140     /// }
 141     /// ```
 142     pub EXPLICIT_INTO_ITER_LOOP,
 143     pedantic,
 144     "for-looping over `_.into_iter()` when `_` would do"
 145 }
 146
 147 declare_clippy_lint! {
 148     /// **What it does:** Checks for loops on `x.next()`.
 149     ///
 150     /// **Why is this bad?** `next()` returns either `Some(value)` if there was a
 151     /// value, or `None` otherwise. The insidious thing is that `Option<_>`
 152     /// implements `IntoIterator`, so that possibly one value will be iterated,
 153     /// leading to some hard to find bugs. No one will want to write such code
 154     /// [except to win an Underhanded Rust
 155     /// Contest](https://www.reddit.com/r/rust/comments/3hb0wm/underhanded_rust_contest/cu5yuhr).
 156     ///
 157     /// **Known problems:** None.
 158     ///
 159     /// **Example:**
 160     /// ```ignore
 161     /// for x in y.next() {
 162     ///     ..
 163     /// }
 164     /// ```
 165     pub ITER_NEXT_LOOP,
 166     correctness,
 167     "for-looping over `_.next()` which is probably not intended"
 168 }
 169
 170 declare_clippy_lint! {
 171     /// **What it does:** Checks for `for` loops over `Option` values.
 172     ///
 173     /// **Why is this bad?** Readability. This is more clearly expressed as an `if
 174     /// let`.
 175     ///
 176     /// **Known problems:** None.
 177     ///
 178     /// **Example:**
 179     /// ```ignore
 180     /// for x in option {
 181     ///     ..
 182     /// }
 183     /// ```
 184     ///
 185     /// This should be
 186     /// ```ignore
 187     /// if let Some(x) = option {
 188     ///     ..
 189     /// }
 190     /// ```
 191     pub FOR_LOOP_OVER_OPTION,
 192     correctness,
 193     "for-looping over an `Option`, which is more clearly expressed as an `if let`"
 194 }
 195
 196 declare_clippy_lint! {
 197     /// **What it does:** Checks for `for` loops over `Result` values.
 198     ///
 199     /// **Why is this bad?** Readability. This is more clearly expressed as an `if
 200     /// let`.
 201     ///
 202     /// **Known problems:** None.
 203     ///
 204     /// **Example:**
 205     /// ```ignore
 206     /// for x in result {
 207     ///     ..
 208     /// }
 209     /// ```
 210     ///
 211     /// This should be
 212     /// ```ignore
 213     /// if let Ok(x) = result {
 214     ///     ..
 215     /// }
 216     /// ```
 217     pub FOR_LOOP_OVER_RESULT,
 218     correctness,
 219     "for-looping over a `Result`, which is more clearly expressed as an `if let`"
 220 }
 221
 222 declare_clippy_lint! {
 223     /// **What it does:** Detects `loop + match` combinations that are easier
 224     /// written as a `while let` loop.
 225     ///
 226     /// **Why is this bad?** The `while let` loop is usually shorter and more
 227     /// readable.
 228     ///
 229     /// **Known problems:** Sometimes the wrong binding is displayed (#383).
 230     ///
 231     /// **Example:**
 232     /// ```rust,no_run
 233     /// # let y = Some(1);
 234     /// loop {
 235     ///     let x = match y {
 236     ///         Some(x) => x,
 237     ///         None => break,
 238     ///     };
 239     ///     // .. do something with x
 240     /// }
 241     /// // is easier written as
 242     /// while let Some(x) = y {
 243     ///     // .. do something with x
 244     /// };
 245     /// ```
 246     pub WHILE_LET_LOOP,
 247     complexity,
 248     "`loop { if let { ... } else break }`, which can be written as a `while let` loop"
 249 }
 250
 251 declare_clippy_lint! {
 252     /// **What it does:** Checks for functions collecting an iterator when collect
 253     /// is not needed.
 254     ///
 255     /// **Why is this bad?** `collect` causes the allocation of a new data structure,
 256     /// when this allocation may not be needed.
 257     ///
 258     /// **Known problems:**
 259     /// None
 260     ///
 261     /// **Example:**
 262     /// ```rust
 263     /// # let iterator = vec![1].into_iter();
 264     /// let len = iterator.clone().collect::<Vec<_>>().len();
 265     /// // should be
 266     /// let len = iterator.count();
 267     /// ```
 268     pub NEEDLESS_COLLECT,
 269     perf,
 270     "collecting an iterator when collect is not needed"
 271 }
 272
 273 declare_clippy_lint! {
 274     /// **What it does:** Checks for loops over ranges `x..y` where both `x` and `y`
 275     /// are constant and `x` is greater or equal to `y`, unless the range is
 276     /// reversed or has a negative `.step_by(_)`.
 277     ///
 278     /// **Why is it bad?** Such loops will either be skipped or loop until
 279     /// wrap-around (in debug code, this may `panic!()`). Both options are probably
 280     /// not intended.
 281     ///
 282     /// **Known problems:** The lint cannot catch loops over dynamically defined
 283     /// ranges. Doing this would require simulating all possible inputs and code
 284     /// paths through the program, which would be complex and error-prone.
 285     ///
 286     /// **Example:**
 287     /// ```ignore
 288     /// for x in 5..10 - 5 {
 289     ///     ..
 290     /// } // oops, stray `-`
 291     /// ```
 292     pub REVERSE_RANGE_LOOP,
 293     correctness,
 294     "iteration over an empty range, such as `10..0` or `5..5`"
 295 }
 296
 297 declare_clippy_lint! {
 298     /// **What it does:** Checks `for` loops over slices with an explicit counter
 299     /// and suggests the use of `.enumerate()`.
 300     ///
 301     /// **Why is it bad?** Not only is the version using `.enumerate()` more
 302     /// readable, the compiler is able to remove bounds checks which can lead to
 303     /// faster code in some instances.
 304     ///
 305     /// **Known problems:** None.
 306     ///
 307     /// **Example:**
 308     /// ```rust
 309     /// # let v = vec![1];
 310     /// # fn foo(bar: usize) {}
 311     /// # fn bar(bar: usize, baz: usize) {}
 312     /// for i in 0..v.len() { foo(v[i]); }
 313     /// for i in 0..v.len() { bar(i, v[i]); }
 314     /// ```
 315     pub EXPLICIT_COUNTER_LOOP,
 316     complexity,
 317     "for-looping with an explicit counter when `_.enumerate()` would do"
 318 }
 319
 320 declare_clippy_lint! {
 321     /// **What it does:** Checks for empty `loop` expressions.
 322     ///
 323     /// **Why is this bad?** Those busy loops burn CPU cycles without doing
 324     /// anything. Think of the environment and either block on something or at least
 325     /// make the thread sleep for some microseconds.
 326     ///
 327     /// **Known problems:** None.
 328     ///
 329     /// **Example:**
 330     /// ```no_run
 331     /// loop {}
 332     /// ```
 333     pub EMPTY_LOOP,
 334     style,
 335     "empty `loop {}`, which should block or sleep"
 336 }
 337
 338 declare_clippy_lint! {
 339     /// **What it does:** Checks for `while let` expressions on iterators.
 340     ///
 341     /// **Why is this bad?** Readability. A simple `for` loop is shorter and conveys
 342     /// the intent better.
 343     ///
 344     /// **Known problems:** None.
 345     ///
 346     /// **Example:**
 347     /// ```ignore
 348     /// while let Some(val) = iter() {
 349     ///     ..
 350     /// }
 351     /// ```
 352     pub WHILE_LET_ON_ITERATOR,
 353     style,
 354     "using a while-let loop instead of a for loop on an iterator"
 355 }
 356
 357 declare_clippy_lint! {
 358     /// **What it does:** Checks for iterating a map (`HashMap` or `BTreeMap`) and
 359     /// ignoring either the keys or values.
 360     ///
 361     /// **Why is this bad?** Readability. There are `keys` and `values` methods that
 362     /// can be used to express that don't need the values or keys.
 363     ///
 364     /// **Known problems:** None.
 365     ///
 366     /// **Example:**
 367     /// ```ignore
 368     /// for (k, _) in &map {
 369     ///     ..
 370     /// }
 371     /// ```
 372     ///
 373     /// could be replaced by
 374     ///
 375     /// ```ignore
 376     /// for k in map.keys() {
 377     ///     ..
 378     /// }
 379     /// ```
 380     pub FOR_KV_MAP,
 381     style,
 382     "looping on a map using `iter` when `keys` or `values` would do"
 383 }
 384
 385 declare_clippy_lint! {
 386     /// **What it does:** Checks for loops that will always `break`, `return` or
 387     /// `continue` an outer loop.
 388     ///
 389     /// **Why is this bad?** This loop never loops, all it does is obfuscating the
 390     /// code.
 391     ///
 392     /// **Known problems:** None
 393     ///
 394     /// **Example:**
 395     /// ```rust
 396     /// loop {
 397     ///     ..;
 398     ///     break;
 399     /// }
 400     /// ```
 401     pub NEVER_LOOP,
 402     correctness,
 403     "any loop that will always `break` or `return`"
 404 }
 405
 406 declare_clippy_lint! {
 407     /// **What it does:** Checks for loops which have a range bound that is a mutable variable
 408     ///
 409     /// **Why is this bad?** One might think that modifying the mutable variable changes the loop bounds
 410     ///
 411     /// **Known problems:** None
 412     ///
 413     /// **Example:**
 414     /// ```rust
 415     /// let mut foo = 42;
 416     /// for i in 0..foo {
 417     ///     foo -= 1;
 418     ///     println!("{}", i); // prints numbers from 0 to 42, not 0 to 21
 419     /// }
 420     /// ```
 421     pub MUT_RANGE_BOUND,
 422     complexity,
 423     "for loop over a range where one of the bounds is a mutable variable"
 424 }
 425
 426 declare_clippy_lint! {
 427     /// **What it does:** Checks whether variables used within while loop condition
 428     /// can be (and are) mutated in the body.
 429     ///
 430     /// **Why is this bad?** If the condition is unchanged, entering the body of the loop
 431     /// will lead to an infinite loop.
 432     ///
 433     /// **Known problems:** If the `while`-loop is in a closure, the check for mutation of the
 434     /// condition variables in the body can cause false negatives. For example when only `Upvar` `a` is
 435     /// in the condition and only `Upvar` `b` gets mutated in the body, the lint will not trigger.
 436     ///
 437     /// **Example:**
 438     /// ```rust
 439     /// let i = 0;
 440     /// while i > 10 {
 441     ///     println!("let me loop forever!");
 442     /// }
 443     /// ```
 444     pub WHILE_IMMUTABLE_CONDITION,
 445     correctness,
 446     "variables used within while expression are not mutated in the body"
 447 }
 448
 449 declare_lint_pass!(Loops => [
 450     MANUAL_MEMCPY,
 451     NEEDLESS_RANGE_LOOP,
 452     EXPLICIT_ITER_LOOP,
 453     EXPLICIT_INTO_ITER_LOOP,
 454     ITER_NEXT_LOOP,
 455     FOR_LOOP_OVER_RESULT,
 456     FOR_LOOP_OVER_OPTION,
 457     WHILE_LET_LOOP,
 458     NEEDLESS_COLLECT,
 459     REVERSE_RANGE_LOOP,
 460     EXPLICIT_COUNTER_LOOP,
 461     EMPTY_LOOP,
 462     WHILE_LET_ON_ITERATOR,
 463     FOR_KV_MAP,
 464     NEVER_LOOP,
 465     MUT_RANGE_BOUND,
 466     WHILE_IMMUTABLE_CONDITION,
 467 ]);
 468
 469 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Loops {
 470     #[allow(clippy::too_many_lines)]
 471     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
 472         // we don't want to check expanded macros
 473         if in_macro_or_desugar(expr.span) {
 474             return;
 475         }
 476
 477         if let Some((pat, arg, body)) = higher::for_loop(expr) {
 478             check_for_loop(cx, pat, arg, body, expr);
 479         }
 480
 481         // check for never_loop
 482         if let ExprKind::Loop(ref block, _, _) = expr.node {
 483             match never_loop_block(block, expr.hir_id) {
 484                 NeverLoopResult::AlwaysBreak => span_lint(cx, NEVER_LOOP, expr.span, "this loop never actually loops"),
 485                 NeverLoopResult::MayContinueMainLoop | NeverLoopResult::Otherwise => (),
 486             }
 487         }
 488
 489         // check for `loop { if let {} else break }` that could be `while let`
 490         // (also matches an explicit "match" instead of "if let")
 491         // (even if the "match" or "if let" is used for declaration)
 492         if let ExprKind::Loop(ref block, _, LoopSource::Loop) = expr.node {
 493             // also check for empty `loop {}` statements
 494             if block.stmts.is_empty() && block.expr.is_none() {
 495                 span_lint(
 496                     cx,
 497                     EMPTY_LOOP,
 498                     expr.span,
 499                     "empty `loop {}` detected. You may want to either use `panic!()` or add \
 500                      `std::thread::sleep(..);` to the loop body.",
 501                 );
 502             }
 503
 504             // extract the expression from the first statement (if any) in a block
 505             let inner_stmt_expr = extract_expr_from_first_stmt(block);
 506             // or extract the first expression (if any) from the block
 507             if let Some(inner) = inner_stmt_expr.or_else(|| extract_first_expr(block)) {
 508                 if let ExprKind::Match(ref matchexpr, ref arms, ref source) = inner.node {
 509                     // ensure "if let" compatible match structure
 510                     match *source {
 511                         MatchSource::Normal | MatchSource::IfLetDesugar { .. } => {
 512                             if arms.len() == 2
 513                                 && arms[0].pats.len() == 1
 514                                 && arms[0].guard.is_none()
 515                                 && arms[1].pats.len() == 1
 516                                 && arms[1].guard.is_none()
 517                                 && is_simple_break_expr(&arms[1].body)
 518                             {
 519                                 if in_external_macro(cx.sess(), expr.span) {
 520                                     return;
 521                                 }
 522
 523                                 // NOTE: we used to build a body here instead of using
 524                                 // ellipsis, this was removed because:
 525                                 // 1) it was ugly with big bodies;
 526                                 // 2) it was not indented properly;
 527                                 // 3) it wasn’t very smart (see #675).
 528                                 let mut applicability = Applicability::HasPlaceholders;
 529                                 span_lint_and_sugg(
 530                                     cx,
 531                                     WHILE_LET_LOOP,
 532                                     expr.span,
 533                                     "this loop could be written as a `while let` loop",
 534                                     "try",
 535                                     format!(
 536                                         "while let {} = {} {{ .. }}",
 537                                         snippet_with_applicability(cx, arms[0].pats[0].span, "..", &mut applicability),
 538                                         snippet_with_applicability(cx, matchexpr.span, "..", &mut applicability),
 539                                     ),
 540                                     applicability,
 541                                 );
 542                             }
 543                         },
 544                         _ => (),
 545                     }
 546                 }
 547             }
 548         }
 549         if let ExprKind::Match(ref match_expr, ref arms, MatchSource::WhileLetDesugar) = expr.node {
 550             let pat = &arms[0].pats[0].node;
 551             if let (
 552                 &PatKind::TupleStruct(ref qpath, ref pat_args, _),
 553                 &ExprKind::MethodCall(ref method_path, _, ref method_args),
 554             ) = (pat, &match_expr.node)
 555             {
 556                 let iter_expr = &method_args[0];
 557                 let lhs_constructor = last_path_segment(qpath);
 558                 if method_path.ident.name == sym!(next)
 559                     && match_trait_method(cx, match_expr, &paths::ITERATOR)
 560                     && lhs_constructor.ident.name == sym!(Some)
 561                     && (pat_args.is_empty()
 562                         || !is_refutable(cx, &pat_args[0])
 563                             && !is_used_inside(cx, iter_expr, &arms[0].body)
 564                             && !is_iterator_used_after_while_let(cx, iter_expr)
 565                             && !is_nested(cx, expr, &method_args[0]))
 566                 {
 567                     let iterator = snippet(cx, method_args[0].span, "_");
 568                     let loop_var = if pat_args.is_empty() {
 569                         "_".to_string()
 570                     } else {
 571                         snippet(cx, pat_args[0].span, "_").into_owned()
 572                     };
 573                     span_lint_and_sugg(
 574                         cx,
 575                         WHILE_LET_ON_ITERATOR,
 576                         expr.span,
 577                         "this loop could be written as a `for` loop",
 578                         "try",
 579                         format!("for {} in {} {{ .. }}", loop_var, iterator),
 580                         Applicability::HasPlaceholders,
 581                     );
 582                 }
 583             }
 584         }
 585
 586         if let Some((cond, body)) = higher::while_loop(&expr) {
 587             check_infinite_loop(cx, cond, body);
 588         }
 589
 590         check_needless_collect(expr, cx);
 591     }
 592 }
 593
 594 enum NeverLoopResult {
 595     // A break/return always get triggered but not necessarily for the main loop.
 596     AlwaysBreak,
 597     // A continue may occur for the main loop.
 598     MayContinueMainLoop,
 599     Otherwise,
 600 }
 601
 602 fn absorb_break(arg: &NeverLoopResult) -> NeverLoopResult {
 603     match *arg {
 604         NeverLoopResult::AlwaysBreak | NeverLoopResult::Otherwise => NeverLoopResult::Otherwise,
 605         NeverLoopResult::MayContinueMainLoop => NeverLoopResult::MayContinueMainLoop,
 606     }
 607 }
 608
 609 // Combine two results for parts that are called in order.
 610 fn combine_seq(first: NeverLoopResult, second: NeverLoopResult) -> NeverLoopResult {
 611     match first {
 612         NeverLoopResult::AlwaysBreak | NeverLoopResult::MayContinueMainLoop => first,
 613         NeverLoopResult::Otherwise => second,
 614     }
 615 }
 616
 617 // Combine two results where both parts are called but not necessarily in order.
 618 fn combine_both(left: NeverLoopResult, right: NeverLoopResult) -> NeverLoopResult {
 619     match (left, right) {
 620         (NeverLoopResult::MayContinueMainLoop, _) | (_, NeverLoopResult::MayContinueMainLoop) => {
 621             NeverLoopResult::MayContinueMainLoop
 622         },
 623         (NeverLoopResult::AlwaysBreak, _) | (_, NeverLoopResult::AlwaysBreak) => NeverLoopResult::AlwaysBreak,
 624         (NeverLoopResult::Otherwise, NeverLoopResult::Otherwise) => NeverLoopResult::Otherwise,
 625     }
 626 }
 627
 628 // Combine two results where only one of the part may have been executed.
 629 fn combine_branches(b1: NeverLoopResult, b2: NeverLoopResult) -> NeverLoopResult {
 630     match (b1, b2) {
 631         (NeverLoopResult::AlwaysBreak, NeverLoopResult::AlwaysBreak) => NeverLoopResult::AlwaysBreak,
 632         (NeverLoopResult::MayContinueMainLoop, _) | (_, NeverLoopResult::MayContinueMainLoop) => {
 633             NeverLoopResult::MayContinueMainLoop
 634         },
 635         (NeverLoopResult::Otherwise, _) | (_, NeverLoopResult::Otherwise) => NeverLoopResult::Otherwise,
 636     }
 637 }
 638
 639 fn never_loop_block(block: &Block, main_loop_id: HirId) -> NeverLoopResult {
 640     let stmts = block.stmts.iter().map(stmt_to_expr);
 641     let expr = once(block.expr.as_ref().map(|p| &**p));
 642     let mut iter = stmts.chain(expr).filter_map(|e| e);
 643     never_loop_expr_seq(&mut iter, main_loop_id)
 644 }
 645
 646 fn stmt_to_expr(stmt: &Stmt) -> Option<&Expr> {
 647     match stmt.node {
 648         StmtKind::Semi(ref e, ..) | StmtKind::Expr(ref e, ..) => Some(e),
 649         StmtKind::Local(ref local) => local.init.as_ref().map(|p| &**p),
 650         _ => None,
 651     }
 652 }
 653
 654 fn never_loop_expr(expr: &Expr, main_loop_id: HirId) -> NeverLoopResult {
 655     match expr.node {
 656         ExprKind::Box(ref e)
 657         | ExprKind::Unary(_, ref e)
 658         | ExprKind::Cast(ref e, _)
 659         | ExprKind::Type(ref e, _)
 660         | ExprKind::Field(ref e, _)
 661         | ExprKind::AddrOf(_, ref e)
 662         | ExprKind::Struct(_, _, Some(ref e))
 663         | ExprKind::Repeat(ref e, _)
 664         | ExprKind::DropTemps(ref e) => never_loop_expr(e, main_loop_id),
 665         ExprKind::Array(ref es) | ExprKind::MethodCall(_, _, ref es) | ExprKind::Tup(ref es) => {
 666             never_loop_expr_all(&mut es.iter(), main_loop_id)
 667         },
 668         ExprKind::Call(ref e, ref es) => never_loop_expr_all(&mut once(&**e).chain(es.iter()), main_loop_id),
 669         ExprKind::Binary(_, ref e1, ref e2)
 670         | ExprKind::Assign(ref e1, ref e2)
 671         | ExprKind::AssignOp(_, ref e1, ref e2)
 672         | ExprKind::Index(ref e1, ref e2) => never_loop_expr_all(&mut [&**e1, &**e2].iter().cloned(), main_loop_id),
 673         ExprKind::Loop(ref b, _, _) => {
 674             // Break can come from the inner loop so remove them.
 675             absorb_break(&never_loop_block(b, main_loop_id))
 676         },
 677         ExprKind::Match(ref e, ref arms, _) => {
 678             let e = never_loop_expr(e, main_loop_id);
 679             if arms.is_empty() {
 680                 e
 681             } else {
 682                 let arms = never_loop_expr_branch(&mut arms.iter().map(|a| &*a.body), main_loop_id);
 683                 combine_seq(e, arms)
 684             }
 685         },
 686         ExprKind::Block(ref b, _) => never_loop_block(b, main_loop_id),
 687         ExprKind::Continue(d) => {
 688             let id = d
 689                 .target_id
 690                 .expect("target ID can only be missing in the presence of compilation errors");
 691             if id == main_loop_id {
 692                 NeverLoopResult::MayContinueMainLoop
 693             } else {
 694                 NeverLoopResult::AlwaysBreak
 695             }
 696         },
 697         ExprKind::Break(_, ref e) | ExprKind::Ret(ref e) => {
 698             if let Some(ref e) = *e {
 699                 combine_seq(never_loop_expr(e, main_loop_id), NeverLoopResult::AlwaysBreak)
 700             } else {
 701                 NeverLoopResult::AlwaysBreak
 702             }
 703         },
 704         ExprKind::Struct(_, _, None)
 705         | ExprKind::Yield(_, _)
 706         | ExprKind::Closure(_, _, _, _, _)
 707         | ExprKind::InlineAsm(_, _, _)
 708         | ExprKind::Path(_)
 709         | ExprKind::Lit(_)
 710         | ExprKind::Err => NeverLoopResult::Otherwise,
 711     }
 712 }
 713
 714 fn never_loop_expr_seq<'a, T: Iterator<Item = &'a Expr>>(es: &mut T, main_loop_id: HirId) -> NeverLoopResult {
 715     es.map(|e| never_loop_expr(e, main_loop_id))
 716         .fold(NeverLoopResult::Otherwise, combine_seq)
 717 }
 718
 719 fn never_loop_expr_all<'a, T: Iterator<Item = &'a Expr>>(es: &mut T, main_loop_id: HirId) -> NeverLoopResult {
 720     es.map(|e| never_loop_expr(e, main_loop_id))
 721         .fold(NeverLoopResult::Otherwise, combine_both)
 722 }
 723
 724 fn never_loop_expr_branch<'a, T: Iterator<Item = &'a Expr>>(e: &mut T, main_loop_id: HirId) -> NeverLoopResult {
 725     e.map(|e| never_loop_expr(e, main_loop_id))
 726         .fold(NeverLoopResult::AlwaysBreak, combine_branches)
 727 }
 728
 729 fn check_for_loop<'a, 'tcx>(
 730     cx: &LateContext<'a, 'tcx>,
 731     pat: &'tcx Pat,
 732     arg: &'tcx Expr,
 733     body: &'tcx Expr,
 734     expr: &'tcx Expr,
 735 ) {
 736     check_for_loop_range(cx, pat, arg, body, expr);
 737     check_for_loop_reverse_range(cx, arg, expr);
 738     check_for_loop_arg(cx, pat, arg, expr);
 739     check_for_loop_explicit_counter(cx, pat, arg, body, expr);
 740     check_for_loop_over_map_kv(cx, pat, arg, body, expr);
 741     check_for_mut_range_bound(cx, arg, body);
 742     detect_manual_memcpy(cx, pat, arg, body, expr);
 743 }
 744
 745 fn same_var<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &Expr, var: HirId) -> bool {
 746     if_chain! {
 747         if let ExprKind::Path(ref qpath) = expr.node;
 748         if let QPath::Resolved(None, ref path) = *qpath;
 749         if path.segments.len() == 1;
 750         if let Res::Local(local_id) = cx.tables.qpath_res(qpath, expr.hir_id);
 751         // our variable!
 752         if local_id == var;
 753         then {
 754             return true;
 755         }
 756     }
 757
 758     false
 759 }
 760
 761 struct Offset {
 762     value: String,
 763     negate: bool,
 764 }
 765
 766 impl Offset {
 767     fn negative(s: String) -> Self {
 768         Self { value: s, negate: true }
 769     }
 770
 771     fn positive(s: String) -> Self {
 772         Self {
 773             value: s,
 774             negate: false,
 775         }
 776     }
 777 }
 778
 779 struct FixedOffsetVar {
 780     var_name: String,
 781     offset: Offset,
 782 }
 783
 784 fn is_slice_like<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'_>) -> bool {
 785     let is_slice = match ty.sty {
 786         ty::Ref(_, subty, _) => is_slice_like(cx, subty),
 787         ty::Slice(..) | ty::Array(..) => true,
 788         _ => false,
 789     };
 790
 791     is_slice || match_type(cx, ty, &paths::VEC) || match_type(cx, ty, &paths::VEC_DEQUE)
 792 }
 793
 794 fn get_fixed_offset_var<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &Expr, var: HirId) -> Option<FixedOffsetVar> {
 795     fn extract_offset<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, e: &Expr, var: HirId) -> Option<String> {
 796         match e.node {
 797             ExprKind::Lit(ref l) => match l.node {
 798                 ast::LitKind::Int(x, _ty) => Some(x.to_string()),
 799                 _ => None,
 800             },
 801             ExprKind::Path(..) if !same_var(cx, e, var) => Some(snippet_opt(cx, e.span).unwrap_or_else(|| "??".into())),
 802             _ => None,
 803         }
 804     }
 805
 806     if let ExprKind::Index(ref seqexpr, ref idx) = expr.node {
 807         let ty = cx.tables.expr_ty(seqexpr);
 808         if !is_slice_like(cx, ty) {
 809             return None;
 810         }
 811
 812         let offset = match idx.node {
 813             ExprKind::Binary(op, ref lhs, ref rhs) => match op.node {
 814                 BinOpKind::Add => {
 815                     let offset_opt = if same_var(cx, lhs, var) {
 816                         extract_offset(cx, rhs, var)
 817                     } else if same_var(cx, rhs, var) {
 818                         extract_offset(cx, lhs, var)
 819                     } else {
 820                         None
 821                     };
 822
 823                     offset_opt.map(Offset::positive)
 824                 },
 825                 BinOpKind::Sub if same_var(cx, lhs, var) => extract_offset(cx, rhs, var).map(Offset::negative),
 826                 _ => None,
 827             },
 828             ExprKind::Path(..) => {
 829                 if same_var(cx, idx, var) {
 830                     Some(Offset::positive("0".into()))
 831                 } else {
 832                     None
 833                 }
 834             },
 835             _ => None,
 836         };
 837
 838         offset.map(|o| FixedOffsetVar {
 839             var_name: snippet_opt(cx, seqexpr.span).unwrap_or_else(|| "???".into()),
 840             offset: o,
 841         })
 842     } else {
 843         None
 844     }
 845 }
 846
 847 fn fetch_cloned_fixed_offset_var<'a, 'tcx>(
 848     cx: &LateContext<'a, 'tcx>,
 849     expr: &Expr,
 850     var: HirId,
 851 ) -> Option<FixedOffsetVar> {
 852     if_chain! {
 853         if let ExprKind::MethodCall(ref method, _, ref args) = expr.node;
 854         if method.ident.name == sym!(clone);
 855         if args.len() == 1;
 856         if let Some(arg) = args.get(0);
 857         then {
 858             return get_fixed_offset_var(cx, arg, var);
 859         }
 860     }
 861
 862     get_fixed_offset_var(cx, expr, var)
 863 }
 864
 865 fn get_indexed_assignments<'a, 'tcx>(
 866     cx: &LateContext<'a, 'tcx>,
 867     body: &Expr,
 868     var: HirId,
 869 ) -> Vec<(FixedOffsetVar, FixedOffsetVar)> {
 870     fn get_assignment<'a, 'tcx>(
 871         cx: &LateContext<'a, 'tcx>,
 872         e: &Expr,
 873         var: HirId,
 874     ) -> Option<(FixedOffsetVar, FixedOffsetVar)> {
 875         if let ExprKind::Assign(ref lhs, ref rhs) = e.node {
 876             match (
 877                 get_fixed_offset_var(cx, lhs, var),
 878                 fetch_cloned_fixed_offset_var(cx, rhs, var),
 879             ) {
 880                 (Some(offset_left), Some(offset_right)) => {
 881                     // Source and destination must be different
 882                     if offset_left.var_name == offset_right.var_name {
 883                         None
 884                     } else {
 885                         Some((offset_left, offset_right))
 886                     }
 887                 },
 888                 _ => None,
 889             }
 890         } else {
 891             None
 892         }
 893     }
 894
 895     if let ExprKind::Block(ref b, _) = body.node {
 896         let Block {
 897             ref stmts, ref expr, ..
 898         } = **b;
 899
 900         stmts
 901             .iter()
 902             .map(|stmt| match stmt.node {
 903                 StmtKind::Local(..) | StmtKind::Item(..) => None,
 904                 StmtKind::Expr(ref e) | StmtKind::Semi(ref e) => Some(get_assignment(cx, e, var)),
 905             })
 906             .chain(expr.as_ref().into_iter().map(|e| Some(get_assignment(cx, &*e, var))))
 907             .filter_map(|op| op)
 908             .collect::<Option<Vec<_>>>()
 909             .unwrap_or_else(|| vec![])
 910     } else {
 911         get_assignment(cx, body, var).into_iter().collect()
 912     }
 913 }
 914
 915 /// Checks for for loops that sequentially copy items from one slice-like
 916 /// object to another.
 917 fn detect_manual_memcpy<'a, 'tcx>(
 918     cx: &LateContext<'a, 'tcx>,
 919     pat: &'tcx Pat,
 920     arg: &'tcx Expr,
 921     body: &'tcx Expr,
 922     expr: &'tcx Expr,
 923 ) {
 924     if let Some(higher::Range {
 925         start: Some(start),
 926         ref end,
 927         limits,
 928     }) = higher::range(cx, arg)
 929     {
 930         // the var must be a single name
 931         if let PatKind::Binding(_, canonical_id, _, _) = pat.node {
 932             let print_sum = |arg1: &Offset, arg2: &Offset| -> String {
 933                 match (&arg1.value[..], arg1.negate, &arg2.value[..], arg2.negate) {
 934                     ("0", _, "0", _) => "".into(),
 935                     ("0", _, x, false) | (x, false, "0", false) => x.into(),
 936                     ("0", _, x, true) | (x, false, "0", true) => format!("-{}", x),
 937                     (x, false, y, false) => format!("({} + {})", x, y),
 938                     (x, false, y, true) => {
 939                         if x == y {
 940                             "0".into()
 941                         } else {
 942                             format!("({} - {})", x, y)
 943                         }
 944                     },
 945                     (x, true, y, false) => {
 946                         if x == y {
 947                             "0".into()
 948                         } else {
 949                             format!("({} - {})", y, x)
 950                         }
 951                     },
 952                     (x, true, y, true) => format!("-({} + {})", x, y),
 953                 }
 954             };
 955
 956             let print_limit = |end: &Option<&Expr>, offset: Offset, var_name: &str| {
 957                 if let Some(end) = *end {
 958                     if_chain! {
 959                         if let ExprKind::MethodCall(ref method, _, ref len_args) = end.node;
 960                         if method.ident.name == sym!(len);
 961                         if len_args.len() == 1;
 962                         if let Some(arg) = len_args.get(0);
 963                         if snippet(cx, arg.span, "??") == var_name;
 964                         then {
 965                             return if offset.negate {
 966                                 format!("({} - {})", snippet(cx, end.span, "<src>.len()"), offset.value)
 967                             } else {
 968                                 String::new()
 969                             };
 970                         }
 971                     }
 972
 973                     let end_str = match limits {
 974                         ast::RangeLimits::Closed => {
 975                             let end = sugg::Sugg::hir(cx, end, "<count>");
 976                             format!("{}", end + sugg::ONE)
 977                         },
 978                         ast::RangeLimits::HalfOpen => format!("{}", snippet(cx, end.span, "..")),
 979                     };
 980
 981                     print_sum(&Offset::positive(end_str), &offset)
 982                 } else {
 983                     "..".into()
 984                 }
 985             };
 986
 987             // The only statements in the for loops can be indexed assignments from
 988             // indexed retrievals.
 989             let manual_copies = get_indexed_assignments(cx, body, canonical_id);
 990
 991             let big_sugg = manual_copies
 992                 .into_iter()
 993                 .map(|(dst_var, src_var)| {
 994                     let start_str = Offset::positive(snippet(cx, start.span, "").to_string());
 995                     let dst_offset = print_sum(&start_str, &dst_var.offset);
 996                     let dst_limit = print_limit(end, dst_var.offset, &dst_var.var_name);
 997                     let src_offset = print_sum(&start_str, &src_var.offset);
 998                     let src_limit = print_limit(end, src_var.offset, &src_var.var_name);
 999                     let dst = if dst_offset == "" && dst_limit == "" {
1000                         dst_var.var_name
1001                     } else {
1002                         format!("{}[{}..{}]", dst_var.var_name, dst_offset, dst_limit)
1003                     };
1004
1005                     format!(
1006                         "{}.clone_from_slice(&{}[{}..{}])",
1007                         dst, src_var.var_name, src_offset, src_limit
1008                     )
1009                 })
1010                 .join("\n    ");
1011
1012             if !big_sugg.is_empty() {
1013                 span_lint_and_sugg(
1014                     cx,
1015                     MANUAL_MEMCPY,
1016                     expr.span,
1017                     "it looks like you're manually copying between slices",
1018                     "try replacing the loop by",
1019                     big_sugg,
1020                     Applicability::Unspecified,
1021                 );
1022             }
1023         }
1024     }
1025 }
1026
1027 /// Checks for looping over a range and then indexing a sequence with it.
1028 /// The iteratee must be a range literal.
1029 #[allow(clippy::too_many_lines)]
1030 fn check_for_loop_range<'a, 'tcx>(
1031     cx: &LateContext<'a, 'tcx>,
1032     pat: &'tcx Pat,
1033     arg: &'tcx Expr,
1034     body: &'tcx Expr,
1035     expr: &'tcx Expr,
1036 ) {
1037     if in_macro_or_desugar(expr.span) {
1038         return;
1039     }
1040
1041     if let Some(higher::Range {
1042         start: Some(start),
1043         ref end,
1044         limits,
1045     }) = higher::range(cx, arg)
1046     {
1047         // the var must be a single name
1048         if let PatKind::Binding(_, canonical_id, ident, _) = pat.node {
1049             let mut visitor = VarVisitor {
1050                 cx,
1051                 var: canonical_id,
1052                 indexed_mut: FxHashSet::default(),
1053                 indexed_indirectly: FxHashMap::default(),
1054                 indexed_directly: FxHashMap::default(),
1055                 referenced: FxHashSet::default(),
1056                 nonindex: false,
1057                 prefer_mutable: false,
1058             };
1059             walk_expr(&mut visitor, body);
1060
1061             // linting condition: we only indexed one variable, and indexed it directly
1062             if visitor.indexed_indirectly.is_empty() && visitor.indexed_directly.len() == 1 {
1063                 let (indexed, (indexed_extent, indexed_ty)) = visitor
1064                     .indexed_directly
1065                     .into_iter()
1066                     .next()
1067                     .expect("already checked that we have exactly 1 element");
1068
1069                 // ensure that the indexed variable was declared before the loop, see #601
1070                 if let Some(indexed_extent) = indexed_extent {
1071                     let parent_id = cx.tcx.hir().get_parent_item(expr.hir_id);
1072                     let parent_def_id = cx.tcx.hir().local_def_id(parent_id);
1073                     let region_scope_tree = cx.tcx.region_scope_tree(parent_def_id);
1074                     let pat_extent = region_scope_tree.var_scope(pat.hir_id.local_id);
1075                     if region_scope_tree.is_subscope_of(indexed_extent, pat_extent) {
1076                         return;
1077                     }
1078                 }
1079
1080                 // don't lint if the container that is indexed does not have .iter() method
1081                 let has_iter = has_iter_method(cx, indexed_ty);
1082                 if has_iter.is_none() {
1083                     return;
1084                 }
1085
1086                 // don't lint if the container that is indexed into is also used without
1087                 // indexing
1088                 if visitor.referenced.contains(&indexed) {
1089                     return;
1090                 }
1091
1092                 let starts_at_zero = is_integer_literal(start, 0);
1093
1094                 let skip = if starts_at_zero {
1095                     String::new()
1096                 } else {
1097                     format!(".skip({})", snippet(cx, start.span, ".."))
1098                 };
1099
1100                 let mut end_is_start_plus_val = false;
1101
1102                 let take = if let Some(end) = *end {
1103                     let mut take_expr = end;
1104
1105                     if let ExprKind::Binary(ref op, ref left, ref right) = end.node {
1106                         if let BinOpKind::Add = op.node {
1107                             let start_equal_left = SpanlessEq::new(cx).eq_expr(start, left);
1108                             let start_equal_right = SpanlessEq::new(cx).eq_expr(start, right);
1109
1110                             if start_equal_left {
1111                                 take_expr = right;
1112                             } else if start_equal_right {
1113                                 take_expr = left;
1114                             }
1115
1116                             end_is_start_plus_val = start_equal_left | start_equal_right;
1117                         }
1118                     }
1119
1120                     if is_len_call(end, indexed) || is_end_eq_array_len(cx, end, limits, indexed_ty) {
1121                         String::new()
1122                     } else {
1123                         match limits {
1124                             ast::RangeLimits::Closed => {
1125                                 let take_expr = sugg::Sugg::hir(cx, take_expr, "<count>");
1126                                 format!(".take({})", take_expr + sugg::ONE)
1127                             },
1128                             ast::RangeLimits::HalfOpen => format!(".take({})", snippet(cx, take_expr.span, "..")),
1129                         }
1130                     }
1131                 } else {
1132                     String::new()
1133                 };
1134
1135                 let (ref_mut, method) = if visitor.indexed_mut.contains(&indexed) {
1136                     ("mut ", "iter_mut")
1137                 } else {
1138                     ("", "iter")
1139                 };
1140
1141                 let take_is_empty = take.is_empty();
1142                 let mut method_1 = take;
1143                 let mut method_2 = skip;
1144
1145                 if end_is_start_plus_val {
1146                     mem::swap(&mut method_1, &mut method_2);
1147                 }
1148
1149                 if visitor.nonindex {
1150                     span_lint_and_then(
1151                         cx,
1152                         NEEDLESS_RANGE_LOOP,
1153                         expr.span,
1154                         &format!("the loop variable `{}` is used to index `{}`", ident.name, indexed),
1155                         |db| {
1156                             multispan_sugg(
1157                                 db,
1158                                 "consider using an iterator".to_string(),
1159                                 vec![
1160                                     (pat.span, format!("({}, <item>)", ident.name)),
1161                                     (
1162                                         arg.span,
1163                                         format!("{}.{}().enumerate(){}{}", indexed, method, method_1, method_2),
1164                                     ),
1165                                 ],
1166                             );
1167                         },
1168                     );
1169                 } else {
1170                     let repl = if starts_at_zero && take_is_empty {
1171                         format!("&{}{}", ref_mut, indexed)
1172                     } else {
1173                         format!("{}.{}(){}{}", indexed, method, method_1, method_2)
1174                     };
1175
1176                     span_lint_and_then(
1177                         cx,
1178                         NEEDLESS_RANGE_LOOP,
1179                         expr.span,
1180                         &format!(
1181                             "the loop variable `{}` is only used to index `{}`.",
1182                             ident.name, indexed
1183                         ),
1184                         |db| {
1185                             multispan_sugg(
1186                                 db,
1187                                 "consider using an iterator".to_string(),
1188                                 vec![(pat.span, "<item>".to_string()), (arg.span, repl)],
1189                             );
1190                         },
1191                     );
1192                 }
1193             }
1194         }
1195     }
1196 }
1197
1198 fn is_len_call(expr: &Expr, var: Name) -> bool {
1199     if_chain! {
1200         if let ExprKind::MethodCall(ref method, _, ref len_args) = expr.node;
1201         if len_args.len() == 1;
1202         if method.ident.name == sym!(len);
1203         if let ExprKind::Path(QPath::Resolved(_, ref path)) = len_args[0].node;
1204         if path.segments.len() == 1;
1205         if path.segments[0].ident.name == var;
1206         then {
1207             return true;
1208         }
1209     }
1210
1211     false
1212 }
1213
1214 fn is_end_eq_array_len<'tcx>(
1215     cx: &LateContext<'_, 'tcx>,
1216     end: &Expr,
1217     limits: ast::RangeLimits,
1218     indexed_ty: Ty<'tcx>,
1219 ) -> bool {
1220     if_chain! {
1221         if let ExprKind::Lit(ref lit) = end.node;
1222         if let ast::LitKind::Int(end_int, _) = lit.node;
1223         if let ty::Array(_, arr_len_const) = indexed_ty.sty;
1224         if let Some(arr_len) = arr_len_const.try_eval_usize(cx.tcx, cx.param_env);
1225         then {
1226             return match limits {
1227                 ast::RangeLimits::Closed => end_int + 1 >= arr_len.into(),
1228                 ast::RangeLimits::HalfOpen => end_int >= arr_len.into(),
1229             };
1230         }
1231     }
1232
1233     false
1234 }
1235
1236 fn check_for_loop_reverse_range<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, arg: &'tcx Expr, expr: &'tcx Expr) {
1237     // if this for loop is iterating over a two-sided range...
1238     if let Some(higher::Range {
1239         start: Some(start),
1240         end: Some(end),
1241         limits,
1242     }) = higher::range(cx, arg)
1243     {
1244         // ...and both sides are compile-time constant integers...
1245         if let Some((start_idx, _)) = constant(cx, cx.tables, start) {
1246             if let Some((end_idx, _)) = constant(cx, cx.tables, end) {
1247                 // ...and the start index is greater than the end index,
1248                 // this loop will never run. This is often confusing for developers
1249                 // who think that this will iterate from the larger value to the
1250                 // smaller value.
1251                 let ty = cx.tables.expr_ty(start);
1252                 let (sup, eq) = match (start_idx, end_idx) {
1253                     (Constant::Int(start_idx), Constant::Int(end_idx)) => (
1254                         match ty.sty {
1255                             ty::Int(ity) => sext(cx.tcx, start_idx, ity) > sext(cx.tcx, end_idx, ity),
1256                             ty::Uint(_) => start_idx > end_idx,
1257                             _ => false,
1258                         },
1259                         start_idx == end_idx,
1260                     ),
1261                     _ => (false, false),
1262                 };
1263
1264                 if sup {
1265                     let start_snippet = snippet(cx, start.span, "_");
1266                     let end_snippet = snippet(cx, end.span, "_");
1267                     let dots = if limits == ast::RangeLimits::Closed {
1268                         "..."
1269                     } else {
1270                         ".."
1271                     };
1272
1273                     span_lint_and_then(
1274                         cx,
1275                         REVERSE_RANGE_LOOP,
1276                         expr.span,
1277                         "this range is empty so this for loop will never run",
1278                         |db| {
1279                             db.span_suggestion(
1280                                 arg.span,
1281                                 "consider using the following if you are attempting to iterate over this \
1282                                  range in reverse",
1283                                 format!(
1284                                     "({end}{dots}{start}).rev()",
1285                                     end = end_snippet,
1286                                     dots = dots,
1287                                     start = start_snippet
1288                                 ),
1289                                 Applicability::MaybeIncorrect,
1290                             );
1291                         },
1292                     );
1293                 } else if eq && limits != ast::RangeLimits::Closed {
1294                     // if they are equal, it's also problematic - this loop
1295                     // will never run.
1296                     span_lint(
1297                         cx,
1298                         REVERSE_RANGE_LOOP,
1299                         expr.span,
1300                         "this range is empty so this for loop will never run",
1301                     );
1302                 }
1303             }
1304         }
1305     }
1306 }
1307
1308 fn lint_iter_method(cx: &LateContext<'_, '_>, args: &[Expr], arg: &Expr, method_name: &str) {
1309     let mut applicability = Applicability::MachineApplicable;
1310     let object = snippet_with_applicability(cx, args[0].span, "_", &mut applicability);
1311     let muta = if method_name == "iter_mut" { "mut " } else { "" };
1312     span_lint_and_sugg(
1313         cx,
1314         EXPLICIT_ITER_LOOP,
1315         arg.span,
1316         "it is more concise to loop over references to containers instead of using explicit \
1317          iteration methods",
1318         "to write this more concisely, try",
1319         format!("&{}{}", muta, object),
1320         applicability,
1321     )
1322 }
1323
1324 fn check_for_loop_arg(cx: &LateContext<'_, '_>, pat: &Pat, arg: &Expr, expr: &Expr) {
1325     let mut next_loop_linted = false; // whether or not ITER_NEXT_LOOP lint was used
1326     if let ExprKind::MethodCall(ref method, _, ref args) = arg.node {
1327         // just the receiver, no arguments
1328         if args.len() == 1 {
1329             let method_name = &*method.ident.as_str();
1330             // check for looping over x.iter() or x.iter_mut(), could use &x or &mut x
1331             if method_name == "iter" || method_name == "iter_mut" {
1332                 if is_ref_iterable_type(cx, &args[0]) {
1333                     lint_iter_method(cx, args, arg, method_name);
1334                 }
1335             } else if method_name == "into_iter" && match_trait_method(cx, arg, &paths::INTO_ITERATOR) {
1336                 let def_id = cx.tables.type_dependent_def_id(arg.hir_id).unwrap();
1337                 let substs = cx.tables.node_substs(arg.hir_id);
1338                 let method_type = cx.tcx.type_of(def_id).subst(cx.tcx, substs);
1339
1340                 let fn_arg_tys = method_type.fn_sig(cx.tcx).inputs();
1341                 assert_eq!(fn_arg_tys.skip_binder().len(), 1);
1342                 if fn_arg_tys.skip_binder()[0].is_region_ptr() {
1343                     match cx.tables.expr_ty(&args[0]).sty {
1344                         // If the length is greater than 32 no traits are implemented for array and
1345                         // therefore we cannot use `&`.
1346                         ty::Array(_, size) if size.eval_usize(cx.tcx, cx.param_env) > 32 => {},
1347                         _ => lint_iter_method(cx, args, arg, method_name),
1348                     };
1349                 } else {
1350                     let mut applicability = Applicability::MachineApplicable;
1351                     let object = snippet_with_applicability(cx, args[0].span, "_", &mut applicability);
1352                     span_lint_and_sugg(
1353                         cx,
1354                         EXPLICIT_INTO_ITER_LOOP,
1355                         arg.span,
1356                         "it is more concise to loop over containers instead of using explicit \
1357                          iteration methods`",
1358                         "to write this more concisely, try",
1359                         object.to_string(),
1360                         applicability,
1361                     );
1362                 }
1363             } else if method_name == "next" && match_trait_method(cx, arg, &paths::ITERATOR) {
1364                 span_lint(
1365                     cx,
1366                     ITER_NEXT_LOOP,
1367                     expr.span,
1368                     "you are iterating over `Iterator::next()` which is an Option; this will compile but is \
1369                      probably not what you want",
1370                 );
1371                 next_loop_linted = true;
1372             }
1373         }
1374     }
1375     if !next_loop_linted {
1376         check_arg_type(cx, pat, arg);
1377     }
1378 }
1379
1380 /// Checks for `for` loops over `Option`s and `Result`s.
1381 fn check_arg_type(cx: &LateContext<'_, '_>, pat: &Pat, arg: &Expr) {
1382     let ty = cx.tables.expr_ty(arg);
1383     if match_type(cx, ty, &paths::OPTION) {
1384         span_help_and_lint(
1385             cx,
1386             FOR_LOOP_OVER_OPTION,
1387             arg.span,
1388             &format!(
1389                 "for loop over `{0}`, which is an `Option`. This is more readably written as an \
1390                  `if let` statement.",
1391                 snippet(cx, arg.span, "_")
1392             ),
1393             &format!(
1394                 "consider replacing `for {0} in {1}` with `if let Some({0}) = {1}`",
1395                 snippet(cx, pat.span, "_"),
1396                 snippet(cx, arg.span, "_")
1397             ),
1398         );
1399     } else if match_type(cx, ty, &paths::RESULT) {
1400         span_help_and_lint(
1401             cx,
1402             FOR_LOOP_OVER_RESULT,
1403             arg.span,
1404             &format!(
1405                 "for loop over `{0}`, which is a `Result`. This is more readably written as an \
1406                  `if let` statement.",
1407                 snippet(cx, arg.span, "_")
1408             ),
1409             &format!(
1410                 "consider replacing `for {0} in {1}` with `if let Ok({0}) = {1}`",
1411                 snippet(cx, pat.span, "_"),
1412                 snippet(cx, arg.span, "_")
1413             ),
1414         );
1415     }
1416 }
1417
1418 fn check_for_loop_explicit_counter<'a, 'tcx>(
1419     cx: &LateContext<'a, 'tcx>,
1420     pat: &'tcx Pat,
1421     arg: &'tcx Expr,
1422     body: &'tcx Expr,
1423     expr: &'tcx Expr,
1424 ) {
1425     // Look for variables that are incremented once per loop iteration.
1426     let mut visitor = IncrementVisitor {
1427         cx,
1428         states: FxHashMap::default(),
1429         depth: 0,
1430         done: false,
1431     };
1432     walk_expr(&mut visitor, body);
1433
1434     // For each candidate, check the parent block to see if
1435     // it's initialized to zero at the start of the loop.
1436     if let Some(block) = get_enclosing_block(&cx, expr.hir_id) {
1437         for (id, _) in visitor.states.iter().filter(|&(_, v)| *v == VarState::IncrOnce) {
1438             let mut visitor2 = InitializeVisitor {
1439                 cx,
1440                 end_expr: expr,
1441                 var_id: *id,
1442                 state: VarState::IncrOnce,
1443                 name: None,
1444                 depth: 0,
1445                 past_loop: false,
1446             };
1447             walk_block(&mut visitor2, block);
1448
1449             if visitor2.state == VarState::Warn {
1450                 if let Some(name) = visitor2.name {
1451                     let mut applicability = Applicability::MachineApplicable;
1452                     span_lint_and_sugg(
1453                         cx,
1454                         EXPLICIT_COUNTER_LOOP,
1455                         expr.span,
1456                         &format!("the variable `{}` is used as a loop counter.", name),
1457                         "consider using",
1458                         format!(
1459                             "for ({}, {}) in {}.enumerate()",
1460                             name,
1461                             snippet_with_applicability(cx, pat.span, "item", &mut applicability),
1462                             if higher::range(cx, arg).is_some() {
1463                                 format!(
1464                                     "({})",
1465                                     snippet_with_applicability(cx, arg.span, "_", &mut applicability)
1466                                 )
1467                             } else {
1468                                 format!(
1469                                     "{}",
1470                                     sugg::Sugg::hir_with_applicability(cx, arg, "_", &mut applicability).maybe_par()
1471                                 )
1472                             }
1473                         ),
1474                         applicability,
1475                     );
1476                 }
1477             }
1478         }
1479     }
1480 }
1481
1482 /// Checks for the `FOR_KV_MAP` lint.
1483 fn check_for_loop_over_map_kv<'a, 'tcx>(
1484     cx: &LateContext<'a, 'tcx>,
1485     pat: &'tcx Pat,
1486     arg: &'tcx Expr,
1487     body: &'tcx Expr,
1488     expr: &'tcx Expr,
1489 ) {
1490     let pat_span = pat.span;
1491
1492     if let PatKind::Tuple(ref pat, _) = pat.node {
1493         if pat.len() == 2 {
1494             let arg_span = arg.span;
1495             let (new_pat_span, kind, ty, mutbl) = match cx.tables.expr_ty(arg).sty {
1496                 ty::Ref(_, ty, mutbl) => match (&pat[0].node, &pat[1].node) {
1497                     (key, _) if pat_is_wild(key, body) => (pat[1].span, "value", ty, mutbl),
1498                     (_, value) if pat_is_wild(value, body) => (pat[0].span, "key", ty, MutImmutable),
1499                     _ => return,
1500                 },
1501                 _ => return,
1502             };
1503             let mutbl = match mutbl {
1504                 MutImmutable => "",
1505                 MutMutable => "_mut",
1506             };
1507             let arg = match arg.node {
1508                 ExprKind::AddrOf(_, ref expr) => &**expr,
1509                 _ => arg,
1510             };
1511
1512             if match_type(cx, ty, &paths::HASHMAP) || match_type(cx, ty, &paths::BTREEMAP) {
1513                 span_lint_and_then(
1514                     cx,
1515                     FOR_KV_MAP,
1516                     expr.span,
1517                     &format!("you seem to want to iterate on a map's {}s", kind),
1518                     |db| {
1519                         let map = sugg::Sugg::hir(cx, arg, "map");
1520                         multispan_sugg(
1521                             db,
1522                             "use the corresponding method".into(),
1523                             vec![
1524                                 (pat_span, snippet(cx, new_pat_span, kind).into_owned()),
1525                                 (arg_span, format!("{}.{}s{}()", map.maybe_par(), kind, mutbl)),
1526                             ],
1527                         );
1528                     },
1529                 );
1530             }
1531         }
1532     }
1533 }
1534
1535 struct MutatePairDelegate {
1536     hir_id_low: Option<HirId>,
1537     hir_id_high: Option<HirId>,
1538     span_low: Option<Span>,
1539     span_high: Option<Span>,
1540 }
1541
1542 impl<'tcx> Delegate<'tcx> for MutatePairDelegate {
1543     fn consume(&mut self, _: HirId, _: Span, _: &cmt_<'tcx>, _: ConsumeMode) {}
1544
1545     fn matched_pat(&mut self, _: &Pat, _: &cmt_<'tcx>, _: MatchMode) {}
1546
1547     fn consume_pat(&mut self, _: &Pat, _: &cmt_<'tcx>, _: ConsumeMode) {}
1548
1549     fn borrow(&mut self, _: HirId, sp: Span, cmt: &cmt_<'tcx>, _: ty::Region<'_>, bk: ty::BorrowKind, _: LoanCause) {
1550         if let ty::BorrowKind::MutBorrow = bk {
1551             if let Categorization::Local(id) = cmt.cat {
1552                 if Some(id) == self.hir_id_low {
1553                     self.span_low = Some(sp)
1554                 }
1555                 if Some(id) == self.hir_id_high {
1556                     self.span_high = Some(sp)
1557                 }
1558             }
1559         }
1560     }
1561
1562     fn mutate(&mut self, _: HirId, sp: Span, cmt: &cmt_<'tcx>, _: MutateMode) {
1563         if let Categorization::Local(id) = cmt.cat {
1564             if Some(id) == self.hir_id_low {
1565                 self.span_low = Some(sp)
1566             }
1567             if Some(id) == self.hir_id_high {
1568                 self.span_high = Some(sp)
1569             }
1570         }
1571     }
1572
1573     fn decl_without_init(&mut self, _: HirId, _: Span) {}
1574 }
1575
1576 impl<'tcx> MutatePairDelegate {
1577     fn mutation_span(&self) -> (Option<Span>, Option<Span>) {
1578         (self.span_low, self.span_high)
1579     }
1580 }
1581
1582 fn check_for_mut_range_bound(cx: &LateContext<'_, '_>, arg: &Expr, body: &Expr) {
1583     if let Some(higher::Range {
1584         start: Some(start),
1585         end: Some(end),
1586         ..
1587     }) = higher::range(cx, arg)
1588     {
1589         let mut_ids = vec![check_for_mutability(cx, start), check_for_mutability(cx, end)];
1590         if mut_ids[0].is_some() || mut_ids[1].is_some() {
1591             let (span_low, span_high) = check_for_mutation(cx, body, &mut_ids);
1592             mut_warn_with_span(cx, span_low);
1593             mut_warn_with_span(cx, span_high);
1594         }
1595     }
1596 }
1597
1598 fn mut_warn_with_span(cx: &LateContext<'_, '_>, span: Option<Span>) {
1599     if let Some(sp) = span {
1600         span_lint(
1601             cx,
1602             MUT_RANGE_BOUND,
1603             sp,
1604             "attempt to mutate range bound within loop; note that the range of the loop is unchanged",
1605         );
1606     }
1607 }
1608
1609 fn check_for_mutability(cx: &LateContext<'_, '_>, bound: &Expr) -> Option<HirId> {
1610     if_chain! {
1611         if let ExprKind::Path(ref qpath) = bound.node;
1612         if let QPath::Resolved(None, _) = *qpath;
1613         then {
1614             let res = cx.tables.qpath_res(qpath, bound.hir_id);
1615             if let Res::Local(node_id) = res {
1616                 let node_str = cx.tcx.hir().get(node_id);
1617                 if_chain! {
1618                     if let Node::Binding(pat) = node_str;
1619                     if let PatKind::Binding(bind_ann, ..) = pat.node;
1620                     if let BindingAnnotation::Mutable = bind_ann;
1621                     then {
1622                         return Some(node_id);
1623                     }
1624                 }
1625             }
1626         }
1627     }
1628     None
1629 }
1630
1631 fn check_for_mutation(
1632     cx: &LateContext<'_, '_>,
1633     body: &Expr,
1634     bound_ids: &[Option<HirId>],
1635 ) -> (Option<Span>, Option<Span>) {
1636     let mut delegate = MutatePairDelegate {
1637         hir_id_low: bound_ids[0],
1638         hir_id_high: bound_ids[1],
1639         span_low: None,
1640         span_high: None,
1641     };
1642     let def_id = def_id::DefId::local(body.hir_id.owner);
1643     let region_scope_tree = &cx.tcx.region_scope_tree(def_id);
1644     ExprUseVisitor::new(
1645         &mut delegate,
1646         cx.tcx,
1647         def_id,
1648         cx.param_env,
1649         region_scope_tree,
1650         cx.tables,
1651         None,
1652     )
1653     .walk_expr(body);
1654     delegate.mutation_span()
1655 }
1656
1657 /// Returns `true` if the pattern is a `PatWild` or an ident prefixed with `_`.
1658 fn pat_is_wild<'tcx>(pat: &'tcx PatKind, body: &'tcx Expr) -> bool {
1659     match *pat {
1660         PatKind::Wild => true,
1661         PatKind::Binding(.., ident, None) if ident.as_str().starts_with('_') => {
1662             let mut visitor = UsedVisitor {
1663                 var: ident.name,
1664                 used: false,
1665             };
1666             walk_expr(&mut visitor, body);
1667             !visitor.used
1668         },
1669         _ => false,
1670     }
1671 }
1672
1673 struct UsedVisitor {
1674     var: ast::Name, // var to look for
1675     used: bool,     // has the var been used otherwise?
1676 }
1677
1678 impl<'tcx> Visitor<'tcx> for UsedVisitor {
1679     fn visit_expr(&mut self, expr: &'tcx Expr) {
1680         if match_var(expr, self.var) {
1681             self.used = true;
1682         } else {
1683             walk_expr(self, expr);
1684         }
1685     }
1686
1687     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1688         NestedVisitorMap::None
1689     }
1690 }
1691
1692 struct LocalUsedVisitor<'a, 'tcx> {
1693     cx: &'a LateContext<'a, 'tcx>,
1694     local: HirId,
1695     used: bool,
1696 }
1697
1698 impl<'a, 'tcx> Visitor<'tcx> for LocalUsedVisitor<'a, 'tcx> {
1699     fn visit_expr(&mut self, expr: &'tcx Expr) {
1700         if same_var(self.cx, expr, self.local) {
1701             self.used = true;
1702         } else {
1703             walk_expr(self, expr);
1704         }
1705     }
1706
1707     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1708         NestedVisitorMap::None
1709     }
1710 }
1711
1712 struct VarVisitor<'a, 'tcx> {
1713     /// context reference
1714     cx: &'a LateContext<'a, 'tcx>,
1715     /// var name to look for as index
1716     var: HirId,
1717     /// indexed variables that are used mutably
1718     indexed_mut: FxHashSet<Name>,
1719     /// indirectly indexed variables (`v[(i + 4) % N]`), the extend is `None` for global
1720     indexed_indirectly: FxHashMap<Name, Option<region::Scope>>,
1721     /// subset of `indexed` of vars that are indexed directly: `v[i]`
1722     /// this will not contain cases like `v[calc_index(i)]` or `v[(i + 4) % N]`
1723     indexed_directly: FxHashMap<Name, (Option<region::Scope>, Ty<'tcx>)>,
1724     /// Any names that are used outside an index operation.
1725     /// Used to detect things like `&mut vec` used together with `vec[i]`
1726     referenced: FxHashSet<Name>,
1727     /// has the loop variable been used in expressions other than the index of
1728     /// an index op?
1729     nonindex: bool,
1730     /// Whether we are inside the `$` in `&mut $` or `$ = foo` or `$.bar`, where bar
1731     /// takes `&mut self`
1732     prefer_mutable: bool,
1733 }
1734
1735 impl<'a, 'tcx> VarVisitor<'a, 'tcx> {
1736     fn check(&mut self, idx: &'tcx Expr, seqexpr: &'tcx Expr, expr: &'tcx Expr) -> bool {
1737         if_chain! {
1738             // the indexed container is referenced by a name
1739             if let ExprKind::Path(ref seqpath) = seqexpr.node;
1740             if let QPath::Resolved(None, ref seqvar) = *seqpath;
1741             if seqvar.segments.len() == 1;
1742             then {
1743                 let index_used_directly = same_var(self.cx, idx, self.var);
1744                 let indexed_indirectly = {
1745                     let mut used_visitor = LocalUsedVisitor {
1746                         cx: self.cx,
1747                         local: self.var,
1748                         used: false,
1749                     };
1750                     walk_expr(&mut used_visitor, idx);
1751                     used_visitor.used
1752                 };
1753
1754                 if indexed_indirectly || index_used_directly {
1755                     if self.prefer_mutable {
1756                         self.indexed_mut.insert(seqvar.segments[0].ident.name);
1757                     }
1758                     let res = self.cx.tables.qpath_res(seqpath, seqexpr.hir_id);
1759                     match res {
1760                         Res::Local(hir_id) => {
1761                             let parent_id = self.cx.tcx.hir().get_parent_item(expr.hir_id);
1762                             let parent_def_id = self.cx.tcx.hir().local_def_id(parent_id);
1763                             let extent = self.cx.tcx.region_scope_tree(parent_def_id).var_scope(hir_id.local_id);
1764                             if indexed_indirectly {
1765                                 self.indexed_indirectly.insert(seqvar.segments[0].ident.name, Some(extent));
1766                             }
1767                             if index_used_directly {
1768                                 self.indexed_directly.insert(
1769                                     seqvar.segments[0].ident.name,
1770                                     (Some(extent), self.cx.tables.node_type(seqexpr.hir_id)),
1771                                 );
1772                             }
1773                             return false;  // no need to walk further *on the variable*
1774                         }
1775                         Res::Def(DefKind::Static, ..) | Res::Def(DefKind::Const, ..) => {
1776                             if indexed_indirectly {
1777                                 self.indexed_indirectly.insert(seqvar.segments[0].ident.name, None);
1778                             }
1779                             if index_used_directly {
1780                                 self.indexed_directly.insert(
1781                                     seqvar.segments[0].ident.name,
1782                                     (None, self.cx.tables.node_type(seqexpr.hir_id)),
1783                                 );
1784                             }
1785                             return false;  // no need to walk further *on the variable*
1786                         }
1787                         _ => (),
1788                     }
1789                 }
1790             }
1791         }
1792         true
1793     }
1794 }
1795
1796 impl<'a, 'tcx> Visitor<'tcx> for VarVisitor<'a, 'tcx> {
1797     fn visit_expr(&mut self, expr: &'tcx Expr) {
1798         if_chain! {
1799             // a range index op
1800             if let ExprKind::MethodCall(ref meth, _, ref args) = expr.node;
1801             if (meth.ident.name == sym!(index) && match_trait_method(self.cx, expr, &paths::INDEX))
1802                 || (meth.ident.name == sym!(index_mut) && match_trait_method(self.cx, expr, &paths::INDEX_MUT));
1803             if !self.check(&args[1], &args[0], expr);
1804             then { return }
1805         }
1806
1807         if_chain! {
1808             // an index op
1809             if let ExprKind::Index(ref seqexpr, ref idx) = expr.node;
1810             if !self.check(idx, seqexpr, expr);
1811             then { return }
1812         }
1813
1814         if_chain! {
1815             // directly using a variable
1816             if let ExprKind::Path(ref qpath) = expr.node;
1817             if let QPath::Resolved(None, ref path) = *qpath;
1818             if path.segments.len() == 1;
1819             then {
1820                 if let Res::Local(local_id) = self.cx.tables.qpath_res(qpath, expr.hir_id) {
1821                     if local_id == self.var {
1822                         self.nonindex = true;
1823                     } else {
1824                         // not the correct variable, but still a variable
1825                         self.referenced.insert(path.segments[0].ident.name);
1826                     }
1827                 }
1828             }
1829         }
1830
1831         let old = self.prefer_mutable;
1832         match expr.node {
1833             ExprKind::AssignOp(_, ref lhs, ref rhs) | ExprKind::Assign(ref lhs, ref rhs) => {
1834                 self.prefer_mutable = true;
1835                 self.visit_expr(lhs);
1836                 self.prefer_mutable = false;
1837                 self.visit_expr(rhs);
1838             },
1839             ExprKind::AddrOf(mutbl, ref expr) => {
1840                 if mutbl == MutMutable {
1841                     self.prefer_mutable = true;
1842                 }
1843                 self.visit_expr(expr);
1844             },
1845             ExprKind::Call(ref f, ref args) => {
1846                 self.visit_expr(f);
1847                 for expr in args {
1848                     let ty = self.cx.tables.expr_ty_adjusted(expr);
1849                     self.prefer_mutable = false;
1850                     if let ty::Ref(_, _, mutbl) = ty.sty {
1851                         if mutbl == MutMutable {
1852                             self.prefer_mutable = true;
1853                         }
1854                     }
1855                     self.visit_expr(expr);
1856                 }
1857             },
1858             ExprKind::MethodCall(_, _, ref args) => {
1859                 let def_id = self.cx.tables.type_dependent_def_id(expr.hir_id).unwrap();
1860                 for (ty, expr) in self.cx.tcx.fn_sig(def_id).inputs().skip_binder().iter().zip(args) {
1861                     self.prefer_mutable = false;
1862                     if let ty::Ref(_, _, mutbl) = ty.sty {
1863                         if mutbl == MutMutable {
1864                             self.prefer_mutable = true;
1865                         }
1866                     }
1867                     self.visit_expr(expr);
1868                 }
1869             },
1870             ExprKind::Closure(_, _, body_id, ..) => {
1871                 let body = self.cx.tcx.hir().body(body_id);
1872                 self.visit_expr(&body.value);
1873             },
1874             _ => walk_expr(self, expr),
1875         }
1876         self.prefer_mutable = old;
1877     }
1878     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1879         NestedVisitorMap::None
1880     }
1881 }
1882
1883 fn is_used_inside<'a, 'tcx>(cx: &'a LateContext<'a, 'tcx>, expr: &'tcx Expr, container: &'tcx Expr) -> bool {
1884     let def_id = match var_def_id(cx, expr) {
1885         Some(id) => id,
1886         None => return false,
1887     };
1888     if let Some(used_mutably) = mutated_variables(container, cx) {
1889         if used_mutably.contains(&def_id) {
1890             return true;
1891         }
1892     }
1893     false
1894 }
1895
1896 fn is_iterator_used_after_while_let<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, iter_expr: &'tcx Expr) -> bool {
1897     let def_id = match var_def_id(cx, iter_expr) {
1898         Some(id) => id,
1899         None => return false,
1900     };
1901     let mut visitor = VarUsedAfterLoopVisitor {
1902         cx,
1903         def_id,
1904         iter_expr_id: iter_expr.hir_id,
1905         past_while_let: false,
1906         var_used_after_while_let: false,
1907     };
1908     if let Some(enclosing_block) = get_enclosing_block(cx, def_id) {
1909         walk_block(&mut visitor, enclosing_block);
1910     }
1911     visitor.var_used_after_while_let
1912 }
1913
1914 struct VarUsedAfterLoopVisitor<'a, 'tcx> {
1915     cx: &'a LateContext<'a, 'tcx>,
1916     def_id: HirId,
1917     iter_expr_id: HirId,
1918     past_while_let: bool,
1919     var_used_after_while_let: bool,
1920 }
1921
1922 impl<'a, 'tcx> Visitor<'tcx> for VarUsedAfterLoopVisitor<'a, 'tcx> {
1923     fn visit_expr(&mut self, expr: &'tcx Expr) {
1924         if self.past_while_let {
1925             if Some(self.def_id) == var_def_id(self.cx, expr) {
1926                 self.var_used_after_while_let = true;
1927             }
1928         } else if self.iter_expr_id == expr.hir_id {
1929             self.past_while_let = true;
1930         }
1931         walk_expr(self, expr);
1932     }
1933     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1934         NestedVisitorMap::None
1935     }
1936 }
1937
1938 /// Returns `true` if the type of expr is one that provides `IntoIterator` impls
1939 /// for `&T` and `&mut T`, such as `Vec`.
1940 #[rustfmt::skip]
1941 fn is_ref_iterable_type(cx: &LateContext<'_, '_>, e: &Expr) -> bool {
1942     // no walk_ptrs_ty: calling iter() on a reference can make sense because it
1943     // will allow further borrows afterwards
1944     let ty = cx.tables.expr_ty(e);
1945     is_iterable_array(ty, cx) ||
1946     match_type(cx, ty, &paths::VEC) ||
1947     match_type(cx, ty, &paths::LINKED_LIST) ||
1948     match_type(cx, ty, &paths::HASHMAP) ||
1949     match_type(cx, ty, &paths::HASHSET) ||
1950     match_type(cx, ty, &paths::VEC_DEQUE) ||
1951     match_type(cx, ty, &paths::BINARY_HEAP) ||
1952     match_type(cx, ty, &paths::BTREEMAP) ||
1953     match_type(cx, ty, &paths::BTREESET)
1954 }
1955
1956 fn is_iterable_array<'tcx>(ty: Ty<'tcx>, cx: &LateContext<'_, 'tcx>) -> bool {
1957     // IntoIterator is currently only implemented for array sizes <= 32 in rustc
1958     match ty.sty {
1959         ty::Array(_, n) => (0..=32).contains(&n.eval_usize(cx.tcx, cx.param_env)),
1960         _ => false,
1961     }
1962 }
1963
1964 /// If a block begins with a statement (possibly a `let` binding) and has an
1965 /// expression, return it.
1966 fn extract_expr_from_first_stmt(block: &Block) -> Option<&Expr> {
1967     if block.stmts.is_empty() {
1968         return None;
1969     }
1970     if let StmtKind::Local(ref local) = block.stmts[0].node {
1971         if let Some(ref expr) = local.init {
1972             Some(expr)
1973         } else {
1974             None
1975         }
1976     } else {
1977         None
1978     }
1979 }
1980
1981 /// If a block begins with an expression (with or without semicolon), return it.
1982 fn extract_first_expr(block: &Block) -> Option<&Expr> {
1983     match block.expr {
1984         Some(ref expr) if block.stmts.is_empty() => Some(expr),
1985         None if !block.stmts.is_empty() => match block.stmts[0].node {
1986             StmtKind::Expr(ref expr) | StmtKind::Semi(ref expr) => Some(expr),
1987             StmtKind::Local(..) | StmtKind::Item(..) => None,
1988         },
1989         _ => None,
1990     }
1991 }
1992
1993 /// Returns `true` if expr contains a single break expr without destination label
1994 /// and
1995 /// passed expression. The expression may be within a block.
1996 fn is_simple_break_expr(expr: &Expr) -> bool {
1997     match expr.node {
1998         ExprKind::Break(dest, ref passed_expr) if dest.label.is_none() && passed_expr.is_none() => true,
1999         ExprKind::Block(ref b, _) => match extract_first_expr(b) {
2000             Some(subexpr) => is_simple_break_expr(subexpr),
2001             None => false,
2002         },
2003         _ => false,
2004     }
2005 }
2006
2007 // To trigger the EXPLICIT_COUNTER_LOOP lint, a variable must be
2008 // incremented exactly once in the loop body, and initialized to zero
2009 // at the start of the loop.
2010 #[derive(Debug, PartialEq)]
2011 enum VarState {
2012     Initial,  // Not examined yet
2013     IncrOnce, // Incremented exactly once, may be a loop counter
2014     Declared, // Declared but not (yet) initialized to zero
2015     Warn,
2016     DontWarn,
2017 }
2018
2019 /// Scan a for loop for variables that are incremented exactly once.
2020 struct IncrementVisitor<'a, 'tcx> {
2021     cx: &'a LateContext<'a, 'tcx>,      // context reference
2022     states: FxHashMap<HirId, VarState>, // incremented variables
2023     depth: u32,                         // depth of conditional expressions
2024     done: bool,
2025 }
2026
2027 impl<'a, 'tcx> Visitor<'tcx> for IncrementVisitor<'a, 'tcx> {
2028     fn visit_expr(&mut self, expr: &'tcx Expr) {
2029         if self.done {
2030             return;
2031         }
2032
2033         // If node is a variable
2034         if let Some(def_id) = var_def_id(self.cx, expr) {
2035             if let Some(parent) = get_parent_expr(self.cx, expr) {
2036                 let state = self.states.entry(def_id).or_insert(VarState::Initial);
2037
2038                 match parent.node {
2039                     ExprKind::AssignOp(op, ref lhs, ref rhs) => {
2040                         if lhs.hir_id == expr.hir_id {
2041                             if op.node == BinOpKind::Add && is_integer_literal(rhs, 1) {
2042                                 *state = match *state {
2043                                     VarState::Initial if self.depth == 0 => VarState::IncrOnce,
2044                                     _ => VarState::DontWarn,
2045                                 };
2046                             } else {
2047                                 // Assigned some other value
2048                                 *state = VarState::DontWarn;
2049                             }
2050                         }
2051                     },
2052                     ExprKind::Assign(ref lhs, _) if lhs.hir_id == expr.hir_id => *state = VarState::DontWarn,
2053                     ExprKind::AddrOf(mutability, _) if mutability == MutMutable => *state = VarState::DontWarn,
2054                     _ => (),
2055                 }
2056             }
2057         } else if is_loop(expr) || is_conditional(expr) {
2058             self.depth += 1;
2059             walk_expr(self, expr);
2060             self.depth -= 1;
2061             return;
2062         } else if let ExprKind::Continue(_) = expr.node {
2063             self.done = true;
2064             return;
2065         }
2066         walk_expr(self, expr);
2067     }
2068     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
2069         NestedVisitorMap::None
2070     }
2071 }
2072
2073 /// Checks whether a variable is initialized to zero at the start of a loop.
2074 struct InitializeVisitor<'a, 'tcx> {
2075     cx: &'a LateContext<'a, 'tcx>, // context reference
2076     end_expr: &'tcx Expr,          // the for loop. Stop scanning here.
2077     var_id: HirId,
2078     state: VarState,
2079     name: Option<Name>,
2080     depth: u32, // depth of conditional expressions
2081     past_loop: bool,
2082 }
2083
2084 impl<'a, 'tcx> Visitor<'tcx> for InitializeVisitor<'a, 'tcx> {
2085     fn visit_stmt(&mut self, stmt: &'tcx Stmt) {
2086         // Look for declarations of the variable
2087         if let StmtKind::Local(ref local) = stmt.node {
2088             if local.pat.hir_id == self.var_id {
2089                 if let PatKind::Binding(.., ident, _) = local.pat.node {
2090                     self.name = Some(ident.name);
2091
2092                     self.state = if let Some(ref init) = local.init {
2093                         if is_integer_literal(init, 0) {
2094                             VarState::Warn
2095                         } else {
2096                             VarState::Declared
2097                         }
2098                     } else {
2099                         VarState::Declared
2100                     }
2101                 }
2102             }
2103         }
2104         walk_stmt(self, stmt);
2105     }
2106
2107     fn visit_expr(&mut self, expr: &'tcx Expr) {
2108         if self.state == VarState::DontWarn {
2109             return;
2110         }
2111         if SpanlessEq::new(self.cx).eq_expr(&expr, self.end_expr) {
2112             self.past_loop = true;
2113             return;
2114         }
2115         // No need to visit expressions before the variable is
2116         // declared
2117         if self.state == VarState::IncrOnce {
2118             return;
2119         }
2120
2121         // If node is the desired variable, see how it's used
2122         if var_def_id(self.cx, expr) == Some(self.var_id) {
2123             if let Some(parent) = get_parent_expr(self.cx, expr) {
2124                 match parent.node {
2125                     ExprKind::AssignOp(_, ref lhs, _) if lhs.hir_id == expr.hir_id => {
2126                         self.state = VarState::DontWarn;
2127                     },
2128                     ExprKind::Assign(ref lhs, ref rhs) if lhs.hir_id == expr.hir_id => {
2129                         self.state = if is_integer_literal(rhs, 0) && self.depth == 0 {
2130                             VarState::Warn
2131                         } else {
2132                             VarState::DontWarn
2133                         }
2134                     },
2135                     ExprKind::AddrOf(mutability, _) if mutability == MutMutable => self.state = VarState::DontWarn,
2136                     _ => (),
2137                 }
2138             }
2139
2140             if self.past_loop {
2141                 self.state = VarState::DontWarn;
2142                 return;
2143             }
2144         } else if !self.past_loop && is_loop(expr) {
2145             self.state = VarState::DontWarn;
2146             return;
2147         } else if is_conditional(expr) {
2148             self.depth += 1;
2149             walk_expr(self, expr);
2150             self.depth -= 1;
2151             return;
2152         }
2153         walk_expr(self, expr);
2154     }
2155     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
2156         NestedVisitorMap::None
2157     }
2158 }
2159
2160 fn var_def_id(cx: &LateContext<'_, '_>, expr: &Expr) -> Option<HirId> {
2161     if let ExprKind::Path(ref qpath) = expr.node {
2162         let path_res = cx.tables.qpath_res(qpath, expr.hir_id);
2163         if let Res::Local(node_id) = path_res {
2164             return Some(node_id);
2165         }
2166     }
2167     None
2168 }
2169
2170 fn is_loop(expr: &Expr) -> bool {
2171     match expr.node {
2172         ExprKind::Loop(..) => true,
2173         _ => false,
2174     }
2175 }
2176
2177 fn is_conditional(expr: &Expr) -> bool {
2178     match expr.node {
2179         ExprKind::Match(..) => true,
2180         _ => false,
2181     }
2182 }
2183
2184 fn is_nested(cx: &LateContext<'_, '_>, match_expr: &Expr, iter_expr: &Expr) -> bool {
2185     if_chain! {
2186         if let Some(loop_block) = get_enclosing_block(cx, match_expr.hir_id);
2187         let parent_node = cx.tcx.hir().get_parent_node(loop_block.hir_id);
2188         if let Some(Node::Expr(loop_expr)) = cx.tcx.hir().find(parent_node);
2189         then {
2190             return is_loop_nested(cx, loop_expr, iter_expr)
2191         }
2192     }
2193     false
2194 }
2195
2196 fn is_loop_nested(cx: &LateContext<'_, '_>, loop_expr: &Expr, iter_expr: &Expr) -> bool {
2197     let mut id = loop_expr.hir_id;
2198     let iter_name = if let Some(name) = path_name(iter_expr) {
2199         name
2200     } else {
2201         return true;
2202     };
2203     loop {
2204         let parent = cx.tcx.hir().get_parent_node(id);
2205         if parent == id {
2206             return false;
2207         }
2208         match cx.tcx.hir().find(parent) {
2209             Some(Node::Expr(expr)) => {
2210                 if let ExprKind::Loop(..) = expr.node {
2211                     return true;
2212                 };
2213             },
2214             Some(Node::Block(block)) => {
2215                 let mut block_visitor = LoopNestVisitor {
2216                     hir_id: id,
2217                     iterator: iter_name,
2218                     nesting: Unknown,
2219                 };
2220                 walk_block(&mut block_visitor, block);
2221                 if block_visitor.nesting == RuledOut {
2222                     return false;
2223                 }
2224             },
2225             Some(Node::Stmt(_)) => (),
2226             _ => {
2227                 return false;
2228             },
2229         }
2230         id = parent;
2231     }
2232 }
2233
2234 #[derive(PartialEq, Eq)]
2235 enum Nesting {
2236     Unknown,     // no nesting detected yet
2237     RuledOut,    // the iterator is initialized or assigned within scope
2238     LookFurther, // no nesting detected, no further walk required
2239 }
2240
2241 use self::Nesting::{LookFurther, RuledOut, Unknown};
2242
2243 struct LoopNestVisitor {
2244     hir_id: HirId,
2245     iterator: Name,
2246     nesting: Nesting,
2247 }
2248
2249 impl<'tcx> Visitor<'tcx> for LoopNestVisitor {
2250     fn visit_stmt(&mut self, stmt: &'tcx Stmt) {
2251         if stmt.hir_id == self.hir_id {
2252             self.nesting = LookFurther;
2253         } else if self.nesting == Unknown {
2254             walk_stmt(self, stmt);
2255         }
2256     }
2257
2258     fn visit_expr(&mut self, expr: &'tcx Expr) {
2259         if self.nesting != Unknown {
2260             return;
2261         }
2262         if expr.hir_id == self.hir_id {
2263             self.nesting = LookFurther;
2264             return;
2265         }
2266         match expr.node {
2267             ExprKind::Assign(ref path, _) | ExprKind::AssignOp(_, ref path, _) => {
2268                 if match_var(path, self.iterator) {
2269                     self.nesting = RuledOut;
2270                 }
2271             },
2272             _ => walk_expr(self, expr),
2273         }
2274     }
2275
2276     fn visit_pat(&mut self, pat: &'tcx Pat) {
2277         if self.nesting != Unknown {
2278             return;
2279         }
2280         if let PatKind::Binding(.., span_name, _) = pat.node {
2281             if self.iterator == span_name.name {
2282                 self.nesting = RuledOut;
2283                 return;
2284             }
2285         }
2286         walk_pat(self, pat)
2287     }
2288
2289     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
2290         NestedVisitorMap::None
2291     }
2292 }
2293
2294 fn path_name(e: &Expr) -> Option<Name> {
2295     if let ExprKind::Path(QPath::Resolved(_, ref path)) = e.node {
2296         let segments = &path.segments;
2297         if segments.len() == 1 {
2298             return Some(segments[0].ident.name);
2299         }
2300     };
2301     None
2302 }
2303
2304 fn check_infinite_loop<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, cond: &'tcx Expr, expr: &'tcx Expr) {
2305     if constant(cx, cx.tables, cond).is_some() {
2306         // A pure constant condition (e.g., `while false`) is not linted.
2307         return;
2308     }
2309
2310     let mut var_visitor = VarCollectorVisitor {
2311         cx,
2312         ids: FxHashSet::default(),
2313         def_ids: FxHashMap::default(),
2314         skip: false,
2315     };
2316     var_visitor.visit_expr(cond);
2317     if var_visitor.skip {
2318         return;
2319     }
2320     let used_in_condition = &var_visitor.ids;
2321     let no_cond_variable_mutated = if let Some(used_mutably) = mutated_variables(expr, cx) {
2322         used_in_condition.is_disjoint(&used_mutably)
2323     } else {
2324         return;
2325     };
2326     let mutable_static_in_cond = var_visitor.def_ids.iter().any(|(_, v)| *v);
2327     if no_cond_variable_mutated && !mutable_static_in_cond {
2328         span_lint(
2329             cx,
2330             WHILE_IMMUTABLE_CONDITION,
2331             cond.span,
2332             "Variable in the condition are not mutated in the loop body. \
2333              This either leads to an infinite or to a never running loop.",
2334         );
2335     }
2336 }
2337
2338 /// Collects the set of variables in an expression
2339 /// Stops analysis if a function call is found
2340 /// Note: In some cases such as `self`, there are no mutable annotation,
2341 /// All variables definition IDs are collected
2342 struct VarCollectorVisitor<'a, 'tcx> {
2343     cx: &'a LateContext<'a, 'tcx>,
2344     ids: FxHashSet<HirId>,
2345     def_ids: FxHashMap<def_id::DefId, bool>,
2346     skip: bool,
2347 }
2348
2349 impl<'a, 'tcx> VarCollectorVisitor<'a, 'tcx> {
2350     fn insert_def_id(&mut self, ex: &'tcx Expr) {
2351         if_chain! {
2352             if let ExprKind::Path(ref qpath) = ex.node;
2353             if let QPath::Resolved(None, _) = *qpath;
2354             let res = self.cx.tables.qpath_res(qpath, ex.hir_id);
2355             then {
2356                 match res {
2357                     Res::Local(node_id) => {
2358                         self.ids.insert(node_id);
2359                     },
2360                     Res::Def(DefKind::Static, def_id) => {
2361                         let mutable = self.cx.tcx.is_mutable_static(def_id);
2362                         self.def_ids.insert(def_id, mutable);
2363                     },
2364                     _ => {},
2365                 }
2366             }
2367         }
2368     }
2369 }
2370
2371 impl<'a, 'tcx> Visitor<'tcx> for VarCollectorVisitor<'a, 'tcx> {
2372     fn visit_expr(&mut self, ex: &'tcx Expr) {
2373         match ex.node {
2374             ExprKind::Path(_) => self.insert_def_id(ex),
2375             // If there is any function/method call… we just stop analysis
2376             ExprKind::Call(..) | ExprKind::MethodCall(..) => self.skip = true,
2377
2378             _ => walk_expr(self, ex),
2379         }
2380     }
2381
2382     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
2383         NestedVisitorMap::None
2384     }
2385 }
2386
2387 const NEEDLESS_COLLECT_MSG: &str = "avoid using `collect()` when not needed";
2388
2389 fn check_needless_collect<'a, 'tcx>(expr: &'tcx Expr, cx: &LateContext<'a, 'tcx>) {
2390     if_chain! {
2391         if let ExprKind::MethodCall(ref method, _, ref args) = expr.node;
2392         if let ExprKind::MethodCall(ref chain_method, _, _) = args[0].node;
2393         if chain_method.ident.name == sym!(collect) && match_trait_method(cx, &args[0], &paths::ITERATOR);
2394         if let Some(ref generic_args) = chain_method.args;
2395         if let Some(GenericArg::Type(ref ty)) = generic_args.args.get(0);
2396         then {
2397             let ty = cx.tables.node_type(ty.hir_id);
2398             if match_type(cx, ty, &paths::VEC) ||
2399                 match_type(cx, ty, &paths::VEC_DEQUE) ||
2400                 match_type(cx, ty, &paths::BTREEMAP) ||
2401                 match_type(cx, ty, &paths::HASHMAP) {
2402                 if method.ident.name == sym!(len) {
2403                     let span = shorten_needless_collect_span(expr);
2404                     span_lint_and_then(cx, NEEDLESS_COLLECT, span, NEEDLESS_COLLECT_MSG, |db| {
2405                         db.span_suggestion(
2406                             span,
2407                             "replace with",
2408                             ".count()".to_string(),
2409                             Applicability::MachineApplicable,
2410                         );
2411                     });
2412                 }
2413                 if method.ident.name == sym!(is_empty) {
2414                     let span = shorten_needless_collect_span(expr);
2415                     span_lint_and_then(cx, NEEDLESS_COLLECT, span, NEEDLESS_COLLECT_MSG, |db| {
2416                         db.span_suggestion(
2417                             span,
2418                             "replace with",
2419                             ".next().is_none()".to_string(),
2420                             Applicability::MachineApplicable,
2421                         );
2422                     });
2423                 }
2424                 if method.ident.name == sym!(contains) {
2425                     let contains_arg = snippet(cx, args[1].span, "??");
2426                     let span = shorten_needless_collect_span(expr);
2427                     span_lint_and_then(cx, NEEDLESS_COLLECT, span, NEEDLESS_COLLECT_MSG, |db| {
2428                         db.span_suggestion(
2429                             span,
2430                             "replace with",
2431                             format!(
2432                                 ".any(|&x| x == {})",
2433                                 if contains_arg.starts_with('&') { &contains_arg[1..] } else { &contains_arg }
2434                             ),
2435                             Applicability::MachineApplicable,
2436                         );
2437                     });
2438                 }
2439             }
2440         }
2441     }
2442 }
2443
2444 fn shorten_needless_collect_span(expr: &Expr) -> Span {
2445     if_chain! {
2446         if let ExprKind::MethodCall(_, _, ref args) = expr.node;
2447         if let ExprKind::MethodCall(_, ref span, _) = args[0].node;
2448         then {
2449             return expr.span.with_lo(span.lo() - BytePos(1));
2450         }
2451     }
2452     unreachable!()
2453 }