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