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
 570                 // Don't lint when the iterator is recreated on every iteration
 571                 if_chain! {
 572                     if let ExprKind::MethodCall(..) | ExprKind::Call(..) = iter_expr.kind;
 573                     if let Some(iter_def_id) = get_trait_def_id(cx, &paths::ITERATOR);
 574                     if implements_trait(cx, cx.tables.expr_ty(iter_expr), iter_def_id, &[]);
 575                     then {
 576                         return;
 577                     }
 578                 }
 579
 580                 let lhs_constructor = last_path_segment(qpath);
 581                 if method_path.ident.name == sym!(next)
 582                     && match_trait_method(cx, match_expr, &paths::ITERATOR)
 583                     && lhs_constructor.ident.name == sym!(Some)
 584                     && (pat_args.is_empty()
 585                         || !is_refutable(cx, &pat_args[0])
 586                             && !is_used_inside(cx, iter_expr, &arms[0].body)
 587                             && !is_iterator_used_after_while_let(cx, iter_expr)
 588                             && !is_nested(cx, expr, &method_args[0]))
 589                 {
 590                     let mut applicability = Applicability::MachineApplicable;
 591                     let iterator = snippet_with_applicability(cx, method_args[0].span, "_", &mut applicability);
 592                     let loop_var = if pat_args.is_empty() {
 593                         "_".to_string()
 594                     } else {
 595                         snippet_with_applicability(cx, pat_args[0].span, "_", &mut applicability).into_owned()
 596                     };
 597                     span_lint_and_sugg(
 598                         cx,
 599                         WHILE_LET_ON_ITERATOR,
 600                         expr.span.with_hi(match_expr.span.hi()),
 601                         "this loop could be written as a `for` loop",
 602                         "try",
 603                         format!("for {} in {}", loop_var, iterator),
 604                         applicability,
 605                     );
 606                 }
 607             }
 608         }
 609
 610         if let Some((cond, body)) = higher::while_loop(&expr) {
 611             check_infinite_loop(cx, cond, body);
 612         }
 613
 614         check_needless_collect(expr, cx);
 615     }
 616 }
 617
 618 enum NeverLoopResult {
 619     // A break/return always get triggered but not necessarily for the main loop.
 620     AlwaysBreak,
 621     // A continue may occur for the main loop.
 622     MayContinueMainLoop,
 623     Otherwise,
 624 }
 625
 626 #[must_use]
 627 fn absorb_break(arg: &NeverLoopResult) -> NeverLoopResult {
 628     match *arg {
 629         NeverLoopResult::AlwaysBreak | NeverLoopResult::Otherwise => NeverLoopResult::Otherwise,
 630         NeverLoopResult::MayContinueMainLoop => NeverLoopResult::MayContinueMainLoop,
 631     }
 632 }
 633
 634 // Combine two results for parts that are called in order.
 635 #[must_use]
 636 fn combine_seq(first: NeverLoopResult, second: NeverLoopResult) -> NeverLoopResult {
 637     match first {
 638         NeverLoopResult::AlwaysBreak | NeverLoopResult::MayContinueMainLoop => first,
 639         NeverLoopResult::Otherwise => second,
 640     }
 641 }
 642
 643 // Combine two results where both parts are called but not necessarily in order.
 644 #[must_use]
 645 fn combine_both(left: NeverLoopResult, right: NeverLoopResult) -> NeverLoopResult {
 646     match (left, right) {
 647         (NeverLoopResult::MayContinueMainLoop, _) | (_, NeverLoopResult::MayContinueMainLoop) => {
 648             NeverLoopResult::MayContinueMainLoop
 649         },
 650         (NeverLoopResult::AlwaysBreak, _) | (_, NeverLoopResult::AlwaysBreak) => NeverLoopResult::AlwaysBreak,
 651         (NeverLoopResult::Otherwise, NeverLoopResult::Otherwise) => NeverLoopResult::Otherwise,
 652     }
 653 }
 654
 655 // Combine two results where only one of the part may have been executed.
 656 #[must_use]
 657 fn combine_branches(b1: NeverLoopResult, b2: NeverLoopResult) -> NeverLoopResult {
 658     match (b1, b2) {
 659         (NeverLoopResult::AlwaysBreak, NeverLoopResult::AlwaysBreak) => NeverLoopResult::AlwaysBreak,
 660         (NeverLoopResult::MayContinueMainLoop, _) | (_, NeverLoopResult::MayContinueMainLoop) => {
 661             NeverLoopResult::MayContinueMainLoop
 662         },
 663         (NeverLoopResult::Otherwise, _) | (_, NeverLoopResult::Otherwise) => NeverLoopResult::Otherwise,
 664     }
 665 }
 666
 667 fn never_loop_block(block: &Block<'_>, main_loop_id: HirId) -> NeverLoopResult {
 668     let stmts = block.stmts.iter().map(stmt_to_expr);
 669     let expr = once(block.expr.as_deref());
 670     let mut iter = stmts.chain(expr).filter_map(|e| e);
 671     never_loop_expr_seq(&mut iter, main_loop_id)
 672 }
 673
 674 fn stmt_to_expr<'tcx>(stmt: &Stmt<'tcx>) -> Option<&'tcx Expr<'tcx>> {
 675     match stmt.kind {
 676         StmtKind::Semi(ref e, ..) | StmtKind::Expr(ref e, ..) => Some(e),
 677         StmtKind::Local(ref local) => local.init.as_deref(),
 678         _ => None,
 679     }
 680 }
 681
 682 fn never_loop_expr(expr: &Expr<'_>, main_loop_id: HirId) -> NeverLoopResult {
 683     match expr.kind {
 684         ExprKind::Box(ref e)
 685         | ExprKind::Unary(_, ref e)
 686         | ExprKind::Cast(ref e, _)
 687         | ExprKind::Type(ref e, _)
 688         | ExprKind::Field(ref e, _)
 689         | ExprKind::AddrOf(_, _, ref e)
 690         | ExprKind::Struct(_, _, Some(ref e))
 691         | ExprKind::Repeat(ref e, _)
 692         | ExprKind::DropTemps(ref e) => never_loop_expr(e, main_loop_id),
 693         ExprKind::Array(ref es) | ExprKind::MethodCall(_, _, ref es) | ExprKind::Tup(ref es) => {
 694             never_loop_expr_all(&mut es.iter(), main_loop_id)
 695         },
 696         ExprKind::Call(ref e, ref es) => never_loop_expr_all(&mut once(&**e).chain(es.iter()), main_loop_id),
 697         ExprKind::Binary(_, ref e1, ref e2)
 698         | ExprKind::Assign(ref e1, ref e2, _)
 699         | ExprKind::AssignOp(_, ref e1, ref e2)
 700         | ExprKind::Index(ref e1, ref e2) => never_loop_expr_all(&mut [&**e1, &**e2].iter().cloned(), main_loop_id),
 701         ExprKind::Loop(ref b, _, _) => {
 702             // Break can come from the inner loop so remove them.
 703             absorb_break(&never_loop_block(b, main_loop_id))
 704         },
 705         ExprKind::Match(ref e, ref arms, _) => {
 706             let e = never_loop_expr(e, main_loop_id);
 707             if arms.is_empty() {
 708                 e
 709             } else {
 710                 let arms = never_loop_expr_branch(&mut arms.iter().map(|a| &*a.body), main_loop_id);
 711                 combine_seq(e, arms)
 712             }
 713         },
 714         ExprKind::Block(ref b, _) => never_loop_block(b, main_loop_id),
 715         ExprKind::Continue(d) => {
 716             let id = d
 717                 .target_id
 718                 .expect("target ID can only be missing in the presence of compilation errors");
 719             if id == main_loop_id {
 720                 NeverLoopResult::MayContinueMainLoop
 721             } else {
 722                 NeverLoopResult::AlwaysBreak
 723             }
 724         },
 725         ExprKind::Break(_, ref e) | ExprKind::Ret(ref e) => {
 726             if let Some(ref e) = *e {
 727                 combine_seq(never_loop_expr(e, main_loop_id), NeverLoopResult::AlwaysBreak)
 728             } else {
 729                 NeverLoopResult::AlwaysBreak
 730             }
 731         },
 732         ExprKind::Struct(_, _, None)
 733         | ExprKind::Yield(_, _)
 734         | ExprKind::Closure(_, _, _, _, _)
 735         | ExprKind::LlvmInlineAsm(_)
 736         | ExprKind::Path(_)
 737         | ExprKind::Lit(_)
 738         | ExprKind::Err => NeverLoopResult::Otherwise,
 739     }
 740 }
 741
 742 fn never_loop_expr_seq<'a, T: Iterator<Item = &'a Expr<'a>>>(es: &mut T, main_loop_id: HirId) -> NeverLoopResult {
 743     es.map(|e| never_loop_expr(e, main_loop_id))
 744         .fold(NeverLoopResult::Otherwise, combine_seq)
 745 }
 746
 747 fn never_loop_expr_all<'a, T: Iterator<Item = &'a Expr<'a>>>(es: &mut T, main_loop_id: HirId) -> NeverLoopResult {
 748     es.map(|e| never_loop_expr(e, main_loop_id))
 749         .fold(NeverLoopResult::Otherwise, combine_both)
 750 }
 751
 752 fn never_loop_expr_branch<'a, T: Iterator<Item = &'a Expr<'a>>>(e: &mut T, main_loop_id: HirId) -> NeverLoopResult {
 753     e.map(|e| never_loop_expr(e, main_loop_id))
 754         .fold(NeverLoopResult::AlwaysBreak, combine_branches)
 755 }
 756
 757 fn check_for_loop<'a, 'tcx>(
 758     cx: &LateContext<'a, 'tcx>,
 759     pat: &'tcx Pat<'_>,
 760     arg: &'tcx Expr<'_>,
 761     body: &'tcx Expr<'_>,
 762     expr: &'tcx Expr<'_>,
 763 ) {
 764     check_for_loop_range(cx, pat, arg, body, expr);
 765     check_for_loop_reverse_range(cx, arg, expr);
 766     check_for_loop_arg(cx, pat, arg, expr);
 767     check_for_loop_explicit_counter(cx, pat, arg, body, expr);
 768     check_for_loop_over_map_kv(cx, pat, arg, body, expr);
 769     check_for_mut_range_bound(cx, arg, body);
 770     detect_manual_memcpy(cx, pat, arg, body, expr);
 771 }
 772
 773 fn same_var<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &Expr<'_>, var: HirId) -> bool {
 774     if_chain! {
 775         if let ExprKind::Path(qpath) = &expr.kind;
 776         if let QPath::Resolved(None, path) = qpath;
 777         if path.segments.len() == 1;
 778         if let Res::Local(local_id) = qpath_res(cx, qpath, expr.hir_id);
 779         // our variable!
 780         if local_id == var;
 781         then {
 782             true
 783         } else {
 784             false
 785         }
 786     }
 787 }
 788
 789 struct Offset {
 790     value: String,
 791     negate: bool,
 792 }
 793
 794 impl Offset {
 795     fn negative(s: String) -> Self {
 796         Self { value: s, negate: true }
 797     }
 798
 799     fn positive(s: String) -> Self {
 800         Self {
 801             value: s,
 802             negate: false,
 803         }
 804     }
 805 }
 806
 807 struct FixedOffsetVar {
 808     var_name: String,
 809     offset: Offset,
 810 }
 811
 812 fn is_slice_like<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'_>) -> bool {
 813     let is_slice = match ty.kind {
 814         ty::Ref(_, subty, _) => is_slice_like(cx, subty),
 815         ty::Slice(..) | ty::Array(..) => true,
 816         _ => false,
 817     };
 818
 819     is_slice || is_type_diagnostic_item(cx, ty, sym!(vec_type)) || is_type_diagnostic_item(cx, ty, sym!(vecdeque_type))
 820 }
 821
 822 fn get_fixed_offset_var<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &Expr<'_>, var: HirId) -> Option<FixedOffsetVar> {
 823     fn extract_offset<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, e: &Expr<'_>, var: HirId) -> Option<String> {
 824         match &e.kind {
 825             ExprKind::Lit(l) => match l.node {
 826                 ast::LitKind::Int(x, _ty) => Some(x.to_string()),
 827                 _ => None,
 828             },
 829             ExprKind::Path(..) if !same_var(cx, e, var) => Some(snippet_opt(cx, e.span).unwrap_or_else(|| "??".into())),
 830             _ => None,
 831         }
 832     }
 833
 834     if let ExprKind::Index(seqexpr, idx) = expr.kind {
 835         let ty = cx.tables.expr_ty(seqexpr);
 836         if !is_slice_like(cx, ty) {
 837             return None;
 838         }
 839
 840         let offset = match idx.kind {
 841             ExprKind::Binary(op, lhs, rhs) => match op.node {
 842                 BinOpKind::Add => {
 843                     let offset_opt = if same_var(cx, lhs, var) {
 844                         extract_offset(cx, rhs, var)
 845                     } else if same_var(cx, rhs, var) {
 846                         extract_offset(cx, lhs, var)
 847                     } else {
 848                         None
 849                     };
 850
 851                     offset_opt.map(Offset::positive)
 852                 },
 853                 BinOpKind::Sub if same_var(cx, lhs, var) => extract_offset(cx, rhs, var).map(Offset::negative),
 854                 _ => None,
 855             },
 856             ExprKind::Path(..) if same_var(cx, idx, var) => Some(Offset::positive("0".into())),
 857             _ => None,
 858         };
 859
 860         offset.map(|o| FixedOffsetVar {
 861             var_name: snippet_opt(cx, seqexpr.span).unwrap_or_else(|| "???".into()),
 862             offset: o,
 863         })
 864     } else {
 865         None
 866     }
 867 }
 868
 869 fn fetch_cloned_fixed_offset_var<'a, 'tcx>(
 870     cx: &LateContext<'a, 'tcx>,
 871     expr: &Expr<'_>,
 872     var: HirId,
 873 ) -> Option<FixedOffsetVar> {
 874     if_chain! {
 875         if let ExprKind::MethodCall(method, _, args) = expr.kind;
 876         if method.ident.name == sym!(clone);
 877         if args.len() == 1;
 878         if let Some(arg) = args.get(0);
 879         then {
 880             get_fixed_offset_var(cx, arg, var)
 881         } else {
 882             get_fixed_offset_var(cx, expr, var)
 883         }
 884     }
 885 }
 886
 887 fn get_indexed_assignments<'a, 'tcx>(
 888     cx: &LateContext<'a, 'tcx>,
 889     body: &Expr<'_>,
 890     var: HirId,
 891 ) -> Vec<(FixedOffsetVar, FixedOffsetVar)> {
 892     fn get_assignment<'a, 'tcx>(
 893         cx: &LateContext<'a, 'tcx>,
 894         e: &Expr<'_>,
 895         var: HirId,
 896     ) -> Option<(FixedOffsetVar, FixedOffsetVar)> {
 897         if let ExprKind::Assign(lhs, rhs, _) = e.kind {
 898             match (
 899                 get_fixed_offset_var(cx, lhs, var),
 900                 fetch_cloned_fixed_offset_var(cx, rhs, var),
 901             ) {
 902                 (Some(offset_left), Some(offset_right)) => {
 903                     // Source and destination must be different
 904                     if offset_left.var_name == offset_right.var_name {
 905                         None
 906                     } else {
 907                         Some((offset_left, offset_right))
 908                     }
 909                 },
 910                 _ => None,
 911             }
 912         } else {
 913             None
 914         }
 915     }
 916
 917     if let ExprKind::Block(b, _) = body.kind {
 918         let Block { stmts, expr, .. } = *b;
 919
 920         stmts
 921             .iter()
 922             .filter_map(|stmt| match stmt.kind {
 923                 StmtKind::Local(..) | StmtKind::Item(..) => None,
 924                 StmtKind::Expr(e) | StmtKind::Semi(e) => Some(e),
 925             })
 926             .chain(expr.into_iter())
 927             .map(|op| get_assignment(cx, op, var))
 928             .collect::<Option<Vec<_>>>()
 929             .unwrap_or_default()
 930     } else {
 931         get_assignment(cx, body, var).into_iter().collect()
 932     }
 933 }
 934
 935 /// Checks for for loops that sequentially copy items from one slice-like
 936 /// object to another.
 937 fn detect_manual_memcpy<'a, 'tcx>(
 938     cx: &LateContext<'a, 'tcx>,
 939     pat: &'tcx Pat<'_>,
 940     arg: &'tcx Expr<'_>,
 941     body: &'tcx Expr<'_>,
 942     expr: &'tcx Expr<'_>,
 943 ) {
 944     if let Some(higher::Range {
 945         start: Some(start),
 946         end: Some(end),
 947         limits,
 948     }) = higher::range(cx, arg)
 949     {
 950         // the var must be a single name
 951         if let PatKind::Binding(_, canonical_id, _, _) = pat.kind {
 952             let print_sum = |arg1: &Offset, arg2: &Offset| -> String {
 953                 match (&arg1.value[..], arg1.negate, &arg2.value[..], arg2.negate) {
 954                     ("0", _, "0", _) => "0".into(),
 955                     ("0", _, x, false) | (x, false, "0", _) => x.into(),
 956                     ("0", _, x, true) => format!("-{}", x),
 957                     (x, false, y, false) => format!("({} + {})", x, y),
 958                     (x, false, y, true) => {
 959                         if x == y {
 960                             "0".into()
 961                         } else {
 962                             format!("({} - {})", x, y)
 963                         }
 964                     },
 965                     (x, true, y, false) => {
 966                         if x == y {
 967                             "0".into()
 968                         } else {
 969                             format!("({} - {})", y, x)
 970                         }
 971                     },
 972                     (x, true, y, true) => format!("-({} + {})", x, y),
 973                 }
 974             };
 975
 976             let print_offset = |start_str: &Offset, inline_offset: &Offset| -> String {
 977                 let offset = print_sum(start_str, inline_offset);
 978                 if offset.as_str() == "0" {
 979                     "".into()
 980                 } else {
 981                     offset
 982                 }
 983             };
 984
 985             let print_limit = |end: &Expr<'_>, offset: Offset, var_name: &str| {
 986                 if_chain! {
 987                     if let ExprKind::MethodCall(method, _, len_args) = end.kind;
 988                     if method.ident.name == sym!(len);
 989                     if len_args.len() == 1;
 990                     if let Some(arg) = len_args.get(0);
 991                     if snippet(cx, arg.span, "??") == var_name;
 992                     then {
 993                         if offset.negate {
 994                             format!("({} - {})", snippet(cx, end.span, "<src>.len()"), offset.value)
 995                         } else {
 996                             String::new()
 997                         }
 998                     } else {
 999                         let end_str = match limits {
1000                             ast::RangeLimits::Closed => {
1001                                 let end = sugg::Sugg::hir(cx, end, "<count>");
1002                                 format!("{}", end + sugg::ONE)
1003                             },
1004                             ast::RangeLimits::HalfOpen => format!("{}", snippet(cx, end.span, "..")),
1005                         };
1006
1007                         print_sum(&Offset::positive(end_str), &offset)
1008                     }
1009                 }
1010             };
1011
1012             // The only statements in the for loops can be indexed assignments from
1013             // indexed retrievals.
1014             let manual_copies = get_indexed_assignments(cx, body, canonical_id);
1015
1016             let big_sugg = manual_copies
1017                 .into_iter()
1018                 .map(|(dst_var, src_var)| {
1019                     let start_str = Offset::positive(snippet(cx, start.span, "").to_string());
1020                     let dst_offset = print_offset(&start_str, &dst_var.offset);
1021                     let dst_limit = print_limit(end, dst_var.offset, &dst_var.var_name);
1022                     let src_offset = print_offset(&start_str, &src_var.offset);
1023                     let src_limit = print_limit(end, src_var.offset, &src_var.var_name);
1024                     let dst = if dst_offset == "" && dst_limit == "" {
1025                         dst_var.var_name
1026                     } else {
1027                         format!("{}[{}..{}]", dst_var.var_name, dst_offset, dst_limit)
1028                     };
1029
1030                     format!(
1031                         "{}.clone_from_slice(&{}[{}..{}])",
1032                         dst, src_var.var_name, src_offset, src_limit
1033                     )
1034                 })
1035                 .join("\n    ");
1036
1037             if !big_sugg.is_empty() {
1038                 span_lint_and_sugg(
1039                     cx,
1040                     MANUAL_MEMCPY,
1041                     expr.span,
1042                     "it looks like you're manually copying between slices",
1043                     "try replacing the loop by",
1044                     big_sugg,
1045                     Applicability::Unspecified,
1046                 );
1047             }
1048         }
1049     }
1050 }
1051
1052 /// Checks for looping over a range and then indexing a sequence with it.
1053 /// The iteratee must be a range literal.
1054 #[allow(clippy::too_many_lines)]
1055 fn check_for_loop_range<'a, 'tcx>(
1056     cx: &LateContext<'a, 'tcx>,
1057     pat: &'tcx Pat<'_>,
1058     arg: &'tcx Expr<'_>,
1059     body: &'tcx Expr<'_>,
1060     expr: &'tcx Expr<'_>,
1061 ) {
1062     if let Some(higher::Range {
1063         start: Some(start),
1064         ref end,
1065         limits,
1066     }) = higher::range(cx, arg)
1067     {
1068         // the var must be a single name
1069         if let PatKind::Binding(_, canonical_id, ident, _) = pat.kind {
1070             let mut visitor = VarVisitor {
1071                 cx,
1072                 var: canonical_id,
1073                 indexed_mut: FxHashSet::default(),
1074                 indexed_indirectly: FxHashMap::default(),
1075                 indexed_directly: FxHashMap::default(),
1076                 referenced: FxHashSet::default(),
1077                 nonindex: false,
1078                 prefer_mutable: false,
1079             };
1080             walk_expr(&mut visitor, body);
1081
1082             // linting condition: we only indexed one variable, and indexed it directly
1083             if visitor.indexed_indirectly.is_empty() && visitor.indexed_directly.len() == 1 {
1084                 let (indexed, (indexed_extent, indexed_ty)) = visitor
1085                     .indexed_directly
1086                     .into_iter()
1087                     .next()
1088                     .expect("already checked that we have exactly 1 element");
1089
1090                 // ensure that the indexed variable was declared before the loop, see #601
1091                 if let Some(indexed_extent) = indexed_extent {
1092                     let parent_id = cx.tcx.hir().get_parent_item(expr.hir_id);
1093                     let parent_def_id = cx.tcx.hir().local_def_id(parent_id);
1094                     let region_scope_tree = cx.tcx.region_scope_tree(parent_def_id);
1095                     let pat_extent = region_scope_tree.var_scope(pat.hir_id.local_id);
1096                     if region_scope_tree.is_subscope_of(indexed_extent, pat_extent) {
1097                         return;
1098                     }
1099                 }
1100
1101                 // don't lint if the container that is indexed does not have .iter() method
1102                 let has_iter = has_iter_method(cx, indexed_ty);
1103                 if has_iter.is_none() {
1104                     return;
1105                 }
1106
1107                 // don't lint if the container that is indexed into is also used without
1108                 // indexing
1109                 if visitor.referenced.contains(&indexed) {
1110                     return;
1111                 }
1112
1113                 let starts_at_zero = is_integer_const(cx, start, 0);
1114
1115                 let skip = if starts_at_zero {
1116                     String::new()
1117                 } else {
1118                     format!(".skip({})", snippet(cx, start.span, ".."))
1119                 };
1120
1121                 let mut end_is_start_plus_val = false;
1122
1123                 let take = if let Some(end) = *end {
1124                     let mut take_expr = end;
1125
1126                     if let ExprKind::Binary(ref op, ref left, ref right) = end.kind {
1127                         if let BinOpKind::Add = op.node {
1128                             let start_equal_left = SpanlessEq::new(cx).eq_expr(start, left);
1129                             let start_equal_right = SpanlessEq::new(cx).eq_expr(start, right);
1130
1131                             if start_equal_left {
1132                                 take_expr = right;
1133                             } else if start_equal_right {
1134                                 take_expr = left;
1135                             }
1136
1137                             end_is_start_plus_val = start_equal_left | start_equal_right;
1138                         }
1139                     }
1140
1141                     if is_len_call(end, indexed) || is_end_eq_array_len(cx, end, limits, indexed_ty) {
1142                         String::new()
1143                     } else {
1144                         match limits {
1145                             ast::RangeLimits::Closed => {
1146                                 let take_expr = sugg::Sugg::hir(cx, take_expr, "<count>");
1147                                 format!(".take({})", take_expr + sugg::ONE)
1148                             },
1149                             ast::RangeLimits::HalfOpen => format!(".take({})", snippet(cx, take_expr.span, "..")),
1150                         }
1151                     }
1152                 } else {
1153                     String::new()
1154                 };
1155
1156                 let (ref_mut, method) = if visitor.indexed_mut.contains(&indexed) {
1157                     ("mut ", "iter_mut")
1158                 } else {
1159                     ("", "iter")
1160                 };
1161
1162                 let take_is_empty = take.is_empty();
1163                 let mut method_1 = take;
1164                 let mut method_2 = skip;
1165
1166                 if end_is_start_plus_val {
1167                     mem::swap(&mut method_1, &mut method_2);
1168                 }
1169
1170                 if visitor.nonindex {
1171                     span_lint_and_then(
1172                         cx,
1173                         NEEDLESS_RANGE_LOOP,
1174                         expr.span,
1175                         &format!("the loop variable `{}` is used to index `{}`", ident.name, indexed),
1176                         |diag| {
1177                             multispan_sugg(
1178                                 diag,
1179                                 "consider using an iterator".to_string(),
1180                                 vec![
1181                                     (pat.span, format!("({}, <item>)", ident.name)),
1182                                     (
1183                                         arg.span,
1184                                         format!("{}.{}().enumerate(){}{}", indexed, method, method_1, method_2),
1185                                     ),
1186                                 ],
1187                             );
1188                         },
1189                     );
1190                 } else {
1191                     let repl = if starts_at_zero && take_is_empty {
1192                         format!("&{}{}", ref_mut, indexed)
1193                     } else {
1194                         format!("{}.{}(){}{}", indexed, method, method_1, method_2)
1195                     };
1196
1197                     span_lint_and_then(
1198                         cx,
1199                         NEEDLESS_RANGE_LOOP,
1200                         expr.span,
1201                         &format!(
1202                             "the loop variable `{}` is only used to index `{}`.",
1203                             ident.name, indexed
1204                         ),
1205                         |diag| {
1206                             multispan_sugg(
1207                                 diag,
1208                                 "consider using an iterator".to_string(),
1209                                 vec![(pat.span, "<item>".to_string()), (arg.span, repl)],
1210                             );
1211                         },
1212                     );
1213                 }
1214             }
1215         }
1216     }
1217 }
1218
1219 fn is_len_call(expr: &Expr<'_>, var: Name) -> bool {
1220     if_chain! {
1221         if let ExprKind::MethodCall(ref method, _, ref len_args) = expr.kind;
1222         if len_args.len() == 1;
1223         if method.ident.name == sym!(len);
1224         if let ExprKind::Path(QPath::Resolved(_, ref path)) = len_args[0].kind;
1225         if path.segments.len() == 1;
1226         if path.segments[0].ident.name == var;
1227         then {
1228             return true;
1229         }
1230     }
1231
1232     false
1233 }
1234
1235 fn is_end_eq_array_len<'tcx>(
1236     cx: &LateContext<'_, 'tcx>,
1237     end: &Expr<'_>,
1238     limits: ast::RangeLimits,
1239     indexed_ty: Ty<'tcx>,
1240 ) -> bool {
1241     if_chain! {
1242         if let ExprKind::Lit(ref lit) = end.kind;
1243         if let ast::LitKind::Int(end_int, _) = lit.node;
1244         if let ty::Array(_, arr_len_const) = indexed_ty.kind;
1245         if let Some(arr_len) = arr_len_const.try_eval_usize(cx.tcx, cx.param_env);
1246         then {
1247             return match limits {
1248                 ast::RangeLimits::Closed => end_int + 1 >= arr_len.into(),
1249                 ast::RangeLimits::HalfOpen => end_int >= arr_len.into(),
1250             };
1251         }
1252     }
1253
1254     false
1255 }
1256
1257 fn check_for_loop_reverse_range<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, arg: &'tcx Expr<'_>, expr: &'tcx Expr<'_>) {
1258     // if this for loop is iterating over a two-sided range...
1259     if let Some(higher::Range {
1260         start: Some(start),
1261         end: Some(end),
1262         limits,
1263     }) = higher::range(cx, arg)
1264     {
1265         // ...and both sides are compile-time constant integers...
1266         if let Some((start_idx, _)) = constant(cx, cx.tables, start) {
1267             if let Some((end_idx, _)) = constant(cx, cx.tables, end) {
1268                 // ...and the start index is greater than the end index,
1269                 // this loop will never run. This is often confusing for developers
1270                 // who think that this will iterate from the larger value to the
1271                 // smaller value.
1272                 let ty = cx.tables.expr_ty(start);
1273                 let (sup, eq) = match (start_idx, end_idx) {
1274                     (Constant::Int(start_idx), Constant::Int(end_idx)) => (
1275                         match ty.kind {
1276                             ty::Int(ity) => sext(cx.tcx, start_idx, ity) > sext(cx.tcx, end_idx, ity),
1277                             ty::Uint(_) => start_idx > end_idx,
1278                             _ => false,
1279                         },
1280                         start_idx == end_idx,
1281                     ),
1282                     _ => (false, false),
1283                 };
1284
1285                 if sup {
1286                     let start_snippet = snippet(cx, start.span, "_");
1287                     let end_snippet = snippet(cx, end.span, "_");
1288                     let dots = if limits == ast::RangeLimits::Closed {
1289                         "..="
1290                     } else {
1291                         ".."
1292                     };
1293
1294                     span_lint_and_then(
1295                         cx,
1296                         REVERSE_RANGE_LOOP,
1297                         expr.span,
1298                         "this range is empty so this for loop will never run",
1299                         |diag| {
1300                             diag.span_suggestion(
1301                                 arg.span,
1302                                 "consider using the following if you are attempting to iterate over this \
1303                                  range in reverse",
1304                                 format!(
1305                                     "({end}{dots}{start}).rev()",
1306                                     end = end_snippet,
1307                                     dots = dots,
1308                                     start = start_snippet
1309                                 ),
1310                                 Applicability::MaybeIncorrect,
1311                             );
1312                         },
1313                     );
1314                 } else if eq && limits != ast::RangeLimits::Closed {
1315                     // if they are equal, it's also problematic - this loop
1316                     // will never run.
1317                     span_lint(
1318                         cx,
1319                         REVERSE_RANGE_LOOP,
1320                         expr.span,
1321                         "this range is empty so this for loop will never run",
1322                     );
1323                 }
1324             }
1325         }
1326     }
1327 }
1328
1329 fn lint_iter_method(cx: &LateContext<'_, '_>, args: &[Expr<'_>], arg: &Expr<'_>, method_name: &str) {
1330     let mut applicability = Applicability::MachineApplicable;
1331     let object = snippet_with_applicability(cx, args[0].span, "_", &mut applicability);
1332     let muta = if method_name == "iter_mut" { "mut " } else { "" };
1333     span_lint_and_sugg(
1334         cx,
1335         EXPLICIT_ITER_LOOP,
1336         arg.span,
1337         "it is more concise to loop over references to containers instead of using explicit \
1338          iteration methods",
1339         "to write this more concisely, try",
1340         format!("&{}{}", muta, object),
1341         applicability,
1342     )
1343 }
1344
1345 fn check_for_loop_arg(cx: &LateContext<'_, '_>, pat: &Pat<'_>, arg: &Expr<'_>, expr: &Expr<'_>) {
1346     let mut next_loop_linted = false; // whether or not ITER_NEXT_LOOP lint was used
1347     if let ExprKind::MethodCall(ref method, _, ref args) = arg.kind {
1348         // just the receiver, no arguments
1349         if args.len() == 1 {
1350             let method_name = &*method.ident.as_str();
1351             // check for looping over x.iter() or x.iter_mut(), could use &x or &mut x
1352             if method_name == "iter" || method_name == "iter_mut" {
1353                 if is_ref_iterable_type(cx, &args[0]) {
1354                     lint_iter_method(cx, args, arg, method_name);
1355                 }
1356             } else if method_name == "into_iter" && match_trait_method(cx, arg, &paths::INTO_ITERATOR) {
1357                 let receiver_ty = cx.tables.expr_ty(&args[0]);
1358                 let receiver_ty_adjusted = cx.tables.expr_ty_adjusted(&args[0]);
1359                 if same_tys(cx, receiver_ty, receiver_ty_adjusted) {
1360                     let mut applicability = Applicability::MachineApplicable;
1361                     let object = snippet_with_applicability(cx, args[0].span, "_", &mut applicability);
1362                     span_lint_and_sugg(
1363                         cx,
1364                         EXPLICIT_INTO_ITER_LOOP,
1365                         arg.span,
1366                         "it is more concise to loop over containers instead of using explicit \
1367                          iteration methods",
1368                         "to write this more concisely, try",
1369                         object.to_string(),
1370                         applicability,
1371                     );
1372                 } else {
1373                     let ref_receiver_ty = cx.tcx.mk_ref(
1374                         cx.tcx.lifetimes.re_erased,
1375                         ty::TypeAndMut {
1376                             ty: receiver_ty,
1377                             mutbl: Mutability::Not,
1378                         },
1379                     );
1380                     if same_tys(cx, receiver_ty_adjusted, ref_receiver_ty) {
1381                         lint_iter_method(cx, args, arg, method_name)
1382                     }
1383                 }
1384             } else if method_name == "next" && match_trait_method(cx, arg, &paths::ITERATOR) {
1385                 span_lint(
1386                     cx,
1387                     ITER_NEXT_LOOP,
1388                     expr.span,
1389                     "you are iterating over `Iterator::next()` which is an Option; this will compile but is \
1390                      probably not what you want",
1391                 );
1392                 next_loop_linted = true;
1393             }
1394         }
1395     }
1396     if !next_loop_linted {
1397         check_arg_type(cx, pat, arg);
1398     }
1399 }
1400
1401 /// Checks for `for` loops over `Option`s and `Result`s.
1402 fn check_arg_type(cx: &LateContext<'_, '_>, pat: &Pat<'_>, arg: &Expr<'_>) {
1403     let ty = cx.tables.expr_ty(arg);
1404     if is_type_diagnostic_item(cx, ty, sym!(option_type)) {
1405         span_lint_and_help(
1406             cx,
1407             FOR_LOOP_OVER_OPTION,
1408             arg.span,
1409             &format!(
1410                 "for loop over `{0}`, which is an `Option`. This is more readably written as an \
1411                  `if let` statement.",
1412                 snippet(cx, arg.span, "_")
1413             ),
1414             None,
1415             &format!(
1416                 "consider replacing `for {0} in {1}` with `if let Some({0}) = {1}`",
1417                 snippet(cx, pat.span, "_"),
1418                 snippet(cx, arg.span, "_")
1419             ),
1420         );
1421     } else if is_type_diagnostic_item(cx, ty, sym!(result_type)) {
1422         span_lint_and_help(
1423             cx,
1424             FOR_LOOP_OVER_RESULT,
1425             arg.span,
1426             &format!(
1427                 "for loop over `{0}`, which is a `Result`. This is more readably written as an \
1428                  `if let` statement.",
1429                 snippet(cx, arg.span, "_")
1430             ),
1431             None,
1432             &format!(
1433                 "consider replacing `for {0} in {1}` with `if let Ok({0}) = {1}`",
1434                 snippet(cx, pat.span, "_"),
1435                 snippet(cx, arg.span, "_")
1436             ),
1437         );
1438     }
1439 }
1440
1441 fn check_for_loop_explicit_counter<'a, 'tcx>(
1442     cx: &LateContext<'a, 'tcx>,
1443     pat: &'tcx Pat<'_>,
1444     arg: &'tcx Expr<'_>,
1445     body: &'tcx Expr<'_>,
1446     expr: &'tcx Expr<'_>,
1447 ) {
1448     // Look for variables that are incremented once per loop iteration.
1449     let mut visitor = IncrementVisitor {
1450         cx,
1451         states: FxHashMap::default(),
1452         depth: 0,
1453         done: false,
1454     };
1455     walk_expr(&mut visitor, body);
1456
1457     // For each candidate, check the parent block to see if
1458     // it's initialized to zero at the start of the loop.
1459     if let Some(block) = get_enclosing_block(&cx, expr.hir_id) {
1460         for (id, _) in visitor.states.iter().filter(|&(_, v)| *v == VarState::IncrOnce) {
1461             let mut visitor2 = InitializeVisitor {
1462                 cx,
1463                 end_expr: expr,
1464                 var_id: *id,
1465                 state: VarState::IncrOnce,
1466                 name: None,
1467                 depth: 0,
1468                 past_loop: false,
1469             };
1470             walk_block(&mut visitor2, block);
1471
1472             if visitor2.state == VarState::Warn {
1473                 if let Some(name) = visitor2.name {
1474                     let mut applicability = Applicability::MachineApplicable;
1475
1476                     // for some reason this is the only way to get the `Span`
1477                     // of the entire `for` loop
1478                     let for_span = if let ExprKind::Match(_, arms, _) = &expr.kind {
1479                         arms[0].body.span
1480                     } else {
1481                         unreachable!()
1482                     };
1483
1484                     span_lint_and_sugg(
1485                         cx,
1486                         EXPLICIT_COUNTER_LOOP,
1487                         for_span.with_hi(arg.span.hi()),
1488                         &format!("the variable `{}` is used as a loop counter.", name),
1489                         "consider using",
1490                         format!(
1491                             "for ({}, {}) in {}.enumerate()",
1492                             name,
1493                             snippet_with_applicability(cx, pat.span, "item", &mut applicability),
1494                             make_iterator_snippet(cx, arg, &mut applicability),
1495                         ),
1496                         applicability,
1497                     );
1498                 }
1499             }
1500         }
1501     }
1502 }
1503
1504 /// If `arg` was the argument to a `for` loop, return the "cleanest" way of writing the
1505 /// actual `Iterator` that the loop uses.
1506 fn make_iterator_snippet(cx: &LateContext<'_, '_>, arg: &Expr<'_>, applic_ref: &mut Applicability) -> String {
1507     let impls_iterator = get_trait_def_id(cx, &paths::ITERATOR)
1508         .map_or(false, |id| implements_trait(cx, cx.tables.expr_ty(arg), id, &[]));
1509     if impls_iterator {
1510         format!(
1511             "{}",
1512             sugg::Sugg::hir_with_applicability(cx, arg, "_", applic_ref).maybe_par()
1513         )
1514     } else {
1515         // (&x).into_iter() ==> x.iter()
1516         // (&mut x).into_iter() ==> x.iter_mut()
1517         match &arg.kind {
1518             ExprKind::AddrOf(BorrowKind::Ref, mutability, arg_inner)
1519                 if has_iter_method(cx, cx.tables.expr_ty(&arg_inner)).is_some() =>
1520             {
1521                 let meth_name = match mutability {
1522                     Mutability::Mut => "iter_mut",
1523                     Mutability::Not => "iter",
1524                 };
1525                 format!(
1526                     "{}.{}()",
1527                     sugg::Sugg::hir_with_applicability(cx, &arg_inner, "_", applic_ref).maybe_par(),
1528                     meth_name,
1529                 )
1530             }
1531             _ => format!(
1532                 "{}.into_iter()",
1533                 sugg::Sugg::hir_with_applicability(cx, arg, "_", applic_ref).maybe_par()
1534             ),
1535         }
1536     }
1537 }
1538
1539 /// Checks for the `FOR_KV_MAP` lint.
1540 fn check_for_loop_over_map_kv<'a, 'tcx>(
1541     cx: &LateContext<'a, 'tcx>,
1542     pat: &'tcx Pat<'_>,
1543     arg: &'tcx Expr<'_>,
1544     body: &'tcx Expr<'_>,
1545     expr: &'tcx Expr<'_>,
1546 ) {
1547     let pat_span = pat.span;
1548
1549     if let PatKind::Tuple(ref pat, _) = pat.kind {
1550         if pat.len() == 2 {
1551             let arg_span = arg.span;
1552             let (new_pat_span, kind, ty, mutbl) = match cx.tables.expr_ty(arg).kind {
1553                 ty::Ref(_, ty, mutbl) => match (&pat[0].kind, &pat[1].kind) {
1554                     (key, _) if pat_is_wild(key, body) => (pat[1].span, "value", ty, mutbl),
1555                     (_, value) if pat_is_wild(value, body) => (pat[0].span, "key", ty, Mutability::Not),
1556                     _ => return,
1557                 },
1558                 _ => return,
1559             };
1560             let mutbl = match mutbl {
1561                 Mutability::Not => "",
1562                 Mutability::Mut => "_mut",
1563             };
1564             let arg = match arg.kind {
1565                 ExprKind::AddrOf(BorrowKind::Ref, _, ref expr) => &**expr,
1566                 _ => arg,
1567             };
1568
1569             if is_type_diagnostic_item(cx, ty, sym!(hashmap_type)) || match_type(cx, ty, &paths::BTREEMAP) {
1570                 span_lint_and_then(
1571                     cx,
1572                     FOR_KV_MAP,
1573                     expr.span,
1574                     &format!("you seem to want to iterate on a map's {}s", kind),
1575                     |diag| {
1576                         let map = sugg::Sugg::hir(cx, arg, "map");
1577                         multispan_sugg(
1578                             diag,
1579                             "use the corresponding method".into(),
1580                             vec![
1581                                 (pat_span, snippet(cx, new_pat_span, kind).into_owned()),
1582                                 (arg_span, format!("{}.{}s{}()", map.maybe_par(), kind, mutbl)),
1583                             ],
1584                         );
1585                     },
1586                 );
1587             }
1588         }
1589     }
1590 }
1591
1592 struct MutatePairDelegate {
1593     hir_id_low: Option<HirId>,
1594     hir_id_high: Option<HirId>,
1595     span_low: Option<Span>,
1596     span_high: Option<Span>,
1597 }
1598
1599 impl<'tcx> Delegate<'tcx> for MutatePairDelegate {
1600     fn consume(&mut self, _: &Place<'tcx>, _: ConsumeMode) {}
1601
1602     fn borrow(&mut self, cmt: &Place<'tcx>, bk: ty::BorrowKind) {
1603         if let ty::BorrowKind::MutBorrow = bk {
1604             if let PlaceBase::Local(id) = cmt.base {
1605                 if Some(id) == self.hir_id_low {
1606                     self.span_low = Some(cmt.span)
1607                 }
1608                 if Some(id) == self.hir_id_high {
1609                     self.span_high = Some(cmt.span)
1610                 }
1611             }
1612         }
1613     }
1614
1615     fn mutate(&mut self, cmt: &Place<'tcx>) {
1616         if let PlaceBase::Local(id) = cmt.base {
1617             if Some(id) == self.hir_id_low {
1618                 self.span_low = Some(cmt.span)
1619             }
1620             if Some(id) == self.hir_id_high {
1621                 self.span_high = Some(cmt.span)
1622             }
1623         }
1624     }
1625 }
1626
1627 impl<'tcx> MutatePairDelegate {
1628     fn mutation_span(&self) -> (Option<Span>, Option<Span>) {
1629         (self.span_low, self.span_high)
1630     }
1631 }
1632
1633 fn check_for_mut_range_bound(cx: &LateContext<'_, '_>, arg: &Expr<'_>, body: &Expr<'_>) {
1634     if let Some(higher::Range {
1635         start: Some(start),
1636         end: Some(end),
1637         ..
1638     }) = higher::range(cx, arg)
1639     {
1640         let mut_ids = vec![check_for_mutability(cx, start), check_for_mutability(cx, end)];
1641         if mut_ids[0].is_some() || mut_ids[1].is_some() {
1642             let (span_low, span_high) = check_for_mutation(cx, body, &mut_ids);
1643             mut_warn_with_span(cx, span_low);
1644             mut_warn_with_span(cx, span_high);
1645         }
1646     }
1647 }
1648
1649 fn mut_warn_with_span(cx: &LateContext<'_, '_>, span: Option<Span>) {
1650     if let Some(sp) = span {
1651         span_lint(
1652             cx,
1653             MUT_RANGE_BOUND,
1654             sp,
1655             "attempt to mutate range bound within loop; note that the range of the loop is unchanged",
1656         );
1657     }
1658 }
1659
1660 fn check_for_mutability(cx: &LateContext<'_, '_>, bound: &Expr<'_>) -> Option<HirId> {
1661     if_chain! {
1662         if let ExprKind::Path(ref qpath) = bound.kind;
1663         if let QPath::Resolved(None, _) = *qpath;
1664         then {
1665             let res = qpath_res(cx, qpath, bound.hir_id);
1666             if let Res::Local(hir_id) = res {
1667                 let node_str = cx.tcx.hir().get(hir_id);
1668                 if_chain! {
1669                     if let Node::Binding(pat) = node_str;
1670                     if let PatKind::Binding(bind_ann, ..) = pat.kind;
1671                     if let BindingAnnotation::Mutable = bind_ann;
1672                     then {
1673                         return Some(hir_id);
1674                     }
1675                 }
1676             }
1677         }
1678     }
1679     None
1680 }
1681
1682 fn check_for_mutation(
1683     cx: &LateContext<'_, '_>,
1684     body: &Expr<'_>,
1685     bound_ids: &[Option<HirId>],
1686 ) -> (Option<Span>, Option<Span>) {
1687     let mut delegate = MutatePairDelegate {
1688         hir_id_low: bound_ids[0],
1689         hir_id_high: bound_ids[1],
1690         span_low: None,
1691         span_high: None,
1692     };
1693     let def_id = body.hir_id.owner.to_def_id();
1694     cx.tcx.infer_ctxt().enter(|infcx| {
1695         ExprUseVisitor::new(&mut delegate, &infcx, def_id, cx.param_env, cx.tables).walk_expr(body);
1696     });
1697     delegate.mutation_span()
1698 }
1699
1700 /// Returns `true` if the pattern is a `PatWild` or an ident prefixed with `_`.
1701 fn pat_is_wild<'tcx>(pat: &'tcx PatKind<'_>, body: &'tcx Expr<'_>) -> bool {
1702     match *pat {
1703         PatKind::Wild => true,
1704         PatKind::Binding(.., ident, None) if ident.as_str().starts_with('_') => is_unused(&ident, body),
1705         _ => false,
1706     }
1707 }
1708
1709 struct LocalUsedVisitor<'a, 'tcx> {
1710     cx: &'a LateContext<'a, 'tcx>,
1711     local: HirId,
1712     used: bool,
1713 }
1714
1715 impl<'a, 'tcx> Visitor<'tcx> for LocalUsedVisitor<'a, 'tcx> {
1716     type Map = Map<'tcx>;
1717
1718     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
1719         if same_var(self.cx, expr, self.local) {
1720             self.used = true;
1721         } else {
1722             walk_expr(self, expr);
1723         }
1724     }
1725
1726     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
1727         NestedVisitorMap::None
1728     }
1729 }
1730
1731 struct VarVisitor<'a, 'tcx> {
1732     /// context reference
1733     cx: &'a LateContext<'a, 'tcx>,
1734     /// var name to look for as index
1735     var: HirId,
1736     /// indexed variables that are used mutably
1737     indexed_mut: FxHashSet<Name>,
1738     /// indirectly indexed variables (`v[(i + 4) % N]`), the extend is `None` for global
1739     indexed_indirectly: FxHashMap<Name, Option<region::Scope>>,
1740     /// subset of `indexed` of vars that are indexed directly: `v[i]`
1741     /// this will not contain cases like `v[calc_index(i)]` or `v[(i + 4) % N]`
1742     indexed_directly: FxHashMap<Name, (Option<region::Scope>, Ty<'tcx>)>,
1743     /// Any names that are used outside an index operation.
1744     /// Used to detect things like `&mut vec` used together with `vec[i]`
1745     referenced: FxHashSet<Name>,
1746     /// has the loop variable been used in expressions other than the index of
1747     /// an index op?
1748     nonindex: bool,
1749     /// Whether we are inside the `$` in `&mut $` or `$ = foo` or `$.bar`, where bar
1750     /// takes `&mut self`
1751     prefer_mutable: bool,
1752 }
1753
1754 impl<'a, 'tcx> VarVisitor<'a, 'tcx> {
1755     fn check(&mut self, idx: &'tcx Expr<'_>, seqexpr: &'tcx Expr<'_>, expr: &'tcx Expr<'_>) -> bool {
1756         if_chain! {
1757             // the indexed container is referenced by a name
1758             if let ExprKind::Path(ref seqpath) = seqexpr.kind;
1759             if let QPath::Resolved(None, ref seqvar) = *seqpath;
1760             if seqvar.segments.len() == 1;
1761             then {
1762                 let index_used_directly = same_var(self.cx, idx, self.var);
1763                 let indexed_indirectly = {
1764                     let mut used_visitor = LocalUsedVisitor {
1765                         cx: self.cx,
1766                         local: self.var,
1767                         used: false,
1768                     };
1769                     walk_expr(&mut used_visitor, idx);
1770                     used_visitor.used
1771                 };
1772
1773                 if indexed_indirectly || index_used_directly {
1774                     if self.prefer_mutable {
1775                         self.indexed_mut.insert(seqvar.segments[0].ident.name);
1776                     }
1777                     let res = qpath_res(self.cx, seqpath, seqexpr.hir_id);
1778                     match res {
1779                         Res::Local(hir_id) => {
1780                             let parent_id = self.cx.tcx.hir().get_parent_item(expr.hir_id);
1781                             let parent_def_id = self.cx.tcx.hir().local_def_id(parent_id);
1782                             let extent = self.cx.tcx.region_scope_tree(parent_def_id).var_scope(hir_id.local_id);
1783                             if indexed_indirectly {
1784                                 self.indexed_indirectly.insert(seqvar.segments[0].ident.name, Some(extent));
1785                             }
1786                             if index_used_directly {
1787                                 self.indexed_directly.insert(
1788                                     seqvar.segments[0].ident.name,
1789                                     (Some(extent), self.cx.tables.node_type(seqexpr.hir_id)),
1790                                 );
1791                             }
1792                             return false;  // no need to walk further *on the variable*
1793                         }
1794                         Res::Def(DefKind::Static | DefKind::Const, ..) => {
1795                             if indexed_indirectly {
1796                                 self.indexed_indirectly.insert(seqvar.segments[0].ident.name, None);
1797                             }
1798                             if index_used_directly {
1799                                 self.indexed_directly.insert(
1800                                     seqvar.segments[0].ident.name,
1801                                     (None, self.cx.tables.node_type(seqexpr.hir_id)),
1802                                 );
1803                             }
1804                             return false;  // no need to walk further *on the variable*
1805                         }
1806                         _ => (),
1807                     }
1808                 }
1809             }
1810         }
1811         true
1812     }
1813 }
1814
1815 impl<'a, 'tcx> Visitor<'tcx> for VarVisitor<'a, 'tcx> {
1816     type Map = Map<'tcx>;
1817
1818     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
1819         if_chain! {
1820             // a range index op
1821             if let ExprKind::MethodCall(ref meth, _, ref args) = expr.kind;
1822             if (meth.ident.name == sym!(index) && match_trait_method(self.cx, expr, &paths::INDEX))
1823                 || (meth.ident.name == sym!(index_mut) && match_trait_method(self.cx, expr, &paths::INDEX_MUT));
1824             if !self.check(&args[1], &args[0], expr);
1825             then { return }
1826         }
1827
1828         if_chain! {
1829             // an index op
1830             if let ExprKind::Index(ref seqexpr, ref idx) = expr.kind;
1831             if !self.check(idx, seqexpr, expr);
1832             then { return }
1833         }
1834
1835         if_chain! {
1836             // directly using a variable
1837             if let ExprKind::Path(ref qpath) = expr.kind;
1838             if let QPath::Resolved(None, ref path) = *qpath;
1839             if path.segments.len() == 1;
1840             then {
1841                 if let Res::Local(local_id) = qpath_res(self.cx, qpath, expr.hir_id) {
1842                     if local_id == self.var {
1843                         self.nonindex = true;
1844                     } else {
1845                         // not the correct variable, but still a variable
1846                         self.referenced.insert(path.segments[0].ident.name);
1847                     }
1848                 }
1849             }
1850         }
1851
1852         let old = self.prefer_mutable;
1853         match expr.kind {
1854             ExprKind::AssignOp(_, ref lhs, ref rhs) | ExprKind::Assign(ref lhs, ref rhs, _) => {
1855                 self.prefer_mutable = true;
1856                 self.visit_expr(lhs);
1857                 self.prefer_mutable = false;
1858                 self.visit_expr(rhs);
1859             },
1860             ExprKind::AddrOf(BorrowKind::Ref, mutbl, ref expr) => {
1861                 if mutbl == Mutability::Mut {
1862                     self.prefer_mutable = true;
1863                 }
1864                 self.visit_expr(expr);
1865             },
1866             ExprKind::Call(ref f, args) => {
1867                 self.visit_expr(f);
1868                 for expr in args {
1869                     let ty = self.cx.tables.expr_ty_adjusted(expr);
1870                     self.prefer_mutable = false;
1871                     if let ty::Ref(_, _, mutbl) = ty.kind {
1872                         if mutbl == Mutability::Mut {
1873                             self.prefer_mutable = true;
1874                         }
1875                     }
1876                     self.visit_expr(expr);
1877                 }
1878             },
1879             ExprKind::MethodCall(_, _, args) => {
1880                 let def_id = self.cx.tables.type_dependent_def_id(expr.hir_id).unwrap();
1881                 for (ty, expr) in self.cx.tcx.fn_sig(def_id).inputs().skip_binder().iter().zip(args) {
1882                     self.prefer_mutable = false;
1883                     if let ty::Ref(_, _, mutbl) = ty.kind {
1884                         if mutbl == Mutability::Mut {
1885                             self.prefer_mutable = true;
1886                         }
1887                     }
1888                     self.visit_expr(expr);
1889                 }
1890             },
1891             ExprKind::Closure(_, _, body_id, ..) => {
1892                 let body = self.cx.tcx.hir().body(body_id);
1893                 self.visit_expr(&body.value);
1894             },
1895             _ => walk_expr(self, expr),
1896         }
1897         self.prefer_mutable = old;
1898     }
1899     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
1900         NestedVisitorMap::None
1901     }
1902 }
1903
1904 fn is_used_inside<'a, 'tcx>(cx: &'a LateContext<'a, 'tcx>, expr: &'tcx Expr<'_>, container: &'tcx Expr<'_>) -> bool {
1905     let def_id = match var_def_id(cx, expr) {
1906         Some(id) => id,
1907         None => return false,
1908     };
1909     if let Some(used_mutably) = mutated_variables(container, cx) {
1910         if used_mutably.contains(&def_id) {
1911             return true;
1912         }
1913     }
1914     false
1915 }
1916
1917 fn is_iterator_used_after_while_let<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, iter_expr: &'tcx Expr<'_>) -> bool {
1918     let def_id = match var_def_id(cx, iter_expr) {
1919         Some(id) => id,
1920         None => return false,
1921     };
1922     let mut visitor = VarUsedAfterLoopVisitor {
1923         cx,
1924         def_id,
1925         iter_expr_id: iter_expr.hir_id,
1926         past_while_let: false,
1927         var_used_after_while_let: false,
1928     };
1929     if let Some(enclosing_block) = get_enclosing_block(cx, def_id) {
1930         walk_block(&mut visitor, enclosing_block);
1931     }
1932     visitor.var_used_after_while_let
1933 }
1934
1935 struct VarUsedAfterLoopVisitor<'a, 'tcx> {
1936     cx: &'a LateContext<'a, 'tcx>,
1937     def_id: HirId,
1938     iter_expr_id: HirId,
1939     past_while_let: bool,
1940     var_used_after_while_let: bool,
1941 }
1942
1943 impl<'a, 'tcx> Visitor<'tcx> for VarUsedAfterLoopVisitor<'a, 'tcx> {
1944     type Map = Map<'tcx>;
1945
1946     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
1947         if self.past_while_let {
1948             if Some(self.def_id) == var_def_id(self.cx, expr) {
1949                 self.var_used_after_while_let = true;
1950             }
1951         } else if self.iter_expr_id == expr.hir_id {
1952             self.past_while_let = true;
1953         }
1954         walk_expr(self, expr);
1955     }
1956     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
1957         NestedVisitorMap::None
1958     }
1959 }
1960
1961 /// Returns `true` if the type of expr is one that provides `IntoIterator` impls
1962 /// for `&T` and `&mut T`, such as `Vec`.
1963 #[rustfmt::skip]
1964 fn is_ref_iterable_type(cx: &LateContext<'_, '_>, e: &Expr<'_>) -> bool {
1965     // no walk_ptrs_ty: calling iter() on a reference can make sense because it
1966     // will allow further borrows afterwards
1967     let ty = cx.tables.expr_ty(e);
1968     is_iterable_array(ty, cx) ||
1969     is_type_diagnostic_item(cx, ty, sym!(vec_type)) ||
1970     match_type(cx, ty, &paths::LINKED_LIST) ||
1971     is_type_diagnostic_item(cx, ty, sym!(hashmap_type)) ||
1972     is_type_diagnostic_item(cx, ty, sym!(hashset_type)) ||
1973     is_type_diagnostic_item(cx, ty, sym!(vecdeque_type)) ||
1974     match_type(cx, ty, &paths::BINARY_HEAP) ||
1975     match_type(cx, ty, &paths::BTREEMAP) ||
1976     match_type(cx, ty, &paths::BTREESET)
1977 }
1978
1979 fn is_iterable_array<'tcx>(ty: Ty<'tcx>, cx: &LateContext<'_, 'tcx>) -> bool {
1980     // IntoIterator is currently only implemented for array sizes <= 32 in rustc
1981     match ty.kind {
1982         ty::Array(_, n) => {
1983             if let Some(val) = n.try_eval_usize(cx.tcx, cx.param_env) {
1984                 (0..=32).contains(&val)
1985             } else {
1986                 false
1987             }
1988         },
1989         _ => false,
1990     }
1991 }
1992
1993 /// If a block begins with a statement (possibly a `let` binding) and has an
1994 /// expression, return it.
1995 fn extract_expr_from_first_stmt<'tcx>(block: &Block<'tcx>) -> Option<&'tcx Expr<'tcx>> {
1996     if block.stmts.is_empty() {
1997         return None;
1998     }
1999     if let StmtKind::Local(ref local) = block.stmts[0].kind {
2000         if let Some(expr) = local.init {
2001             Some(expr)
2002         } else {
2003             None
2004         }
2005     } else {
2006         None
2007     }
2008 }
2009
2010 /// If a block begins with an expression (with or without semicolon), return it.
2011 fn extract_first_expr<'tcx>(block: &Block<'tcx>) -> Option<&'tcx Expr<'tcx>> {
2012     match block.expr {
2013         Some(ref expr) if block.stmts.is_empty() => Some(expr),
2014         None if !block.stmts.is_empty() => match block.stmts[0].kind {
2015             StmtKind::Expr(ref expr) | StmtKind::Semi(ref expr) => Some(expr),
2016             StmtKind::Local(..) | StmtKind::Item(..) => None,
2017         },
2018         _ => None,
2019     }
2020 }
2021
2022 /// Returns `true` if expr contains a single break expr without destination label
2023 /// and
2024 /// passed expression. The expression may be within a block.
2025 fn is_simple_break_expr(expr: &Expr<'_>) -> bool {
2026     match expr.kind {
2027         ExprKind::Break(dest, ref passed_expr) if dest.label.is_none() && passed_expr.is_none() => true,
2028         ExprKind::Block(ref b, _) => extract_first_expr(b).map_or(false, |subexpr| is_simple_break_expr(subexpr)),
2029         _ => false,
2030     }
2031 }
2032
2033 // To trigger the EXPLICIT_COUNTER_LOOP lint, a variable must be
2034 // incremented exactly once in the loop body, and initialized to zero
2035 // at the start of the loop.
2036 #[derive(Debug, PartialEq)]
2037 enum VarState {
2038     Initial,  // Not examined yet
2039     IncrOnce, // Incremented exactly once, may be a loop counter
2040     Declared, // Declared but not (yet) initialized to zero
2041     Warn,
2042     DontWarn,
2043 }
2044
2045 /// Scan a for loop for variables that are incremented exactly once.
2046 struct IncrementVisitor<'a, 'tcx> {
2047     cx: &'a LateContext<'a, 'tcx>,      // context reference
2048     states: FxHashMap<HirId, VarState>, // incremented variables
2049     depth: u32,                         // depth of conditional expressions
2050     done: bool,
2051 }
2052
2053 impl<'a, 'tcx> Visitor<'tcx> for IncrementVisitor<'a, 'tcx> {
2054     type Map = Map<'tcx>;
2055
2056     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
2057         if self.done {
2058             return;
2059         }
2060
2061         // If node is a variable
2062         if let Some(def_id) = var_def_id(self.cx, expr) {
2063             if let Some(parent) = get_parent_expr(self.cx, expr) {
2064                 let state = self.states.entry(def_id).or_insert(VarState::Initial);
2065
2066                 match parent.kind {
2067                     ExprKind::AssignOp(op, ref lhs, ref rhs) => {
2068                         if lhs.hir_id == expr.hir_id {
2069                             if op.node == BinOpKind::Add && is_integer_const(self.cx, rhs, 1) {
2070                                 *state = match *state {
2071                                     VarState::Initial if self.depth == 0 => VarState::IncrOnce,
2072                                     _ => VarState::DontWarn,
2073                                 };
2074                             } else {
2075                                 // Assigned some other value
2076                                 *state = VarState::DontWarn;
2077                             }
2078                         }
2079                     },
2080                     ExprKind::Assign(ref lhs, _, _) if lhs.hir_id == expr.hir_id => *state = VarState::DontWarn,
2081                     ExprKind::AddrOf(BorrowKind::Ref, mutability, _) if mutability == Mutability::Mut => {
2082                         *state = VarState::DontWarn
2083                     },
2084                     _ => (),
2085                 }
2086             }
2087         } else if is_loop(expr) || is_conditional(expr) {
2088             self.depth += 1;
2089             walk_expr(self, expr);
2090             self.depth -= 1;
2091             return;
2092         } else if let ExprKind::Continue(_) = expr.kind {
2093             self.done = true;
2094             return;
2095         }
2096         walk_expr(self, expr);
2097     }
2098     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
2099         NestedVisitorMap::None
2100     }
2101 }
2102
2103 /// Checks whether a variable is initialized to zero at the start of a loop.
2104 struct InitializeVisitor<'a, 'tcx> {
2105     cx: &'a LateContext<'a, 'tcx>, // context reference
2106     end_expr: &'tcx Expr<'tcx>,    // the for loop. Stop scanning here.
2107     var_id: HirId,
2108     state: VarState,
2109     name: Option<Name>,
2110     depth: u32, // depth of conditional expressions
2111     past_loop: bool,
2112 }
2113
2114 impl<'a, 'tcx> Visitor<'tcx> for InitializeVisitor<'a, 'tcx> {
2115     type Map = Map<'tcx>;
2116
2117     fn visit_stmt(&mut self, stmt: &'tcx Stmt<'_>) {
2118         // Look for declarations of the variable
2119         if let StmtKind::Local(ref local) = stmt.kind {
2120             if local.pat.hir_id == self.var_id {
2121                 if let PatKind::Binding(.., ident, _) = local.pat.kind {
2122                     self.name = Some(ident.name);
2123
2124                     self.state = if let Some(ref init) = local.init {
2125                         if is_integer_const(&self.cx, init, 0) {
2126                             VarState::Warn
2127                         } else {
2128                             VarState::Declared
2129                         }
2130                     } else {
2131                         VarState::Declared
2132                     }
2133                 }
2134             }
2135         }
2136         walk_stmt(self, stmt);
2137     }
2138
2139     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
2140         if self.state == VarState::DontWarn {
2141             return;
2142         }
2143         if SpanlessEq::new(self.cx).eq_expr(&expr, self.end_expr) {
2144             self.past_loop = true;
2145             return;
2146         }
2147         // No need to visit expressions before the variable is
2148         // declared
2149         if self.state == VarState::IncrOnce {
2150             return;
2151         }
2152
2153         // If node is the desired variable, see how it's used
2154         if var_def_id(self.cx, expr) == Some(self.var_id) {
2155             if let Some(parent) = get_parent_expr(self.cx, expr) {
2156                 match parent.kind {
2157                     ExprKind::AssignOp(_, ref lhs, _) if lhs.hir_id == expr.hir_id => {
2158                         self.state = VarState::DontWarn;
2159                     },
2160                     ExprKind::Assign(ref lhs, ref rhs, _) if lhs.hir_id == expr.hir_id => {
2161                         self.state = if is_integer_const(&self.cx, rhs, 0) && self.depth == 0 {
2162                             VarState::Warn
2163                         } else {
2164                             VarState::DontWarn
2165                         }
2166                     },
2167                     ExprKind::AddrOf(BorrowKind::Ref, mutability, _) if mutability == Mutability::Mut => {
2168                         self.state = VarState::DontWarn
2169                     },
2170                     _ => (),
2171                 }
2172             }
2173
2174             if self.past_loop {
2175                 self.state = VarState::DontWarn;
2176                 return;
2177             }
2178         } else if !self.past_loop && is_loop(expr) {
2179             self.state = VarState::DontWarn;
2180             return;
2181         } else if is_conditional(expr) {
2182             self.depth += 1;
2183             walk_expr(self, expr);
2184             self.depth -= 1;
2185             return;
2186         }
2187         walk_expr(self, expr);
2188     }
2189
2190     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
2191         NestedVisitorMap::OnlyBodies(self.cx.tcx.hir())
2192     }
2193 }
2194
2195 fn var_def_id(cx: &LateContext<'_, '_>, expr: &Expr<'_>) -> Option<HirId> {
2196     if let ExprKind::Path(ref qpath) = expr.kind {
2197         let path_res = qpath_res(cx, qpath, expr.hir_id);
2198         if let Res::Local(hir_id) = path_res {
2199             return Some(hir_id);
2200         }
2201     }
2202     None
2203 }
2204
2205 fn is_loop(expr: &Expr<'_>) -> bool {
2206     match expr.kind {
2207         ExprKind::Loop(..) => true,
2208         _ => false,
2209     }
2210 }
2211
2212 fn is_conditional(expr: &Expr<'_>) -> bool {
2213     match expr.kind {
2214         ExprKind::Match(..) => true,
2215         _ => false,
2216     }
2217 }
2218
2219 fn is_nested(cx: &LateContext<'_, '_>, match_expr: &Expr<'_>, iter_expr: &Expr<'_>) -> bool {
2220     if_chain! {
2221         if let Some(loop_block) = get_enclosing_block(cx, match_expr.hir_id);
2222         let parent_node = cx.tcx.hir().get_parent_node(loop_block.hir_id);
2223         if let Some(Node::Expr(loop_expr)) = cx.tcx.hir().find(parent_node);
2224         then {
2225             return is_loop_nested(cx, loop_expr, iter_expr)
2226         }
2227     }
2228     false
2229 }
2230
2231 fn is_loop_nested(cx: &LateContext<'_, '_>, loop_expr: &Expr<'_>, iter_expr: &Expr<'_>) -> bool {
2232     let mut id = loop_expr.hir_id;
2233     let iter_name = if let Some(name) = path_name(iter_expr) {
2234         name
2235     } else {
2236         return true;
2237     };
2238     loop {
2239         let parent = cx.tcx.hir().get_parent_node(id);
2240         if parent == id {
2241             return false;
2242         }
2243         match cx.tcx.hir().find(parent) {
2244             Some(Node::Expr(expr)) => {
2245                 if let ExprKind::Loop(..) = expr.kind {
2246                     return true;
2247                 };
2248             },
2249             Some(Node::Block(block)) => {
2250                 let mut block_visitor = LoopNestVisitor {
2251                     hir_id: id,
2252                     iterator: iter_name,
2253                     nesting: Unknown,
2254                 };
2255                 walk_block(&mut block_visitor, block);
2256                 if block_visitor.nesting == RuledOut {
2257                     return false;
2258                 }
2259             },
2260             Some(Node::Stmt(_)) => (),
2261             _ => {
2262                 return false;
2263             },
2264         }
2265         id = parent;
2266     }
2267 }
2268
2269 #[derive(PartialEq, Eq)]
2270 enum Nesting {
2271     Unknown,     // no nesting detected yet
2272     RuledOut,    // the iterator is initialized or assigned within scope
2273     LookFurther, // no nesting detected, no further walk required
2274 }
2275
2276 use self::Nesting::{LookFurther, RuledOut, Unknown};
2277
2278 struct LoopNestVisitor {
2279     hir_id: HirId,
2280     iterator: Name,
2281     nesting: Nesting,
2282 }
2283
2284 impl<'tcx> Visitor<'tcx> for LoopNestVisitor {
2285     type Map = Map<'tcx>;
2286
2287     fn visit_stmt(&mut self, stmt: &'tcx Stmt<'_>) {
2288         if stmt.hir_id == self.hir_id {
2289             self.nesting = LookFurther;
2290         } else if self.nesting == Unknown {
2291             walk_stmt(self, stmt);
2292         }
2293     }
2294
2295     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
2296         if self.nesting != Unknown {
2297             return;
2298         }
2299         if expr.hir_id == self.hir_id {
2300             self.nesting = LookFurther;
2301             return;
2302         }
2303         match expr.kind {
2304             ExprKind::Assign(ref path, _, _) | ExprKind::AssignOp(_, ref path, _) => {
2305                 if match_var(path, self.iterator) {
2306                     self.nesting = RuledOut;
2307                 }
2308             },
2309             _ => walk_expr(self, expr),
2310         }
2311     }
2312
2313     fn visit_pat(&mut self, pat: &'tcx Pat<'_>) {
2314         if self.nesting != Unknown {
2315             return;
2316         }
2317         if let PatKind::Binding(.., span_name, _) = pat.kind {
2318             if self.iterator == span_name.name {
2319                 self.nesting = RuledOut;
2320                 return;
2321             }
2322         }
2323         walk_pat(self, pat)
2324     }
2325
2326     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
2327         NestedVisitorMap::None
2328     }
2329 }
2330
2331 fn path_name(e: &Expr<'_>) -> Option<Name> {
2332     if let ExprKind::Path(QPath::Resolved(_, ref path)) = e.kind {
2333         let segments = &path.segments;
2334         if segments.len() == 1 {
2335             return Some(segments[0].ident.name);
2336         }
2337     };
2338     None
2339 }
2340
2341 fn check_infinite_loop<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, cond: &'tcx Expr<'_>, expr: &'tcx Expr<'_>) {
2342     if constant(cx, cx.tables, cond).is_some() {
2343         // A pure constant condition (e.g., `while false`) is not linted.
2344         return;
2345     }
2346
2347     let mut var_visitor = VarCollectorVisitor {
2348         cx,
2349         ids: FxHashSet::default(),
2350         def_ids: FxHashMap::default(),
2351         skip: false,
2352     };
2353     var_visitor.visit_expr(cond);
2354     if var_visitor.skip {
2355         return;
2356     }
2357     let used_in_condition = &var_visitor.ids;
2358     let no_cond_variable_mutated = if let Some(used_mutably) = mutated_variables(expr, cx) {
2359         used_in_condition.is_disjoint(&used_mutably)
2360     } else {
2361         return;
2362     };
2363     let mutable_static_in_cond = var_visitor.def_ids.iter().any(|(_, v)| *v);
2364
2365     let mut has_break_or_return_visitor = HasBreakOrReturnVisitor {
2366         has_break_or_return: false,
2367     };
2368     has_break_or_return_visitor.visit_expr(expr);
2369     let has_break_or_return = has_break_or_return_visitor.has_break_or_return;
2370
2371     if no_cond_variable_mutated && !mutable_static_in_cond {
2372         span_lint_and_then(
2373             cx,
2374             WHILE_IMMUTABLE_CONDITION,
2375             cond.span,
2376             "variables in the condition are not mutated in the loop body",
2377             |diag| {
2378                 diag.note("this may lead to an infinite or to a never running loop");
2379
2380                 if has_break_or_return {
2381                     diag.note("this loop contains `return`s or `break`s");
2382                     diag.help("rewrite it as `if cond { loop { } }`");
2383                 }
2384             },
2385         );
2386     }
2387 }
2388
2389 struct HasBreakOrReturnVisitor {
2390     has_break_or_return: bool,
2391 }
2392
2393 impl<'a, 'tcx> Visitor<'tcx> for HasBreakOrReturnVisitor {
2394     type Map = Map<'tcx>;
2395
2396     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
2397         if self.has_break_or_return {
2398             return;
2399         }
2400
2401         match expr.kind {
2402             ExprKind::Ret(_) | ExprKind::Break(_, _) => {
2403                 self.has_break_or_return = true;
2404                 return;
2405             },
2406             _ => {},
2407         }
2408
2409         walk_expr(self, expr);
2410     }
2411
2412     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
2413         NestedVisitorMap::None
2414     }
2415 }
2416
2417 /// Collects the set of variables in an expression
2418 /// Stops analysis if a function call is found
2419 /// Note: In some cases such as `self`, there are no mutable annotation,
2420 /// All variables definition IDs are collected
2421 struct VarCollectorVisitor<'a, 'tcx> {
2422     cx: &'a LateContext<'a, 'tcx>,
2423     ids: FxHashSet<HirId>,
2424     def_ids: FxHashMap<def_id::DefId, bool>,
2425     skip: bool,
2426 }
2427
2428 impl<'a, 'tcx> VarCollectorVisitor<'a, 'tcx> {
2429     fn insert_def_id(&mut self, ex: &'tcx Expr<'_>) {
2430         if_chain! {
2431             if let ExprKind::Path(ref qpath) = ex.kind;
2432             if let QPath::Resolved(None, _) = *qpath;
2433             let res = qpath_res(self.cx, qpath, ex.hir_id);
2434             then {
2435                 match res {
2436                     Res::Local(hir_id) => {
2437                         self.ids.insert(hir_id);
2438                     },
2439                     Res::Def(DefKind::Static, def_id) => {
2440                         let mutable = self.cx.tcx.is_mutable_static(def_id);
2441                         self.def_ids.insert(def_id, mutable);
2442                     },
2443                     _ => {},
2444                 }
2445             }
2446         }
2447     }
2448 }
2449
2450 impl<'a, 'tcx> Visitor<'tcx> for VarCollectorVisitor<'a, 'tcx> {
2451     type Map = Map<'tcx>;
2452
2453     fn visit_expr(&mut self, ex: &'tcx Expr<'_>) {
2454         match ex.kind {
2455             ExprKind::Path(_) => self.insert_def_id(ex),
2456             // If there is any function/method call… we just stop analysis
2457             ExprKind::Call(..) | ExprKind::MethodCall(..) => self.skip = true,
2458
2459             _ => walk_expr(self, ex),
2460         }
2461     }
2462
2463     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
2464         NestedVisitorMap::None
2465     }
2466 }
2467
2468 const NEEDLESS_COLLECT_MSG: &str = "avoid using `collect()` when not needed";
2469
2470 fn check_needless_collect<'a, 'tcx>(expr: &'tcx Expr<'_>, cx: &LateContext<'a, 'tcx>) {
2471     if_chain! {
2472         if let ExprKind::MethodCall(ref method, _, ref args) = expr.kind;
2473         if let ExprKind::MethodCall(ref chain_method, _, _) = args[0].kind;
2474         if chain_method.ident.name == sym!(collect) && match_trait_method(cx, &args[0], &paths::ITERATOR);
2475         if let Some(ref generic_args) = chain_method.args;
2476         if let Some(GenericArg::Type(ref ty)) = generic_args.args.get(0);
2477         then {
2478             let ty = cx.tables.node_type(ty.hir_id);
2479             if is_type_diagnostic_item(cx, ty, sym!(vec_type)) ||
2480                 is_type_diagnostic_item(cx, ty, sym!(vecdeque_type)) ||
2481                 match_type(cx, ty, &paths::BTREEMAP) ||
2482                 is_type_diagnostic_item(cx, ty, sym!(hashmap_type)) {
2483                 if method.ident.name == sym!(len) {
2484                     let span = shorten_needless_collect_span(expr);
2485                     span_lint_and_sugg(
2486                         cx,
2487                         NEEDLESS_COLLECT,
2488                         span,
2489                         NEEDLESS_COLLECT_MSG,
2490                         "replace with",
2491                         ".count()".to_string(),
2492                         Applicability::MachineApplicable,
2493                     );
2494                 }
2495                 if method.ident.name == sym!(is_empty) {
2496                     let span = shorten_needless_collect_span(expr);
2497                     span_lint_and_sugg(
2498                         cx,
2499                         NEEDLESS_COLLECT,
2500                         span,
2501                         NEEDLESS_COLLECT_MSG,
2502                         "replace with",
2503                         ".next().is_none()".to_string(),
2504                         Applicability::MachineApplicable,
2505                     );
2506                 }
2507                 if method.ident.name == sym!(contains) {
2508                     let contains_arg = snippet(cx, args[1].span, "??");
2509                     let span = shorten_needless_collect_span(expr);
2510                     span_lint_and_then(
2511                         cx,
2512                         NEEDLESS_COLLECT,
2513                         span,
2514                         NEEDLESS_COLLECT_MSG,
2515                         |diag| {
2516                             let (arg, pred) = if contains_arg.starts_with('&') {
2517                                 ("x", &contains_arg[1..])
2518                             } else {
2519                                 ("&x", &*contains_arg)
2520                             };
2521                             diag.span_suggestion(
2522                                 span,
2523                                 "replace with",
2524                                 format!(
2525                                     ".any(|{}| x == {})",
2526                                     arg, pred
2527                                 ),
2528                                 Applicability::MachineApplicable,
2529                             );
2530                         }
2531                     );
2532                 }
2533             }
2534         }
2535     }
2536 }
2537
2538 fn shorten_needless_collect_span(expr: &Expr<'_>) -> Span {
2539     if_chain! {
2540         if let ExprKind::MethodCall(_, _, ref args) = expr.kind;
2541         if let ExprKind::MethodCall(_, ref span, _) = args[0].kind;
2542         then {
2543             return expr.span.with_lo(span.lo() - BytePos(1));
2544         }
2545     }
2546     unreachable!()
2547 }