clippy_lints/src/loops.rs

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