clippy_lints/src/loops.rs

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