clippy_lints/src/loops.rs

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