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