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