clippy_lints/src/loops.rs

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