clippy_lints/src/loops.rs

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