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