clippy_lints/src/loops.rs

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