clippy_lints/src/loops.rs

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