clippy_lints/src/loops.rs

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