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     let is_manual_memcpy_triggered = detect_manual_memcpy(cx, pat, arg, body, expr);
 772     if !is_manual_memcpy_triggered {
 773         check_for_loop_range(cx, pat, arg, body, expr);
 774         check_for_loop_explicit_counter(cx, pat, arg, body, expr);
 775     }
 776     check_for_loop_arg(cx, pat, arg, expr);
 777     check_for_loop_over_map_kv(cx, pat, arg, body, expr);
 778     check_for_mut_range_bound(cx, arg, body);
 779     detect_same_item_push(cx, pat, arg, body, expr);
 780 }
 781
 782 // this function assumes the given expression is a `for` loop.
 783 fn get_span_of_entire_for_loop(expr: &Expr<'_>) -> Span {
 784     // for some reason this is the only way to get the `Span`
 785     // of the entire `for` loop
 786     if let ExprKind::Match(_, arms, _) = &expr.kind {
 787         arms[0].body.span
 788     } else {
 789         unreachable!()
 790     }
 791 }
 792
 793 fn same_var<'tcx>(cx: &LateContext<'tcx>, expr: &Expr<'_>, var: HirId) -> bool {
 794     if_chain! {
 795         if let ExprKind::Path(qpath) = &expr.kind;
 796         if let QPath::Resolved(None, path) = qpath;
 797         if path.segments.len() == 1;
 798         if let Res::Local(local_id) = qpath_res(cx, qpath, expr.hir_id);
 799         then {
 800             // our variable!
 801             local_id == var
 802         } else {
 803             false
 804         }
 805     }
 806 }
 807
 808 /// a wrapper of `Sugg`. Besides what `Sugg` do, this removes unnecessary `0`;
 809 /// and also, it avoids subtracting a variable from the same one by replacing it with `0`.
 810 /// it exists for the convenience of the overloaded operators while normal functions can do the
 811 /// same.
 812 #[derive(Clone)]
 813 struct MinifyingSugg<'a>(Sugg<'a>);
 814
 815 impl<'a> MinifyingSugg<'a> {
 816     fn as_str(&self) -> &str {
 817         let Sugg::NonParen(s) | Sugg::MaybeParen(s) | Sugg::BinOp(_, s) = &self.0;
 818         s.as_ref()
 819     }
 820
 821     fn into_sugg(self) -> Sugg<'a> {
 822         self.0
 823     }
 824 }
 825
 826 impl<'a> From<Sugg<'a>> for MinifyingSugg<'a> {
 827     fn from(sugg: Sugg<'a>) -> Self {
 828         Self(sugg)
 829     }
 830 }
 831
 832 impl std::ops::Add for &MinifyingSugg<'static> {
 833     type Output = MinifyingSugg<'static>;
 834     fn add(self, rhs: &MinifyingSugg<'static>) -> MinifyingSugg<'static> {
 835         match (self.as_str(), rhs.as_str()) {
 836             ("0", _) => rhs.clone(),
 837             (_, "0") => self.clone(),
 838             (_, _) => (&self.0 + &rhs.0).into(),
 839         }
 840     }
 841 }
 842
 843 impl std::ops::Sub for &MinifyingSugg<'static> {
 844     type Output = MinifyingSugg<'static>;
 845     fn sub(self, rhs: &MinifyingSugg<'static>) -> MinifyingSugg<'static> {
 846         match (self.as_str(), rhs.as_str()) {
 847             (_, "0") => self.clone(),
 848             ("0", _) => (-rhs.0.clone()).into(),
 849             (x, y) if x == y => sugg::ZERO.into(),
 850             (_, _) => (&self.0 - &rhs.0).into(),
 851         }
 852     }
 853 }
 854
 855 impl std::ops::Add<&MinifyingSugg<'static>> for MinifyingSugg<'static> {
 856     type Output = MinifyingSugg<'static>;
 857     fn add(self, rhs: &MinifyingSugg<'static>) -> MinifyingSugg<'static> {
 858         match (self.as_str(), rhs.as_str()) {
 859             ("0", _) => rhs.clone(),
 860             (_, "0") => self,
 861             (_, _) => (self.0 + &rhs.0).into(),
 862         }
 863     }
 864 }
 865
 866 impl std::ops::Sub<&MinifyingSugg<'static>> for MinifyingSugg<'static> {
 867     type Output = MinifyingSugg<'static>;
 868     fn sub(self, rhs: &MinifyingSugg<'static>) -> MinifyingSugg<'static> {
 869         match (self.as_str(), rhs.as_str()) {
 870             (_, "0") => self,
 871             ("0", _) => (-rhs.0.clone()).into(),
 872             (x, y) if x == y => sugg::ZERO.into(),
 873             (_, _) => (self.0 - &rhs.0).into(),
 874         }
 875     }
 876 }
 877
 878 /// a wrapper around `MinifyingSugg`, which carries a operator like currying
 879 /// so that the suggested code become more efficient (e.g. `foo + -bar` `foo - bar`).
 880 struct Offset {
 881     value: MinifyingSugg<'static>,
 882     sign: OffsetSign,
 883 }
 884
 885 #[derive(Clone, Copy)]
 886 enum OffsetSign {
 887     Positive,
 888     Negative,
 889 }
 890
 891 impl Offset {
 892     fn negative(value: Sugg<'static>) -> Self {
 893         Self {
 894             value: value.into(),
 895             sign: OffsetSign::Negative,
 896         }
 897     }
 898
 899     fn positive(value: Sugg<'static>) -> Self {
 900         Self {
 901             value: value.into(),
 902             sign: OffsetSign::Positive,
 903         }
 904     }
 905
 906     fn empty() -> Self {
 907         Self::positive(sugg::ZERO)
 908     }
 909 }
 910
 911 fn apply_offset(lhs: &MinifyingSugg<'static>, rhs: &Offset) -> MinifyingSugg<'static> {
 912     match rhs.sign {
 913         OffsetSign::Positive => lhs + &rhs.value,
 914         OffsetSign::Negative => lhs - &rhs.value,
 915     }
 916 }
 917
 918 #[derive(Debug, Clone, Copy)]
 919 enum StartKind<'hir> {
 920     Range,
 921     Counter { initializer: &'hir Expr<'hir> },
 922 }
 923
 924 struct IndexExpr<'hir> {
 925     base: &'hir Expr<'hir>,
 926     idx: StartKind<'hir>,
 927     idx_offset: Offset,
 928 }
 929
 930 struct Start<'hir> {
 931     id: HirId,
 932     kind: StartKind<'hir>,
 933 }
 934
 935 fn is_slice_like<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'_>) -> bool {
 936     let is_slice = match ty.kind() {
 937         ty::Ref(_, subty, _) => is_slice_like(cx, subty),
 938         ty::Slice(..) | ty::Array(..) => true,
 939         _ => false,
 940     };
 941
 942     is_slice || is_type_diagnostic_item(cx, ty, sym!(vec_type)) || is_type_diagnostic_item(cx, ty, sym!(vecdeque_type))
 943 }
 944
 945 fn fetch_cloned_expr<'tcx>(expr: &'tcx Expr<'tcx>) -> &'tcx Expr<'tcx> {
 946     if_chain! {
 947         if let ExprKind::MethodCall(method, _, args, _) = expr.kind;
 948         if method.ident.name == sym!(clone);
 949         if args.len() == 1;
 950         if let Some(arg) = args.get(0);
 951         then { arg } else { expr }
 952     }
 953 }
 954
 955 fn get_details_from_idx<'tcx>(
 956     cx: &LateContext<'tcx>,
 957     idx: &Expr<'_>,
 958     starts: &[Start<'tcx>],
 959 ) -> Option<(StartKind<'tcx>, Offset)> {
 960     fn get_start<'tcx>(cx: &LateContext<'tcx>, e: &Expr<'_>, starts: &[Start<'tcx>]) -> Option<StartKind<'tcx>> {
 961         starts.iter().find_map(|start| {
 962             if same_var(cx, e, start.id) {
 963                 Some(start.kind)
 964             } else {
 965                 None
 966             }
 967         })
 968     }
 969
 970     fn get_offset<'tcx>(cx: &LateContext<'tcx>, e: &Expr<'_>, starts: &[Start<'tcx>]) -> Option<Sugg<'static>> {
 971         match &e.kind {
 972             ExprKind::Lit(l) => match l.node {
 973                 ast::LitKind::Int(x, _ty) => Some(Sugg::NonParen(x.to_string().into())),
 974                 _ => None,
 975             },
 976             ExprKind::Path(..) if get_start(cx, e, starts).is_none() => Some(Sugg::hir(cx, e, "???")),
 977             _ => None,
 978         }
 979     }
 980
 981     match idx.kind {
 982         ExprKind::Binary(op, lhs, rhs) => match op.node {
 983             BinOpKind::Add => {
 984                 let offset_opt = get_start(cx, lhs, starts)
 985                     .and_then(|s| get_offset(cx, rhs, starts).map(|o| (s, o)))
 986                     .or_else(|| get_start(cx, rhs, starts).and_then(|s| get_offset(cx, lhs, starts).map(|o| (s, o))));
 987
 988                 offset_opt.map(|(s, o)| (s, Offset::positive(o)))
 989             },
 990             BinOpKind::Sub => {
 991                 get_start(cx, lhs, starts).and_then(|s| get_offset(cx, rhs, starts).map(|o| (s, Offset::negative(o))))
 992             },
 993             _ => None,
 994         },
 995         ExprKind::Path(..) => get_start(cx, idx, starts).map(|s| (s, Offset::empty())),
 996         _ => None,
 997     }
 998 }
 999
1000 fn get_assignment<'tcx>(e: &'tcx Expr<'tcx>) -> Option<(&'tcx Expr<'tcx>, &'tcx Expr<'tcx>)> {
1001     if let ExprKind::Assign(lhs, rhs, _) = e.kind {
1002         Some((lhs, rhs))
1003     } else {
1004         None
1005     }
1006 }
1007
1008 fn get_assignments<'a: 'c, 'tcx: 'c, 'c>(
1009     cx: &'a LateContext<'tcx>,
1010     Block { stmts, expr, .. }: &'tcx Block<'tcx>,
1011     loop_counters: &'c [Start<'tcx>],
1012 ) -> impl Iterator<Item = Option<(&'tcx Expr<'tcx>, &'tcx Expr<'tcx>)>> + 'c {
1013     stmts
1014         .iter()
1015         .filter_map(move |stmt| match stmt.kind {
1016             StmtKind::Local(..) | StmtKind::Item(..) => None,
1017             StmtKind::Expr(e) | StmtKind::Semi(e) => Some(e),
1018         })
1019         .chain((*expr).into_iter())
1020         .filter(move |e| {
1021             if let ExprKind::AssignOp(_, place, _) = e.kind {
1022                 !loop_counters
1023                     .iter()
1024                     // skip StartKind::Range
1025                     .skip(1)
1026                     .any(|counter| same_var(cx, place, counter.id))
1027             } else {
1028                 true
1029             }
1030         })
1031         .map(get_assignment)
1032 }
1033
1034 fn get_loop_counters<'a, 'tcx>(
1035     cx: &'a LateContext<'tcx>,
1036     body: &'tcx Block<'tcx>,
1037     expr: &'tcx Expr<'_>,
1038 ) -> Option<impl Iterator<Item = Start<'tcx>> + 'a> {
1039     // Look for variables that are incremented once per loop iteration.
1040     let mut increment_visitor = IncrementVisitor::new(cx);
1041     walk_block(&mut increment_visitor, body);
1042
1043     // For each candidate, check the parent block to see if
1044     // it's initialized to zero at the start of the loop.
1045     get_enclosing_block(&cx, expr.hir_id).and_then(|block| {
1046         increment_visitor
1047             .into_results()
1048             .filter_map(move |var_id| {
1049                 let mut initialize_visitor = InitializeVisitor::new(cx, expr, var_id);
1050                 walk_block(&mut initialize_visitor, block);
1051
1052                 initialize_visitor.get_result().map(|(_, initializer)| Start {
1053                     id: var_id,
1054                     kind: StartKind::Counter { initializer },
1055                 })
1056             })
1057             .into()
1058     })
1059 }
1060
1061 fn build_manual_memcpy_suggestion<'tcx>(
1062     cx: &LateContext<'tcx>,
1063     start: &Expr<'_>,
1064     end: &Expr<'_>,
1065     limits: ast::RangeLimits,
1066     dst: &IndexExpr<'_>,
1067     src: &IndexExpr<'_>,
1068 ) -> String {
1069     fn print_offset(offset: MinifyingSugg<'static>) -> MinifyingSugg<'static> {
1070         if offset.as_str() == "0" {
1071             sugg::EMPTY.into()
1072         } else {
1073             offset
1074         }
1075     }
1076
1077     let print_limit =
1078         |end: &Expr<'_>, end_str: &str, base: &Expr<'_>, sugg: MinifyingSugg<'static>| -> MinifyingSugg<'static> {
1079             if_chain! {
1080                 if let ExprKind::MethodCall(method, _, len_args, _) = end.kind;
1081                 if method.ident.name == sym!(len);
1082                 if len_args.len() == 1;
1083                 if let Some(arg) = len_args.get(0);
1084                 if var_def_id(cx, arg) == var_def_id(cx, base);
1085                 then {
1086                     if sugg.as_str() == end_str {
1087                         sugg::EMPTY.into()
1088                     } else {
1089                         sugg
1090                     }
1091                 } else {
1092                     match limits {
1093                         ast::RangeLimits::Closed => {
1094                             sugg + &sugg::ONE.into()
1095                         },
1096                         ast::RangeLimits::HalfOpen => sugg,
1097                     }
1098                 }
1099             }
1100         };
1101
1102     let start_str = Sugg::hir(cx, start, "").into();
1103     let end_str: MinifyingSugg<'_> = Sugg::hir(cx, end, "").into();
1104
1105     let print_offset_and_limit = |idx_expr: &IndexExpr<'_>| match idx_expr.idx {
1106         StartKind::Range => (
1107             print_offset(apply_offset(&start_str, &idx_expr.idx_offset)).into_sugg(),
1108             print_limit(
1109                 end,
1110                 end_str.as_str(),
1111                 idx_expr.base,
1112                 apply_offset(&end_str, &idx_expr.idx_offset),
1113             )
1114             .into_sugg(),
1115         ),
1116         StartKind::Counter { initializer } => {
1117             let counter_start = Sugg::hir(cx, initializer, "").into();
1118             (
1119                 print_offset(apply_offset(&counter_start, &idx_expr.idx_offset)).into_sugg(),
1120                 print_limit(
1121                     end,
1122                     end_str.as_str(),
1123                     idx_expr.base,
1124                     apply_offset(&end_str, &idx_expr.idx_offset) + &counter_start - &start_str,
1125                 )
1126                 .into_sugg(),
1127             )
1128         },
1129     };
1130
1131     let (dst_offset, dst_limit) = print_offset_and_limit(&dst);
1132     let (src_offset, src_limit) = print_offset_and_limit(&src);
1133
1134     let dst_base_str = snippet(cx, dst.base.span, "???");
1135     let src_base_str = snippet(cx, src.base.span, "???");
1136
1137     let dst = if dst_offset == sugg::EMPTY && dst_limit == sugg::EMPTY {
1138         dst_base_str
1139     } else {
1140         format!(
1141             "{}[{}..{}]",
1142             dst_base_str,
1143             dst_offset.maybe_par(),
1144             dst_limit.maybe_par()
1145         )
1146         .into()
1147     };
1148
1149     format!(
1150         "{}.clone_from_slice(&{}[{}..{}]);",
1151         dst,
1152         src_base_str,
1153         src_offset.maybe_par(),
1154         src_limit.maybe_par()
1155     )
1156 }
1157
1158 /// Checks for for loops that sequentially copy items from one slice-like
1159 /// object to another.
1160 fn detect_manual_memcpy<'tcx>(
1161     cx: &LateContext<'tcx>,
1162     pat: &'tcx Pat<'_>,
1163     arg: &'tcx Expr<'_>,
1164     body: &'tcx Expr<'_>,
1165     expr: &'tcx Expr<'_>,
1166 ) -> bool {
1167     if let Some(higher::Range {
1168         start: Some(start),
1169         end: Some(end),
1170         limits,
1171     }) = higher::range(arg)
1172     {
1173         // the var must be a single name
1174         if let PatKind::Binding(_, canonical_id, _, _) = pat.kind {
1175             let mut starts = vec![Start {
1176                 id: canonical_id,
1177                 kind: StartKind::Range,
1178             }];
1179
1180             // This is one of few ways to return different iterators
1181             // derived from: https://stackoverflow.com/questions/29760668/conditionally-iterate-over-one-of-several-possible-iterators/52064434#52064434
1182             let mut iter_a = None;
1183             let mut iter_b = None;
1184
1185             if let ExprKind::Block(block, _) = body.kind {
1186                 if let Some(loop_counters) = get_loop_counters(cx, block, expr) {
1187                     starts.extend(loop_counters);
1188                 }
1189                 iter_a = Some(get_assignments(cx, block, &starts));
1190             } else {
1191                 iter_b = Some(get_assignment(body));
1192             }
1193
1194             // The only statements in the for loops can be indexed assignments from
1195             // indexed retrievals.
1196             let assignments = iter_a.into_iter().flatten().chain(iter_b.into_iter());
1197
1198             let big_sugg = assignments
1199                 .map(|o| {
1200                     o.and_then(|(lhs, rhs)| {
1201                         let rhs = fetch_cloned_expr(rhs);
1202                         if_chain! {
1203                             if let ExprKind::Index(base_left, idx_left) = lhs.kind;
1204                             if let ExprKind::Index(base_right, idx_right) = rhs.kind;
1205                             if is_slice_like(cx, cx.typeck_results().expr_ty(base_left))
1206                                 && is_slice_like(cx, cx.typeck_results().expr_ty(base_right));
1207                             if let Some((start_left, offset_left)) = get_details_from_idx(cx, &idx_left, &starts);
1208                             if let Some((start_right, offset_right)) = get_details_from_idx(cx, &idx_right, &starts);
1209
1210                             // Source and destination must be different
1211                             if var_def_id(cx, base_left) != var_def_id(cx, base_right);
1212                             then {
1213                                 Some((IndexExpr { base: base_left, idx: start_left, idx_offset: offset_left },
1214                                     IndexExpr { base: base_right, idx: start_right, idx_offset: offset_right }))
1215                             } else {
1216                                 None
1217                             }
1218                         }
1219                     })
1220                 })
1221                 .map(|o| o.map(|(dst, src)| build_manual_memcpy_suggestion(cx, start, end, limits, &dst, &src)))
1222                 .collect::<Option<Vec<_>>>()
1223                 .filter(|v| !v.is_empty())
1224                 .map(|v| v.join("\n    "));
1225
1226             if let Some(big_sugg) = big_sugg {
1227                 span_lint_and_sugg(
1228                     cx,
1229                     MANUAL_MEMCPY,
1230                     get_span_of_entire_for_loop(expr),
1231                     "it looks like you're manually copying between slices",
1232                     "try replacing the loop by",
1233                     big_sugg,
1234                     Applicability::Unspecified,
1235                 );
1236                 return true;
1237             }
1238         }
1239     }
1240     false
1241 }
1242
1243 // Scans the body of the for loop and determines whether lint should be given
1244 struct SameItemPushVisitor<'a, 'tcx> {
1245     should_lint: bool,
1246     // this field holds the last vec push operation visited, which should be the only push seen
1247     vec_push: Option<(&'tcx Expr<'tcx>, &'tcx Expr<'tcx>)>,
1248     cx: &'a LateContext<'tcx>,
1249 }
1250
1251 impl<'a, 'tcx> Visitor<'tcx> for SameItemPushVisitor<'a, 'tcx> {
1252     type Map = Map<'tcx>;
1253
1254     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
1255         match &expr.kind {
1256             // Non-determinism may occur ... don't give a lint
1257             ExprKind::Loop(_, _, _) | ExprKind::Match(_, _, _) => self.should_lint = false,
1258             ExprKind::Block(block, _) => self.visit_block(block),
1259             _ => {},
1260         }
1261     }
1262
1263     fn visit_block(&mut self, b: &'tcx Block<'_>) {
1264         for stmt in b.stmts.iter() {
1265             self.visit_stmt(stmt);
1266         }
1267     }
1268
1269     fn visit_stmt(&mut self, s: &'tcx Stmt<'_>) {
1270         let vec_push_option = get_vec_push(self.cx, s);
1271         if vec_push_option.is_none() {
1272             // Current statement is not a push so visit inside
1273             match &s.kind {
1274                 StmtKind::Expr(expr) | StmtKind::Semi(expr) => self.visit_expr(&expr),
1275                 _ => {},
1276             }
1277         } else {
1278             // Current statement is a push ...check whether another
1279             // push had been previously done
1280             if self.vec_push.is_none() {
1281                 self.vec_push = vec_push_option;
1282             } else {
1283                 // There are multiple pushes ... don't lint
1284                 self.should_lint = false;
1285             }
1286         }
1287     }
1288
1289     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
1290         NestedVisitorMap::None
1291     }
1292 }
1293
1294 // Given some statement, determine if that statement is a push on a Vec. If it is, return
1295 // the Vec being pushed into and the item being pushed
1296 fn get_vec_push<'tcx>(cx: &LateContext<'tcx>, stmt: &'tcx Stmt<'_>) -> Option<(&'tcx Expr<'tcx>, &'tcx Expr<'tcx>)> {
1297     if_chain! {
1298             // Extract method being called
1299             if let StmtKind::Semi(semi_stmt) = &stmt.kind;
1300             if let ExprKind::MethodCall(path, _, args, _) = &semi_stmt.kind;
1301             // Figure out the parameters for the method call
1302             if let Some(self_expr) = args.get(0);
1303             if let Some(pushed_item) = args.get(1);
1304             // Check that the method being called is push() on a Vec
1305             if is_type_diagnostic_item(cx, cx.typeck_results().expr_ty(self_expr), sym!(vec_type));
1306             if path.ident.name.as_str() == "push";
1307             then {
1308                 return Some((self_expr, pushed_item))
1309             }
1310     }
1311     None
1312 }
1313
1314 /// Detects for loop pushing the same item into a Vec
1315 fn detect_same_item_push<'tcx>(
1316     cx: &LateContext<'tcx>,
1317     pat: &'tcx Pat<'_>,
1318     _: &'tcx Expr<'_>,
1319     body: &'tcx Expr<'_>,
1320     _: &'tcx Expr<'_>,
1321 ) {
1322     fn emit_lint(cx: &LateContext<'_>, vec: &Expr<'_>, pushed_item: &Expr<'_>) {
1323         let vec_str = snippet_with_macro_callsite(cx, vec.span, "");
1324         let item_str = snippet_with_macro_callsite(cx, pushed_item.span, "");
1325
1326         span_lint_and_help(
1327             cx,
1328             SAME_ITEM_PUSH,
1329             vec.span,
1330             "it looks like the same item is being pushed into this Vec",
1331             None,
1332             &format!(
1333                 "try using vec![{};SIZE] or {}.resize(NEW_SIZE, {})",
1334                 item_str, vec_str, item_str
1335             ),
1336         )
1337     }
1338
1339     if !matches!(pat.kind, PatKind::Wild) {
1340         return;
1341     }
1342
1343     // Determine whether it is safe to lint the body
1344     let mut same_item_push_visitor = SameItemPushVisitor {
1345         should_lint: true,
1346         vec_push: None,
1347         cx,
1348     };
1349     walk_expr(&mut same_item_push_visitor, body);
1350     if same_item_push_visitor.should_lint {
1351         if let Some((vec, pushed_item)) = same_item_push_visitor.vec_push {
1352             let vec_ty = cx.typeck_results().expr_ty(vec);
1353             let ty = vec_ty.walk().nth(1).unwrap().expect_ty();
1354             if cx
1355                 .tcx
1356                 .lang_items()
1357                 .clone_trait()
1358                 .map_or(false, |id| implements_trait(cx, ty, id, &[]))
1359             {
1360                 // Make sure that the push does not involve possibly mutating values
1361                 match pushed_item.kind {
1362                     ExprKind::Path(ref qpath) => {
1363                         match qpath_res(cx, qpath, pushed_item.hir_id) {
1364                             // immutable bindings that are initialized with literal or constant
1365                             Res::Local(hir_id) => {
1366                                 if_chain! {
1367                                     let node = cx.tcx.hir().get(hir_id);
1368                                     if let Node::Binding(pat) = node;
1369                                     if let PatKind::Binding(bind_ann, ..) = pat.kind;
1370                                     if !matches!(bind_ann, BindingAnnotation::RefMut | BindingAnnotation::Mutable);
1371                                     let parent_node = cx.tcx.hir().get_parent_node(hir_id);
1372                                     if let Some(Node::Local(parent_let_expr)) = cx.tcx.hir().find(parent_node);
1373                                     if let Some(init) = parent_let_expr.init;
1374                                     then {
1375                                         match init.kind {
1376                                             // immutable bindings that are initialized with literal
1377                                             ExprKind::Lit(..) => emit_lint(cx, vec, pushed_item),
1378                                             // immutable bindings that are initialized with constant
1379                                             ExprKind::Path(ref path) => {
1380                                                 if let Res::Def(DefKind::Const, ..) = qpath_res(cx, path, init.hir_id) {
1381                                                     emit_lint(cx, vec, pushed_item);
1382                                                 }
1383                                             }
1384                                             _ => {},
1385                                         }
1386                                     }
1387                                 }
1388                             },
1389                             // constant
1390                             Res::Def(DefKind::Const, ..) => emit_lint(cx, vec, pushed_item),
1391                             _ => {},
1392                         }
1393                     },
1394                     ExprKind::Lit(..) => emit_lint(cx, vec, pushed_item),
1395                     _ => {},
1396                 }
1397             }
1398         }
1399     }
1400 }
1401
1402 /// Checks for looping over a range and then indexing a sequence with it.
1403 /// The iteratee must be a range literal.
1404 #[allow(clippy::too_many_lines)]
1405 fn check_for_loop_range<'tcx>(
1406     cx: &LateContext<'tcx>,
1407     pat: &'tcx Pat<'_>,
1408     arg: &'tcx Expr<'_>,
1409     body: &'tcx Expr<'_>,
1410     expr: &'tcx Expr<'_>,
1411 ) {
1412     if let Some(higher::Range {
1413         start: Some(start),
1414         ref end,
1415         limits,
1416     }) = higher::range(arg)
1417     {
1418         // the var must be a single name
1419         if let PatKind::Binding(_, canonical_id, ident, _) = pat.kind {
1420             let mut visitor = VarVisitor {
1421                 cx,
1422                 var: canonical_id,
1423                 indexed_mut: FxHashSet::default(),
1424                 indexed_indirectly: FxHashMap::default(),
1425                 indexed_directly: FxHashMap::default(),
1426                 referenced: FxHashSet::default(),
1427                 nonindex: false,
1428                 prefer_mutable: false,
1429             };
1430             walk_expr(&mut visitor, body);
1431
1432             // linting condition: we only indexed one variable, and indexed it directly
1433             if visitor.indexed_indirectly.is_empty() && visitor.indexed_directly.len() == 1 {
1434                 let (indexed, (indexed_extent, indexed_ty)) = visitor
1435                     .indexed_directly
1436                     .into_iter()
1437                     .next()
1438                     .expect("already checked that we have exactly 1 element");
1439
1440                 // ensure that the indexed variable was declared before the loop, see #601
1441                 if let Some(indexed_extent) = indexed_extent {
1442                     let parent_id = cx.tcx.hir().get_parent_item(expr.hir_id);
1443                     let parent_def_id = cx.tcx.hir().local_def_id(parent_id);
1444                     let region_scope_tree = cx.tcx.region_scope_tree(parent_def_id);
1445                     let pat_extent = region_scope_tree.var_scope(pat.hir_id.local_id);
1446                     if region_scope_tree.is_subscope_of(indexed_extent, pat_extent) {
1447                         return;
1448                     }
1449                 }
1450
1451                 // don't lint if the container that is indexed does not have .iter() method
1452                 let has_iter = has_iter_method(cx, indexed_ty);
1453                 if has_iter.is_none() {
1454                     return;
1455                 }
1456
1457                 // don't lint if the container that is indexed into is also used without
1458                 // indexing
1459                 if visitor.referenced.contains(&indexed) {
1460                     return;
1461                 }
1462
1463                 let starts_at_zero = is_integer_const(cx, start, 0);
1464
1465                 let skip = if starts_at_zero {
1466                     String::new()
1467                 } else {
1468                     format!(".skip({})", snippet(cx, start.span, ".."))
1469                 };
1470
1471                 let mut end_is_start_plus_val = false;
1472
1473                 let take = if let Some(end) = *end {
1474                     let mut take_expr = end;
1475
1476                     if let ExprKind::Binary(ref op, ref left, ref right) = end.kind {
1477                         if let BinOpKind::Add = op.node {
1478                             let start_equal_left = SpanlessEq::new(cx).eq_expr(start, left);
1479                             let start_equal_right = SpanlessEq::new(cx).eq_expr(start, right);
1480
1481                             if start_equal_left {
1482                                 take_expr = right;
1483                             } else if start_equal_right {
1484                                 take_expr = left;
1485                             }
1486
1487                             end_is_start_plus_val = start_equal_left | start_equal_right;
1488                         }
1489                     }
1490
1491                     if is_len_call(end, indexed) || is_end_eq_array_len(cx, end, limits, indexed_ty) {
1492                         String::new()
1493                     } else {
1494                         match limits {
1495                             ast::RangeLimits::Closed => {
1496                                 let take_expr = sugg::Sugg::hir(cx, take_expr, "<count>");
1497                                 format!(".take({})", take_expr + sugg::ONE)
1498                             },
1499                             ast::RangeLimits::HalfOpen => format!(".take({})", snippet(cx, take_expr.span, "..")),
1500                         }
1501                     }
1502                 } else {
1503                     String::new()
1504                 };
1505
1506                 let (ref_mut, method) = if visitor.indexed_mut.contains(&indexed) {
1507                     ("mut ", "iter_mut")
1508                 } else {
1509                     ("", "iter")
1510                 };
1511
1512                 let take_is_empty = take.is_empty();
1513                 let mut method_1 = take;
1514                 let mut method_2 = skip;
1515
1516                 if end_is_start_plus_val {
1517                     mem::swap(&mut method_1, &mut method_2);
1518                 }
1519
1520                 if visitor.nonindex {
1521                     span_lint_and_then(
1522                         cx,
1523                         NEEDLESS_RANGE_LOOP,
1524                         expr.span,
1525                         &format!("the loop variable `{}` is used to index `{}`", ident.name, indexed),
1526                         |diag| {
1527                             multispan_sugg(
1528                                 diag,
1529                                 "consider using an iterator",
1530                                 vec![
1531                                     (pat.span, format!("({}, <item>)", ident.name)),
1532                                     (
1533                                         arg.span,
1534                                         format!("{}.{}().enumerate(){}{}", indexed, method, method_1, method_2),
1535                                     ),
1536                                 ],
1537                             );
1538                         },
1539                     );
1540                 } else {
1541                     let repl = if starts_at_zero && take_is_empty {
1542                         format!("&{}{}", ref_mut, indexed)
1543                     } else {
1544                         format!("{}.{}(){}{}", indexed, method, method_1, method_2)
1545                     };
1546
1547                     span_lint_and_then(
1548                         cx,
1549                         NEEDLESS_RANGE_LOOP,
1550                         expr.span,
1551                         &format!(
1552                             "the loop variable `{}` is only used to index `{}`.",
1553                             ident.name, indexed
1554                         ),
1555                         |diag| {
1556                             multispan_sugg(
1557                                 diag,
1558                                 "consider using an iterator",
1559                                 vec![(pat.span, "<item>".to_string()), (arg.span, repl)],
1560                             );
1561                         },
1562                     );
1563                 }
1564             }
1565         }
1566     }
1567 }
1568
1569 fn is_len_call(expr: &Expr<'_>, var: Symbol) -> bool {
1570     if_chain! {
1571         if let ExprKind::MethodCall(ref method, _, ref len_args, _) = expr.kind;
1572         if len_args.len() == 1;
1573         if method.ident.name == sym!(len);
1574         if let ExprKind::Path(QPath::Resolved(_, ref path)) = len_args[0].kind;
1575         if path.segments.len() == 1;
1576         if path.segments[0].ident.name == var;
1577         then {
1578             return true;
1579         }
1580     }
1581
1582     false
1583 }
1584
1585 fn is_end_eq_array_len<'tcx>(
1586     cx: &LateContext<'tcx>,
1587     end: &Expr<'_>,
1588     limits: ast::RangeLimits,
1589     indexed_ty: Ty<'tcx>,
1590 ) -> bool {
1591     if_chain! {
1592         if let ExprKind::Lit(ref lit) = end.kind;
1593         if let ast::LitKind::Int(end_int, _) = lit.node;
1594         if let ty::Array(_, arr_len_const) = indexed_ty.kind();
1595         if let Some(arr_len) = arr_len_const.try_eval_usize(cx.tcx, cx.param_env);
1596         then {
1597             return match limits {
1598                 ast::RangeLimits::Closed => end_int + 1 >= arr_len.into(),
1599                 ast::RangeLimits::HalfOpen => end_int >= arr_len.into(),
1600             };
1601         }
1602     }
1603
1604     false
1605 }
1606
1607 fn lint_iter_method(cx: &LateContext<'_>, args: &[Expr<'_>], arg: &Expr<'_>, method_name: &str) {
1608     let mut applicability = Applicability::MachineApplicable;
1609     let object = snippet_with_applicability(cx, args[0].span, "_", &mut applicability);
1610     let muta = if method_name == "iter_mut" { "mut " } else { "" };
1611     span_lint_and_sugg(
1612         cx,
1613         EXPLICIT_ITER_LOOP,
1614         arg.span,
1615         "it is more concise to loop over references to containers instead of using explicit \
1616          iteration methods",
1617         "to write this more concisely, try",
1618         format!("&{}{}", muta, object),
1619         applicability,
1620     )
1621 }
1622
1623 fn check_for_loop_arg(cx: &LateContext<'_>, pat: &Pat<'_>, arg: &Expr<'_>, expr: &Expr<'_>) {
1624     let mut next_loop_linted = false; // whether or not ITER_NEXT_LOOP lint was used
1625     if let ExprKind::MethodCall(ref method, _, ref args, _) = arg.kind {
1626         // just the receiver, no arguments
1627         if args.len() == 1 {
1628             let method_name = &*method.ident.as_str();
1629             // check for looping over x.iter() or x.iter_mut(), could use &x or &mut x
1630             if method_name == "iter" || method_name == "iter_mut" {
1631                 if is_ref_iterable_type(cx, &args[0]) {
1632                     lint_iter_method(cx, args, arg, method_name);
1633                 }
1634             } else if method_name == "into_iter" && match_trait_method(cx, arg, &paths::INTO_ITERATOR) {
1635                 let receiver_ty = cx.typeck_results().expr_ty(&args[0]);
1636                 let receiver_ty_adjusted = cx.typeck_results().expr_ty_adjusted(&args[0]);
1637                 if TyS::same_type(receiver_ty, receiver_ty_adjusted) {
1638                     let mut applicability = Applicability::MachineApplicable;
1639                     let object = snippet_with_applicability(cx, args[0].span, "_", &mut applicability);
1640                     span_lint_and_sugg(
1641                         cx,
1642                         EXPLICIT_INTO_ITER_LOOP,
1643                         arg.span,
1644                         "it is more concise to loop over containers instead of using explicit \
1645                          iteration methods",
1646                         "to write this more concisely, try",
1647                         object.to_string(),
1648                         applicability,
1649                     );
1650                 } else {
1651                     let ref_receiver_ty = cx.tcx.mk_ref(
1652                         cx.tcx.lifetimes.re_erased,
1653                         ty::TypeAndMut {
1654                             ty: receiver_ty,
1655                             mutbl: Mutability::Not,
1656                         },
1657                     );
1658                     if TyS::same_type(receiver_ty_adjusted, ref_receiver_ty) {
1659                         lint_iter_method(cx, args, arg, method_name)
1660                     }
1661                 }
1662             } else if method_name == "next" && match_trait_method(cx, arg, &paths::ITERATOR) {
1663                 span_lint(
1664                     cx,
1665                     ITER_NEXT_LOOP,
1666                     expr.span,
1667                     "you are iterating over `Iterator::next()` which is an Option; this will compile but is \
1668                     probably not what you want",
1669                 );
1670                 next_loop_linted = true;
1671             }
1672         }
1673     }
1674     if !next_loop_linted {
1675         check_arg_type(cx, pat, arg);
1676     }
1677 }
1678
1679 /// Checks for `for` loops over `Option`s and `Result`s.
1680 fn check_arg_type(cx: &LateContext<'_>, pat: &Pat<'_>, arg: &Expr<'_>) {
1681     let ty = cx.typeck_results().expr_ty(arg);
1682     if is_type_diagnostic_item(cx, ty, sym!(option_type)) {
1683         span_lint_and_help(
1684             cx,
1685             FOR_LOOPS_OVER_FALLIBLES,
1686             arg.span,
1687             &format!(
1688                 "for loop over `{0}`, which is an `Option`. This is more readably written as an \
1689                 `if let` statement.",
1690                 snippet(cx, arg.span, "_")
1691             ),
1692             None,
1693             &format!(
1694                 "consider replacing `for {0} in {1}` with `if let Some({0}) = {1}`",
1695                 snippet(cx, pat.span, "_"),
1696                 snippet(cx, arg.span, "_")
1697             ),
1698         );
1699     } else if is_type_diagnostic_item(cx, ty, sym!(result_type)) {
1700         span_lint_and_help(
1701             cx,
1702             FOR_LOOPS_OVER_FALLIBLES,
1703             arg.span,
1704             &format!(
1705                 "for loop over `{0}`, which is a `Result`. This is more readably written as an \
1706                 `if let` statement.",
1707                 snippet(cx, arg.span, "_")
1708             ),
1709             None,
1710             &format!(
1711                 "consider replacing `for {0} in {1}` with `if let Ok({0}) = {1}`",
1712                 snippet(cx, pat.span, "_"),
1713                 snippet(cx, arg.span, "_")
1714             ),
1715         );
1716     }
1717 }
1718
1719 // To trigger the EXPLICIT_COUNTER_LOOP lint, a variable must be
1720 // incremented exactly once in the loop body, and initialized to zero
1721 // at the start of the loop.
1722 fn check_for_loop_explicit_counter<'tcx>(
1723     cx: &LateContext<'tcx>,
1724     pat: &'tcx Pat<'_>,
1725     arg: &'tcx Expr<'_>,
1726     body: &'tcx Expr<'_>,
1727     expr: &'tcx Expr<'_>,
1728 ) {
1729     // Look for variables that are incremented once per loop iteration.
1730     let mut increment_visitor = IncrementVisitor::new(cx);
1731     walk_expr(&mut increment_visitor, body);
1732
1733     // For each candidate, check the parent block to see if
1734     // it's initialized to zero at the start of the loop.
1735     if let Some(block) = get_enclosing_block(&cx, expr.hir_id) {
1736         for id in increment_visitor.into_results() {
1737             let mut initialize_visitor = InitializeVisitor::new(cx, expr, id);
1738             walk_block(&mut initialize_visitor, block);
1739
1740             if_chain! {
1741                 if let Some((name, initializer)) = initialize_visitor.get_result();
1742                 if is_integer_const(cx, initializer, 0);
1743                 then {
1744                     let mut applicability = Applicability::MachineApplicable;
1745
1746                     let for_span = get_span_of_entire_for_loop(expr);
1747
1748                     span_lint_and_sugg(
1749                         cx,
1750                         EXPLICIT_COUNTER_LOOP,
1751                         for_span.with_hi(arg.span.hi()),
1752                         &format!("the variable `{}` is used as a loop counter.", name),
1753                         "consider using",
1754                         format!(
1755                             "for ({}, {}) in {}.enumerate()",
1756                             name,
1757                             snippet_with_applicability(cx, pat.span, "item", &mut applicability),
1758                             make_iterator_snippet(cx, arg, &mut applicability),
1759                         ),
1760                         applicability,
1761                     );
1762                 }
1763             }
1764         }
1765     }
1766 }
1767
1768 /// If `arg` was the argument to a `for` loop, return the "cleanest" way of writing the
1769 /// actual `Iterator` that the loop uses.
1770 fn make_iterator_snippet(cx: &LateContext<'_>, arg: &Expr<'_>, applic_ref: &mut Applicability) -> String {
1771     let impls_iterator = get_trait_def_id(cx, &paths::ITERATOR).map_or(false, |id| {
1772         implements_trait(cx, cx.typeck_results().expr_ty(arg), id, &[])
1773     });
1774     if impls_iterator {
1775         format!(
1776             "{}",
1777             sugg::Sugg::hir_with_applicability(cx, arg, "_", applic_ref).maybe_par()
1778         )
1779     } else {
1780         // (&x).into_iter() ==> x.iter()
1781         // (&mut x).into_iter() ==> x.iter_mut()
1782         match &arg.kind {
1783             ExprKind::AddrOf(BorrowKind::Ref, mutability, arg_inner)
1784                 if has_iter_method(cx, cx.typeck_results().expr_ty(&arg_inner)).is_some() =>
1785             {
1786                 let meth_name = match mutability {
1787                     Mutability::Mut => "iter_mut",
1788                     Mutability::Not => "iter",
1789                 };
1790                 format!(
1791                     "{}.{}()",
1792                     sugg::Sugg::hir_with_applicability(cx, &arg_inner, "_", applic_ref).maybe_par(),
1793                     meth_name,
1794                 )
1795             }
1796             _ => format!(
1797                 "{}.into_iter()",
1798                 sugg::Sugg::hir_with_applicability(cx, arg, "_", applic_ref).maybe_par()
1799             ),
1800         }
1801     }
1802 }
1803
1804 /// Checks for the `FOR_KV_MAP` lint.
1805 fn check_for_loop_over_map_kv<'tcx>(
1806     cx: &LateContext<'tcx>,
1807     pat: &'tcx Pat<'_>,
1808     arg: &'tcx Expr<'_>,
1809     body: &'tcx Expr<'_>,
1810     expr: &'tcx Expr<'_>,
1811 ) {
1812     let pat_span = pat.span;
1813
1814     if let PatKind::Tuple(ref pat, _) = pat.kind {
1815         if pat.len() == 2 {
1816             let arg_span = arg.span;
1817             let (new_pat_span, kind, ty, mutbl) = match *cx.typeck_results().expr_ty(arg).kind() {
1818                 ty::Ref(_, ty, mutbl) => match (&pat[0].kind, &pat[1].kind) {
1819                     (key, _) if pat_is_wild(key, body) => (pat[1].span, "value", ty, mutbl),
1820                     (_, value) if pat_is_wild(value, body) => (pat[0].span, "key", ty, Mutability::Not),
1821                     _ => return,
1822                 },
1823                 _ => return,
1824             };
1825             let mutbl = match mutbl {
1826                 Mutability::Not => "",
1827                 Mutability::Mut => "_mut",
1828             };
1829             let arg = match arg.kind {
1830                 ExprKind::AddrOf(BorrowKind::Ref, _, ref expr) => &**expr,
1831                 _ => arg,
1832             };
1833
1834             if is_type_diagnostic_item(cx, ty, sym!(hashmap_type)) || match_type(cx, ty, &paths::BTREEMAP) {
1835                 span_lint_and_then(
1836                     cx,
1837                     FOR_KV_MAP,
1838                     expr.span,
1839                     &format!("you seem to want to iterate on a map's {}s", kind),
1840                     |diag| {
1841                         let map = sugg::Sugg::hir(cx, arg, "map");
1842                         multispan_sugg(
1843                             diag,
1844                             "use the corresponding method",
1845                             vec![
1846                                 (pat_span, snippet(cx, new_pat_span, kind).into_owned()),
1847                                 (arg_span, format!("{}.{}s{}()", map.maybe_par(), kind, mutbl)),
1848                             ],
1849                         );
1850                     },
1851                 );
1852             }
1853         }
1854     }
1855 }
1856
1857 struct MutatePairDelegate<'a, 'tcx> {
1858     cx: &'a LateContext<'tcx>,
1859     hir_id_low: Option<HirId>,
1860     hir_id_high: Option<HirId>,
1861     span_low: Option<Span>,
1862     span_high: Option<Span>,
1863 }
1864
1865 impl<'tcx> Delegate<'tcx> for MutatePairDelegate<'_, 'tcx> {
1866     fn consume(&mut self, _: &PlaceWithHirId<'tcx>, _: ConsumeMode) {}
1867
1868     fn borrow(&mut self, cmt: &PlaceWithHirId<'tcx>, bk: ty::BorrowKind) {
1869         if let ty::BorrowKind::MutBorrow = bk {
1870             if let PlaceBase::Local(id) = cmt.place.base {
1871                 if Some(id) == self.hir_id_low {
1872                     self.span_low = Some(self.cx.tcx.hir().span(cmt.hir_id))
1873                 }
1874                 if Some(id) == self.hir_id_high {
1875                     self.span_high = Some(self.cx.tcx.hir().span(cmt.hir_id))
1876                 }
1877             }
1878         }
1879     }
1880
1881     fn mutate(&mut self, cmt: &PlaceWithHirId<'tcx>) {
1882         if let PlaceBase::Local(id) = cmt.place.base {
1883             if Some(id) == self.hir_id_low {
1884                 self.span_low = Some(self.cx.tcx.hir().span(cmt.hir_id))
1885             }
1886             if Some(id) == self.hir_id_high {
1887                 self.span_high = Some(self.cx.tcx.hir().span(cmt.hir_id))
1888             }
1889         }
1890     }
1891 }
1892
1893 impl MutatePairDelegate<'_, '_> {
1894     fn mutation_span(&self) -> (Option<Span>, Option<Span>) {
1895         (self.span_low, self.span_high)
1896     }
1897 }
1898
1899 fn check_for_mut_range_bound(cx: &LateContext<'_>, arg: &Expr<'_>, body: &Expr<'_>) {
1900     if let Some(higher::Range {
1901         start: Some(start),
1902         end: Some(end),
1903         ..
1904     }) = higher::range(arg)
1905     {
1906         let mut_ids = vec![check_for_mutability(cx, start), check_for_mutability(cx, end)];
1907         if mut_ids[0].is_some() || mut_ids[1].is_some() {
1908             let (span_low, span_high) = check_for_mutation(cx, body, &mut_ids);
1909             mut_warn_with_span(cx, span_low);
1910             mut_warn_with_span(cx, span_high);
1911         }
1912     }
1913 }
1914
1915 fn mut_warn_with_span(cx: &LateContext<'_>, span: Option<Span>) {
1916     if let Some(sp) = span {
1917         span_lint(
1918             cx,
1919             MUT_RANGE_BOUND,
1920             sp,
1921             "attempt to mutate range bound within loop; note that the range of the loop is unchanged",
1922         );
1923     }
1924 }
1925
1926 fn check_for_mutability(cx: &LateContext<'_>, bound: &Expr<'_>) -> Option<HirId> {
1927     if_chain! {
1928         if let ExprKind::Path(ref qpath) = bound.kind;
1929         if let QPath::Resolved(None, _) = *qpath;
1930         then {
1931             let res = qpath_res(cx, qpath, bound.hir_id);
1932             if let Res::Local(hir_id) = res {
1933                 let node_str = cx.tcx.hir().get(hir_id);
1934                 if_chain! {
1935                     if let Node::Binding(pat) = node_str;
1936                     if let PatKind::Binding(bind_ann, ..) = pat.kind;
1937                     if let BindingAnnotation::Mutable = bind_ann;
1938                     then {
1939                         return Some(hir_id);
1940                     }
1941                 }
1942             }
1943         }
1944     }
1945     None
1946 }
1947
1948 fn check_for_mutation<'tcx>(
1949     cx: &LateContext<'tcx>,
1950     body: &Expr<'_>,
1951     bound_ids: &[Option<HirId>],
1952 ) -> (Option<Span>, Option<Span>) {
1953     let mut delegate = MutatePairDelegate {
1954         cx,
1955         hir_id_low: bound_ids[0],
1956         hir_id_high: bound_ids[1],
1957         span_low: None,
1958         span_high: None,
1959     };
1960     let def_id = body.hir_id.owner.to_def_id();
1961     cx.tcx.infer_ctxt().enter(|infcx| {
1962         ExprUseVisitor::new(
1963             &mut delegate,
1964             &infcx,
1965             def_id.expect_local(),
1966             cx.param_env,
1967             cx.typeck_results(),
1968         )
1969         .walk_expr(body);
1970     });
1971     delegate.mutation_span()
1972 }
1973
1974 /// Returns `true` if the pattern is a `PatWild` or an ident prefixed with `_`.
1975 fn pat_is_wild<'tcx>(pat: &'tcx PatKind<'_>, body: &'tcx Expr<'_>) -> bool {
1976     match *pat {
1977         PatKind::Wild => true,
1978         PatKind::Binding(.., ident, None) if ident.as_str().starts_with('_') => is_unused(&ident, body),
1979         _ => false,
1980     }
1981 }
1982
1983 struct LocalUsedVisitor<'a, 'tcx> {
1984     cx: &'a LateContext<'tcx>,
1985     local: HirId,
1986     used: bool,
1987 }
1988
1989 impl<'a, 'tcx> Visitor<'tcx> for LocalUsedVisitor<'a, 'tcx> {
1990     type Map = Map<'tcx>;
1991
1992     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
1993         if same_var(self.cx, expr, self.local) {
1994             self.used = true;
1995         } else {
1996             walk_expr(self, expr);
1997         }
1998     }
1999
2000     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
2001         NestedVisitorMap::None
2002     }
2003 }
2004
2005 struct VarVisitor<'a, 'tcx> {
2006     /// context reference
2007     cx: &'a LateContext<'tcx>,
2008     /// var name to look for as index
2009     var: HirId,
2010     /// indexed variables that are used mutably
2011     indexed_mut: FxHashSet<Symbol>,
2012     /// indirectly indexed variables (`v[(i + 4) % N]`), the extend is `None` for global
2013     indexed_indirectly: FxHashMap<Symbol, Option<region::Scope>>,
2014     /// subset of `indexed` of vars that are indexed directly: `v[i]`
2015     /// this will not contain cases like `v[calc_index(i)]` or `v[(i + 4) % N]`
2016     indexed_directly: FxHashMap<Symbol, (Option<region::Scope>, Ty<'tcx>)>,
2017     /// Any names that are used outside an index operation.
2018     /// Used to detect things like `&mut vec` used together with `vec[i]`
2019     referenced: FxHashSet<Symbol>,
2020     /// has the loop variable been used in expressions other than the index of
2021     /// an index op?
2022     nonindex: bool,
2023     /// Whether we are inside the `$` in `&mut $` or `$ = foo` or `$.bar`, where bar
2024     /// takes `&mut self`
2025     prefer_mutable: bool,
2026 }
2027
2028 impl<'a, 'tcx> VarVisitor<'a, 'tcx> {
2029     fn check(&mut self, idx: &'tcx Expr<'_>, seqexpr: &'tcx Expr<'_>, expr: &'tcx Expr<'_>) -> bool {
2030         if_chain! {
2031             // the indexed container is referenced by a name
2032             if let ExprKind::Path(ref seqpath) = seqexpr.kind;
2033             if let QPath::Resolved(None, ref seqvar) = *seqpath;
2034             if seqvar.segments.len() == 1;
2035             then {
2036                 let index_used_directly = same_var(self.cx, idx, self.var);
2037                 let indexed_indirectly = {
2038                     let mut used_visitor = LocalUsedVisitor {
2039                         cx: self.cx,
2040                         local: self.var,
2041                         used: false,
2042                     };
2043                     walk_expr(&mut used_visitor, idx);
2044                     used_visitor.used
2045                 };
2046
2047                 if indexed_indirectly || index_used_directly {
2048                     if self.prefer_mutable {
2049                         self.indexed_mut.insert(seqvar.segments[0].ident.name);
2050                     }
2051                     let res = qpath_res(self.cx, seqpath, seqexpr.hir_id);
2052                     match res {
2053                         Res::Local(hir_id) => {
2054                             let parent_id = self.cx.tcx.hir().get_parent_item(expr.hir_id);
2055                             let parent_def_id = self.cx.tcx.hir().local_def_id(parent_id);
2056                             let extent = self.cx.tcx.region_scope_tree(parent_def_id).var_scope(hir_id.local_id);
2057                             if indexed_indirectly {
2058                                 self.indexed_indirectly.insert(seqvar.segments[0].ident.name, Some(extent));
2059                             }
2060                             if index_used_directly {
2061                                 self.indexed_directly.insert(
2062                                     seqvar.segments[0].ident.name,
2063                                     (Some(extent), self.cx.typeck_results().node_type(seqexpr.hir_id)),
2064                                 );
2065                             }
2066                             return false;  // no need to walk further *on the variable*
2067                         }
2068                         Res::Def(DefKind::Static | DefKind::Const, ..) => {
2069                             if indexed_indirectly {
2070                                 self.indexed_indirectly.insert(seqvar.segments[0].ident.name, None);
2071                             }
2072                             if index_used_directly {
2073                                 self.indexed_directly.insert(
2074                                     seqvar.segments[0].ident.name,
2075                                     (None, self.cx.typeck_results().node_type(seqexpr.hir_id)),
2076                                 );
2077                             }
2078                             return false;  // no need to walk further *on the variable*
2079                         }
2080                         _ => (),
2081                     }
2082                 }
2083             }
2084         }
2085         true
2086     }
2087 }
2088
2089 impl<'a, 'tcx> Visitor<'tcx> for VarVisitor<'a, 'tcx> {
2090     type Map = Map<'tcx>;
2091
2092     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
2093         if_chain! {
2094             // a range index op
2095             if let ExprKind::MethodCall(ref meth, _, ref args, _) = expr.kind;
2096             if (meth.ident.name == sym!(index) && match_trait_method(self.cx, expr, &paths::INDEX))
2097                 || (meth.ident.name == sym!(index_mut) && match_trait_method(self.cx, expr, &paths::INDEX_MUT));
2098             if !self.check(&args[1], &args[0], expr);
2099             then { return }
2100         }
2101
2102         if_chain! {
2103             // an index op
2104             if let ExprKind::Index(ref seqexpr, ref idx) = expr.kind;
2105             if !self.check(idx, seqexpr, expr);
2106             then { return }
2107         }
2108
2109         if_chain! {
2110             // directly using a variable
2111             if let ExprKind::Path(ref qpath) = expr.kind;
2112             if let QPath::Resolved(None, ref path) = *qpath;
2113             if path.segments.len() == 1;
2114             then {
2115                 if let Res::Local(local_id) = qpath_res(self.cx, qpath, expr.hir_id) {
2116                     if local_id == self.var {
2117                         self.nonindex = true;
2118                     } else {
2119                         // not the correct variable, but still a variable
2120                         self.referenced.insert(path.segments[0].ident.name);
2121                     }
2122                 }
2123             }
2124         }
2125
2126         let old = self.prefer_mutable;
2127         match expr.kind {
2128             ExprKind::AssignOp(_, ref lhs, ref rhs) | ExprKind::Assign(ref lhs, ref rhs, _) => {
2129                 self.prefer_mutable = true;
2130                 self.visit_expr(lhs);
2131                 self.prefer_mutable = false;
2132                 self.visit_expr(rhs);
2133             },
2134             ExprKind::AddrOf(BorrowKind::Ref, mutbl, ref expr) => {
2135                 if mutbl == Mutability::Mut {
2136                     self.prefer_mutable = true;
2137                 }
2138                 self.visit_expr(expr);
2139             },
2140             ExprKind::Call(ref f, args) => {
2141                 self.visit_expr(f);
2142                 for expr in args {
2143                     let ty = self.cx.typeck_results().expr_ty_adjusted(expr);
2144                     self.prefer_mutable = false;
2145                     if let ty::Ref(_, _, mutbl) = *ty.kind() {
2146                         if mutbl == Mutability::Mut {
2147                             self.prefer_mutable = true;
2148                         }
2149                     }
2150                     self.visit_expr(expr);
2151                 }
2152             },
2153             ExprKind::MethodCall(_, _, args, _) => {
2154                 let def_id = self.cx.typeck_results().type_dependent_def_id(expr.hir_id).unwrap();
2155                 for (ty, expr) in self.cx.tcx.fn_sig(def_id).inputs().skip_binder().iter().zip(args) {
2156                     self.prefer_mutable = false;
2157                     if let ty::Ref(_, _, mutbl) = *ty.kind() {
2158                         if mutbl == Mutability::Mut {
2159                             self.prefer_mutable = true;
2160                         }
2161                     }
2162                     self.visit_expr(expr);
2163                 }
2164             },
2165             ExprKind::Closure(_, _, body_id, ..) => {
2166                 let body = self.cx.tcx.hir().body(body_id);
2167                 self.visit_expr(&body.value);
2168             },
2169             _ => walk_expr(self, expr),
2170         }
2171         self.prefer_mutable = old;
2172     }
2173     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
2174         NestedVisitorMap::None
2175     }
2176 }
2177
2178 fn is_used_inside<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>, container: &'tcx Expr<'_>) -> bool {
2179     let def_id = match var_def_id(cx, expr) {
2180         Some(id) => id,
2181         None => return false,
2182     };
2183     if let Some(used_mutably) = mutated_variables(container, cx) {
2184         if used_mutably.contains(&def_id) {
2185             return true;
2186         }
2187     }
2188     false
2189 }
2190
2191 fn is_iterator_used_after_while_let<'tcx>(cx: &LateContext<'tcx>, iter_expr: &'tcx Expr<'_>) -> bool {
2192     let def_id = match var_def_id(cx, iter_expr) {
2193         Some(id) => id,
2194         None => return false,
2195     };
2196     let mut visitor = VarUsedAfterLoopVisitor {
2197         cx,
2198         def_id,
2199         iter_expr_id: iter_expr.hir_id,
2200         past_while_let: false,
2201         var_used_after_while_let: false,
2202     };
2203     if let Some(enclosing_block) = get_enclosing_block(cx, def_id) {
2204         walk_block(&mut visitor, enclosing_block);
2205     }
2206     visitor.var_used_after_while_let
2207 }
2208
2209 struct VarUsedAfterLoopVisitor<'a, 'tcx> {
2210     cx: &'a LateContext<'tcx>,
2211     def_id: HirId,
2212     iter_expr_id: HirId,
2213     past_while_let: bool,
2214     var_used_after_while_let: bool,
2215 }
2216
2217 impl<'a, 'tcx> Visitor<'tcx> for VarUsedAfterLoopVisitor<'a, 'tcx> {
2218     type Map = Map<'tcx>;
2219
2220     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
2221         if self.past_while_let {
2222             if Some(self.def_id) == var_def_id(self.cx, expr) {
2223                 self.var_used_after_while_let = true;
2224             }
2225         } else if self.iter_expr_id == expr.hir_id {
2226             self.past_while_let = true;
2227         }
2228         walk_expr(self, expr);
2229     }
2230     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
2231         NestedVisitorMap::None
2232     }
2233 }
2234
2235 /// Returns `true` if the type of expr is one that provides `IntoIterator` impls
2236 /// for `&T` and `&mut T`, such as `Vec`.
2237 #[rustfmt::skip]
2238 fn is_ref_iterable_type(cx: &LateContext<'_>, e: &Expr<'_>) -> bool {
2239     // no walk_ptrs_ty: calling iter() on a reference can make sense because it
2240     // will allow further borrows afterwards
2241     let ty = cx.typeck_results().expr_ty(e);
2242     is_iterable_array(ty, cx) ||
2243     is_type_diagnostic_item(cx, ty, sym!(vec_type)) ||
2244     match_type(cx, ty, &paths::LINKED_LIST) ||
2245     is_type_diagnostic_item(cx, ty, sym!(hashmap_type)) ||
2246     is_type_diagnostic_item(cx, ty, sym!(hashset_type)) ||
2247     is_type_diagnostic_item(cx, ty, sym!(vecdeque_type)) ||
2248     match_type(cx, ty, &paths::BINARY_HEAP) ||
2249     match_type(cx, ty, &paths::BTREEMAP) ||
2250     match_type(cx, ty, &paths::BTREESET)
2251 }
2252
2253 fn is_iterable_array<'tcx>(ty: Ty<'tcx>, cx: &LateContext<'tcx>) -> bool {
2254     // IntoIterator is currently only implemented for array sizes <= 32 in rustc
2255     match ty.kind() {
2256         ty::Array(_, n) => n
2257             .try_eval_usize(cx.tcx, cx.param_env)
2258             .map_or(false, |val| (0..=32).contains(&val)),
2259         _ => false,
2260     }
2261 }
2262
2263 /// If a block begins with a statement (possibly a `let` binding) and has an
2264 /// expression, return it.
2265 fn extract_expr_from_first_stmt<'tcx>(block: &Block<'tcx>) -> Option<&'tcx Expr<'tcx>> {
2266     if block.stmts.is_empty() {
2267         return None;
2268     }
2269     if let StmtKind::Local(ref local) = block.stmts[0].kind {
2270         local.init //.map(|expr| expr)
2271     } else {
2272         None
2273     }
2274 }
2275
2276 /// If a block begins with an expression (with or without semicolon), return it.
2277 fn extract_first_expr<'tcx>(block: &Block<'tcx>) -> Option<&'tcx Expr<'tcx>> {
2278     match block.expr {
2279         Some(ref expr) if block.stmts.is_empty() => Some(expr),
2280         None if !block.stmts.is_empty() => match block.stmts[0].kind {
2281             StmtKind::Expr(ref expr) | StmtKind::Semi(ref expr) => Some(expr),
2282             StmtKind::Local(..) | StmtKind::Item(..) => None,
2283         },
2284         _ => None,
2285     }
2286 }
2287
2288 /// Returns `true` if expr contains a single break expr without destination label
2289 /// and
2290 /// passed expression. The expression may be within a block.
2291 fn is_simple_break_expr(expr: &Expr<'_>) -> bool {
2292     match expr.kind {
2293         ExprKind::Break(dest, ref passed_expr) if dest.label.is_none() && passed_expr.is_none() => true,
2294         ExprKind::Block(ref b, _) => extract_first_expr(b).map_or(false, |subexpr| is_simple_break_expr(subexpr)),
2295         _ => false,
2296     }
2297 }
2298
2299 #[derive(Debug, PartialEq)]
2300 enum IncrementVisitorVarState {
2301     Initial,  // Not examined yet
2302     IncrOnce, // Incremented exactly once, may be a loop counter
2303     DontWarn,
2304 }
2305
2306 /// Scan a for loop for variables that are incremented exactly once and not used after that.
2307 struct IncrementVisitor<'a, 'tcx> {
2308     cx: &'a LateContext<'tcx>,                          // context reference
2309     states: FxHashMap<HirId, IncrementVisitorVarState>, // incremented variables
2310     depth: u32,                                         // depth of conditional expressions
2311     done: bool,
2312 }
2313
2314 impl<'a, 'tcx> IncrementVisitor<'a, 'tcx> {
2315     fn new(cx: &'a LateContext<'tcx>) -> Self {
2316         Self {
2317             cx,
2318             states: FxHashMap::default(),
2319             depth: 0,
2320             done: false,
2321         }
2322     }
2323
2324     fn into_results(self) -> impl Iterator<Item = HirId> {
2325         self.states.into_iter().filter_map(|(id, state)| {
2326             if state == IncrementVisitorVarState::IncrOnce {
2327                 Some(id)
2328             } else {
2329                 None
2330             }
2331         })
2332     }
2333 }
2334
2335 impl<'a, 'tcx> Visitor<'tcx> for IncrementVisitor<'a, 'tcx> {
2336     type Map = Map<'tcx>;
2337
2338     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
2339         if self.done {
2340             return;
2341         }
2342
2343         // If node is a variable
2344         if let Some(def_id) = var_def_id(self.cx, expr) {
2345             if let Some(parent) = get_parent_expr(self.cx, expr) {
2346                 let state = self.states.entry(def_id).or_insert(IncrementVisitorVarState::Initial);
2347                 if *state == IncrementVisitorVarState::IncrOnce {
2348                     *state = IncrementVisitorVarState::DontWarn;
2349                     return;
2350                 }
2351
2352                 match parent.kind {
2353                     ExprKind::AssignOp(op, ref lhs, ref rhs) => {
2354                         if lhs.hir_id == expr.hir_id {
2355                             *state = if op.node == BinOpKind::Add
2356                                 && is_integer_const(self.cx, rhs, 1)
2357                                 && *state == IncrementVisitorVarState::Initial
2358                                 && self.depth == 0
2359                             {
2360                                 IncrementVisitorVarState::IncrOnce
2361                             } else {
2362                                 // Assigned some other value or assigned multiple times
2363                                 IncrementVisitorVarState::DontWarn
2364                             };
2365                         }
2366                     },
2367                     ExprKind::Assign(ref lhs, _, _) if lhs.hir_id == expr.hir_id => {
2368                         *state = IncrementVisitorVarState::DontWarn
2369                     },
2370                     ExprKind::AddrOf(BorrowKind::Ref, mutability, _) if mutability == Mutability::Mut => {
2371                         *state = IncrementVisitorVarState::DontWarn
2372                     },
2373                     _ => (),
2374                 }
2375             }
2376
2377             walk_expr(self, expr);
2378         } else if is_loop(expr) || is_conditional(expr) {
2379             self.depth += 1;
2380             walk_expr(self, expr);
2381             self.depth -= 1;
2382         } else if let ExprKind::Continue(_) = expr.kind {
2383             self.done = true;
2384         } else {
2385             walk_expr(self, expr);
2386         }
2387     }
2388     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
2389         NestedVisitorMap::None
2390     }
2391 }
2392
2393 enum InitializeVisitorState<'hir> {
2394     Initial,          // Not examined yet
2395     Declared(Symbol), // Declared but not (yet) initialized
2396     Initialized {
2397         name: Symbol,
2398         initializer: &'hir Expr<'hir>,
2399     },
2400     DontWarn,
2401 }
2402
2403 /// Checks whether a variable is initialized at the start of a loop and not modified
2404 /// and used after the loop.
2405 struct InitializeVisitor<'a, 'tcx> {
2406     cx: &'a LateContext<'tcx>,  // context reference
2407     end_expr: &'tcx Expr<'tcx>, // the for loop. Stop scanning here.
2408     var_id: HirId,
2409     state: InitializeVisitorState<'tcx>,
2410     depth: u32, // depth of conditional expressions
2411     past_loop: bool,
2412 }
2413
2414 impl<'a, 'tcx> InitializeVisitor<'a, 'tcx> {
2415     fn new(cx: &'a LateContext<'tcx>, end_expr: &'tcx Expr<'tcx>, var_id: HirId) -> Self {
2416         Self {
2417             cx,
2418             end_expr,
2419             var_id,
2420             state: InitializeVisitorState::Initial,
2421             depth: 0,
2422             past_loop: false,
2423         }
2424     }
2425
2426     fn get_result(&self) -> Option<(Symbol, &'tcx Expr<'tcx>)> {
2427         if let InitializeVisitorState::Initialized { name, initializer } = self.state {
2428             Some((name, initializer))
2429         } else {
2430             None
2431         }
2432     }
2433 }
2434
2435 impl<'a, 'tcx> Visitor<'tcx> for InitializeVisitor<'a, 'tcx> {
2436     type Map = Map<'tcx>;
2437
2438     fn visit_stmt(&mut self, stmt: &'tcx Stmt<'_>) {
2439         // Look for declarations of the variable
2440         if_chain! {
2441             if let StmtKind::Local(ref local) = stmt.kind;
2442             if local.pat.hir_id == self.var_id;
2443             if let PatKind::Binding(.., ident, _) = local.pat.kind;
2444             then {
2445                 self.state = local.init.map_or(InitializeVisitorState::Declared(ident.name), |init| {
2446                     InitializeVisitorState::Initialized {
2447                         initializer: init,
2448                         name: ident.name,
2449                     }
2450                 })
2451             }
2452         }
2453         walk_stmt(self, stmt);
2454     }
2455
2456     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
2457         if matches!(self.state, InitializeVisitorState::DontWarn) {
2458             return;
2459         }
2460         if expr.hir_id == self.end_expr.hir_id {
2461             self.past_loop = true;
2462             return;
2463         }
2464         // No need to visit expressions before the variable is
2465         // declared
2466         if matches!(self.state, InitializeVisitorState::Initial) {
2467             return;
2468         }
2469
2470         // If node is the desired variable, see how it's used
2471         if var_def_id(self.cx, expr) == Some(self.var_id) {
2472             if self.past_loop {
2473                 self.state = InitializeVisitorState::DontWarn;
2474                 return;
2475             }
2476
2477             if let Some(parent) = get_parent_expr(self.cx, expr) {
2478                 match parent.kind {
2479                     ExprKind::AssignOp(_, ref lhs, _) if lhs.hir_id == expr.hir_id => {
2480                         self.state = InitializeVisitorState::DontWarn;
2481                     },
2482                     ExprKind::Assign(ref lhs, ref rhs, _) if lhs.hir_id == expr.hir_id => {
2483                         self.state = if_chain! {
2484                             if self.depth == 0;
2485                             if let InitializeVisitorState::Declared(name)
2486                                 | InitializeVisitorState::Initialized { name, ..} = self.state;
2487                             then {
2488                                 InitializeVisitorState::Initialized { initializer: rhs, name }
2489                             } else {
2490                                 InitializeVisitorState::DontWarn
2491                             }
2492                         }
2493                     },
2494                     ExprKind::AddrOf(BorrowKind::Ref, mutability, _) if mutability == Mutability::Mut => {
2495                         self.state = InitializeVisitorState::DontWarn
2496                     },
2497                     _ => (),
2498                 }
2499             }
2500
2501             walk_expr(self, expr);
2502         } else if !self.past_loop && is_loop(expr) {
2503             self.state = InitializeVisitorState::DontWarn;
2504         } else if is_conditional(expr) {
2505             self.depth += 1;
2506             walk_expr(self, expr);
2507             self.depth -= 1;
2508         } else {
2509             walk_expr(self, expr);
2510         }
2511     }
2512
2513     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
2514         NestedVisitorMap::OnlyBodies(self.cx.tcx.hir())
2515     }
2516 }
2517
2518 fn var_def_id(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<HirId> {
2519     if let ExprKind::Path(ref qpath) = expr.kind {
2520         let path_res = qpath_res(cx, qpath, expr.hir_id);
2521         if let Res::Local(hir_id) = path_res {
2522             return Some(hir_id);
2523         }
2524     }
2525     None
2526 }
2527
2528 fn is_loop(expr: &Expr<'_>) -> bool {
2529     matches!(expr.kind, ExprKind::Loop(..))
2530 }
2531
2532 fn is_conditional(expr: &Expr<'_>) -> bool {
2533     matches!(expr.kind, ExprKind::Match(..))
2534 }
2535
2536 fn is_nested(cx: &LateContext<'_>, match_expr: &Expr<'_>, iter_expr: &Expr<'_>) -> bool {
2537     if_chain! {
2538         if let Some(loop_block) = get_enclosing_block(cx, match_expr.hir_id);
2539         let parent_node = cx.tcx.hir().get_parent_node(loop_block.hir_id);
2540         if let Some(Node::Expr(loop_expr)) = cx.tcx.hir().find(parent_node);
2541         then {
2542             return is_loop_nested(cx, loop_expr, iter_expr)
2543         }
2544     }
2545     false
2546 }
2547
2548 fn is_loop_nested(cx: &LateContext<'_>, loop_expr: &Expr<'_>, iter_expr: &Expr<'_>) -> bool {
2549     let mut id = loop_expr.hir_id;
2550     let iter_name = if let Some(name) = path_name(iter_expr) {
2551         name
2552     } else {
2553         return true;
2554     };
2555     loop {
2556         let parent = cx.tcx.hir().get_parent_node(id);
2557         if parent == id {
2558             return false;
2559         }
2560         match cx.tcx.hir().find(parent) {
2561             Some(Node::Expr(expr)) => {
2562                 if let ExprKind::Loop(..) = expr.kind {
2563                     return true;
2564                 };
2565             },
2566             Some(Node::Block(block)) => {
2567                 let mut block_visitor = LoopNestVisitor {
2568                     hir_id: id,
2569                     iterator: iter_name,
2570                     nesting: Unknown,
2571                 };
2572                 walk_block(&mut block_visitor, block);
2573                 if block_visitor.nesting == RuledOut {
2574                     return false;
2575                 }
2576             },
2577             Some(Node::Stmt(_)) => (),
2578             _ => {
2579                 return false;
2580             },
2581         }
2582         id = parent;
2583     }
2584 }
2585
2586 #[derive(PartialEq, Eq)]
2587 enum Nesting {
2588     Unknown,     // no nesting detected yet
2589     RuledOut,    // the iterator is initialized or assigned within scope
2590     LookFurther, // no nesting detected, no further walk required
2591 }
2592
2593 use self::Nesting::{LookFurther, RuledOut, Unknown};
2594
2595 struct LoopNestVisitor {
2596     hir_id: HirId,
2597     iterator: Symbol,
2598     nesting: Nesting,
2599 }
2600
2601 impl<'tcx> Visitor<'tcx> for LoopNestVisitor {
2602     type Map = Map<'tcx>;
2603
2604     fn visit_stmt(&mut self, stmt: &'tcx Stmt<'_>) {
2605         if stmt.hir_id == self.hir_id {
2606             self.nesting = LookFurther;
2607         } else if self.nesting == Unknown {
2608             walk_stmt(self, stmt);
2609         }
2610     }
2611
2612     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
2613         if self.nesting != Unknown {
2614             return;
2615         }
2616         if expr.hir_id == self.hir_id {
2617             self.nesting = LookFurther;
2618             return;
2619         }
2620         match expr.kind {
2621             ExprKind::Assign(ref path, _, _) | ExprKind::AssignOp(_, ref path, _) => {
2622                 if match_var(path, self.iterator) {
2623                     self.nesting = RuledOut;
2624                 }
2625             },
2626             _ => walk_expr(self, expr),
2627         }
2628     }
2629
2630     fn visit_pat(&mut self, pat: &'tcx Pat<'_>) {
2631         if self.nesting != Unknown {
2632             return;
2633         }
2634         if let PatKind::Binding(.., span_name, _) = pat.kind {
2635             if self.iterator == span_name.name {
2636                 self.nesting = RuledOut;
2637                 return;
2638             }
2639         }
2640         walk_pat(self, pat)
2641     }
2642
2643     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
2644         NestedVisitorMap::None
2645     }
2646 }
2647
2648 fn path_name(e: &Expr<'_>) -> Option<Symbol> {
2649     if let ExprKind::Path(QPath::Resolved(_, ref path)) = e.kind {
2650         let segments = &path.segments;
2651         if segments.len() == 1 {
2652             return Some(segments[0].ident.name);
2653         }
2654     };
2655     None
2656 }
2657
2658 fn check_infinite_loop<'tcx>(cx: &LateContext<'tcx>, cond: &'tcx Expr<'_>, expr: &'tcx Expr<'_>) {
2659     if constant(cx, cx.typeck_results(), cond).is_some() {
2660         // A pure constant condition (e.g., `while false`) is not linted.
2661         return;
2662     }
2663
2664     let mut var_visitor = VarCollectorVisitor {
2665         cx,
2666         ids: FxHashSet::default(),
2667         def_ids: FxHashMap::default(),
2668         skip: false,
2669     };
2670     var_visitor.visit_expr(cond);
2671     if var_visitor.skip {
2672         return;
2673     }
2674     let used_in_condition = &var_visitor.ids;
2675     let no_cond_variable_mutated = if let Some(used_mutably) = mutated_variables(expr, cx) {
2676         used_in_condition.is_disjoint(&used_mutably)
2677     } else {
2678         return;
2679     };
2680     let mutable_static_in_cond = var_visitor.def_ids.iter().any(|(_, v)| *v);
2681
2682     let mut has_break_or_return_visitor = HasBreakOrReturnVisitor {
2683         has_break_or_return: false,
2684     };
2685     has_break_or_return_visitor.visit_expr(expr);
2686     let has_break_or_return = has_break_or_return_visitor.has_break_or_return;
2687
2688     if no_cond_variable_mutated && !mutable_static_in_cond {
2689         span_lint_and_then(
2690             cx,
2691             WHILE_IMMUTABLE_CONDITION,
2692             cond.span,
2693             "variables in the condition are not mutated in the loop body",
2694             |diag| {
2695                 diag.note("this may lead to an infinite or to a never running loop");
2696
2697                 if has_break_or_return {
2698                     diag.note("this loop contains `return`s or `break`s");
2699                     diag.help("rewrite it as `if cond { loop { } }`");
2700                 }
2701             },
2702         );
2703     }
2704 }
2705
2706 struct HasBreakOrReturnVisitor {
2707     has_break_or_return: bool,
2708 }
2709
2710 impl<'tcx> Visitor<'tcx> for HasBreakOrReturnVisitor {
2711     type Map = Map<'tcx>;
2712
2713     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
2714         if self.has_break_or_return {
2715             return;
2716         }
2717
2718         match expr.kind {
2719             ExprKind::Ret(_) | ExprKind::Break(_, _) => {
2720                 self.has_break_or_return = true;
2721                 return;
2722             },
2723             _ => {},
2724         }
2725
2726         walk_expr(self, expr);
2727     }
2728
2729     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
2730         NestedVisitorMap::None
2731     }
2732 }
2733
2734 /// Collects the set of variables in an expression
2735 /// Stops analysis if a function call is found
2736 /// Note: In some cases such as `self`, there are no mutable annotation,
2737 /// All variables definition IDs are collected
2738 struct VarCollectorVisitor<'a, 'tcx> {
2739     cx: &'a LateContext<'tcx>,
2740     ids: FxHashSet<HirId>,
2741     def_ids: FxHashMap<def_id::DefId, bool>,
2742     skip: bool,
2743 }
2744
2745 impl<'a, 'tcx> VarCollectorVisitor<'a, 'tcx> {
2746     fn insert_def_id(&mut self, ex: &'tcx Expr<'_>) {
2747         if_chain! {
2748             if let ExprKind::Path(ref qpath) = ex.kind;
2749             if let QPath::Resolved(None, _) = *qpath;
2750             let res = qpath_res(self.cx, qpath, ex.hir_id);
2751             then {
2752                 match res {
2753                     Res::Local(hir_id) => {
2754                         self.ids.insert(hir_id);
2755                     },
2756                     Res::Def(DefKind::Static, def_id) => {
2757                         let mutable = self.cx.tcx.is_mutable_static(def_id);
2758                         self.def_ids.insert(def_id, mutable);
2759                     },
2760                     _ => {},
2761                 }
2762             }
2763         }
2764     }
2765 }
2766
2767 impl<'a, 'tcx> Visitor<'tcx> for VarCollectorVisitor<'a, 'tcx> {
2768     type Map = Map<'tcx>;
2769
2770     fn visit_expr(&mut self, ex: &'tcx Expr<'_>) {
2771         match ex.kind {
2772             ExprKind::Path(_) => self.insert_def_id(ex),
2773             // If there is any function/method call… we just stop analysis
2774             ExprKind::Call(..) | ExprKind::MethodCall(..) => self.skip = true,
2775
2776             _ => walk_expr(self, ex),
2777         }
2778     }
2779
2780     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
2781         NestedVisitorMap::None
2782     }
2783 }
2784
2785 const NEEDLESS_COLLECT_MSG: &str = "avoid using `collect()` when not needed";
2786
2787 fn check_needless_collect<'tcx>(expr: &'tcx Expr<'_>, cx: &LateContext<'tcx>) {
2788     check_needless_collect_direct_usage(expr, cx);
2789     check_needless_collect_indirect_usage(expr, cx);
2790 }
2791 fn check_needless_collect_direct_usage<'tcx>(expr: &'tcx Expr<'_>, cx: &LateContext<'tcx>) {
2792     if_chain! {
2793         if let ExprKind::MethodCall(ref method, _, ref args, _) = expr.kind;
2794         if let ExprKind::MethodCall(ref chain_method, _, _, _) = args[0].kind;
2795         if chain_method.ident.name == sym!(collect) && match_trait_method(cx, &args[0], &paths::ITERATOR);
2796         if let Some(ref generic_args) = chain_method.args;
2797         if let Some(GenericArg::Type(ref ty)) = generic_args.args.get(0);
2798         then {
2799             let ty = cx.typeck_results().node_type(ty.hir_id);
2800             if is_type_diagnostic_item(cx, ty, sym!(vec_type)) ||
2801                 is_type_diagnostic_item(cx, ty, sym!(vecdeque_type)) ||
2802                 match_type(cx, ty, &paths::BTREEMAP) ||
2803                 is_type_diagnostic_item(cx, ty, sym!(hashmap_type)) {
2804                 if method.ident.name == sym!(len) {
2805                     let span = shorten_needless_collect_span(expr);
2806                     span_lint_and_sugg(
2807                         cx,
2808                         NEEDLESS_COLLECT,
2809                         span,
2810                         NEEDLESS_COLLECT_MSG,
2811                         "replace with",
2812                         "count()".to_string(),
2813                         Applicability::MachineApplicable,
2814                     );
2815                 }
2816                 if method.ident.name == sym!(is_empty) {
2817                     let span = shorten_needless_collect_span(expr);
2818                     span_lint_and_sugg(
2819                         cx,
2820                         NEEDLESS_COLLECT,
2821                         span,
2822                         NEEDLESS_COLLECT_MSG,
2823                         "replace with",
2824                         "next().is_none()".to_string(),
2825                         Applicability::MachineApplicable,
2826                     );
2827                 }
2828                 if method.ident.name == sym!(contains) {
2829                     let contains_arg = snippet(cx, args[1].span, "??");
2830                     let span = shorten_needless_collect_span(expr);
2831                     span_lint_and_then(
2832                         cx,
2833                         NEEDLESS_COLLECT,
2834                         span,
2835                         NEEDLESS_COLLECT_MSG,
2836                         |diag| {
2837                             let (arg, pred) = contains_arg
2838                                     .strip_prefix('&')
2839                                     .map_or(("&x", &*contains_arg), |s| ("x", s));
2840                             diag.span_suggestion(
2841                                 span,
2842                                 "replace with",
2843                                 format!(
2844                                     "any(|{}| x == {})",
2845                                     arg, pred
2846                                 ),
2847                                 Applicability::MachineApplicable,
2848                             );
2849                         }
2850                     );
2851                 }
2852             }
2853         }
2854     }
2855 }
2856
2857 fn check_needless_collect_indirect_usage<'tcx>(expr: &'tcx Expr<'_>, cx: &LateContext<'tcx>) {
2858     if let ExprKind::Block(ref block, _) = expr.kind {
2859         for ref stmt in block.stmts {
2860             if_chain! {
2861                 if let StmtKind::Local(
2862                     Local { pat: Pat { kind: PatKind::Binding(_, _, ident, .. ), .. },
2863                     init: Some(ref init_expr), .. }
2864                 ) = stmt.kind;
2865                 if let ExprKind::MethodCall(ref method_name, _, &[ref iter_source], ..) = init_expr.kind;
2866                 if method_name.ident.name == sym!(collect) && match_trait_method(cx, &init_expr, &paths::ITERATOR);
2867                 if let Some(ref generic_args) = method_name.args;
2868                 if let Some(GenericArg::Type(ref ty)) = generic_args.args.get(0);
2869                 if let ty = cx.typeck_results().node_type(ty.hir_id);
2870                 if is_type_diagnostic_item(cx, ty, sym::vec_type) ||
2871                     is_type_diagnostic_item(cx, ty, sym!(vecdeque_type)) ||
2872                     match_type(cx, ty, &paths::LINKED_LIST);
2873                 if let Some(iter_calls) = detect_iter_and_into_iters(block, *ident);
2874                 if iter_calls.len() == 1;
2875                 then {
2876                     // Suggest replacing iter_call with iter_replacement, and removing stmt
2877                     let iter_call = &iter_calls[0];
2878                     span_lint_and_then(
2879                         cx,
2880                         NEEDLESS_COLLECT,
2881                         stmt.span.until(iter_call.span),
2882                         NEEDLESS_COLLECT_MSG,
2883                         |diag| {
2884                             let iter_replacement = format!("{}{}", Sugg::hir(cx, iter_source, ".."), iter_call.get_iter_method(cx));
2885                             diag.multipart_suggestion(
2886                                 iter_call.get_suggestion_text(),
2887                                 vec![
2888                                     (stmt.span, String::new()),
2889                                     (iter_call.span, iter_replacement)
2890                                 ],
2891                                 Applicability::MachineApplicable,// MaybeIncorrect,
2892                             ).emit();
2893                         },
2894                     );
2895                 }
2896             }
2897         }
2898     }
2899 }
2900
2901 struct IterFunction {
2902     func: IterFunctionKind,
2903     span: Span,
2904 }
2905 impl IterFunction {
2906     fn get_iter_method(&self, cx: &LateContext<'_>) -> String {
2907         match &self.func {
2908             IterFunctionKind::IntoIter => String::new(),
2909             IterFunctionKind::Len => String::from(".count()"),
2910             IterFunctionKind::IsEmpty => String::from(".next().is_none()"),
2911             IterFunctionKind::Contains(span) => format!(".any(|x| x == {})", snippet(cx, *span, "..")),
2912         }
2913     }
2914     fn get_suggestion_text(&self) -> &'static str {
2915         match &self.func {
2916             IterFunctionKind::IntoIter => {
2917                 "Use the original Iterator instead of collecting it and then producing a new one"
2918             },
2919             IterFunctionKind::Len => {
2920                 "Take the original Iterator's count instead of collecting it and finding the length"
2921             },
2922             IterFunctionKind::IsEmpty => {
2923                 "Check if the original Iterator has anything instead of collecting it and seeing if it's empty"
2924             },
2925             IterFunctionKind::Contains(_) => {
2926                 "Check if the original Iterator contains an element instead of collecting then checking"
2927             },
2928         }
2929     }
2930 }
2931 enum IterFunctionKind {
2932     IntoIter,
2933     Len,
2934     IsEmpty,
2935     Contains(Span),
2936 }
2937
2938 struct IterFunctionVisitor {
2939     uses: Vec<IterFunction>,
2940     seen_other: bool,
2941     target: Ident,
2942 }
2943 impl<'tcx> Visitor<'tcx> for IterFunctionVisitor {
2944     fn visit_expr(&mut self, expr: &'tcx Expr<'tcx>) {
2945         // Check function calls on our collection
2946         if_chain! {
2947             if let ExprKind::MethodCall(method_name, _, ref args, _) = &expr.kind;
2948             if let Some(Expr { kind: ExprKind::Path(QPath::Resolved(_, ref path)), .. }) = args.get(0);
2949             if let &[name] = &path.segments;
2950             if name.ident == self.target;
2951             then {
2952                 let len = sym!(len);
2953                 let is_empty = sym!(is_empty);
2954                 let contains = sym!(contains);
2955                 match method_name.ident.name {
2956                     sym::into_iter => self.uses.push(
2957                         IterFunction { func: IterFunctionKind::IntoIter, span: expr.span }
2958                     ),
2959                     name if name == len => self.uses.push(
2960                         IterFunction { func: IterFunctionKind::Len, span: expr.span }
2961                     ),
2962                     name if name == is_empty => self.uses.push(
2963                         IterFunction { func: IterFunctionKind::IsEmpty, span: expr.span }
2964                     ),
2965                     name if name == contains => self.uses.push(
2966                         IterFunction { func: IterFunctionKind::Contains(args[1].span), span: expr.span }
2967                     ),
2968                     _ => self.seen_other = true,
2969                 }
2970                 return
2971             }
2972         }
2973         // Check if the collection is used for anything else
2974         if_chain! {
2975             if let Expr { kind: ExprKind::Path(QPath::Resolved(_, ref path)), .. } = expr;
2976             if let &[name] = &path.segments;
2977             if name.ident == self.target;
2978             then {
2979                 self.seen_other = true;
2980             } else {
2981                 walk_expr(self, expr);
2982             }
2983         }
2984     }
2985
2986     type Map = Map<'tcx>;
2987     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
2988         NestedVisitorMap::None
2989     }
2990 }
2991
2992 /// Detect the occurences of calls to `iter` or `into_iter` for the
2993 /// given identifier
2994 fn detect_iter_and_into_iters<'tcx>(block: &'tcx Block<'tcx>, identifier: Ident) -> Option<Vec<IterFunction>> {
2995     let mut visitor = IterFunctionVisitor {
2996         uses: Vec::new(),
2997         target: identifier,
2998         seen_other: false,
2999     };
3000     visitor.visit_block(block);
3001     if visitor.seen_other {
3002         None
3003     } else {
3004         Some(visitor.uses)
3005     }
3006 }
3007
3008 fn shorten_needless_collect_span(expr: &Expr<'_>) -> Span {
3009     if_chain! {
3010         if let ExprKind::MethodCall(.., args, _) = &expr.kind;
3011         if let ExprKind::MethodCall(_, span, ..) = &args[0].kind;
3012         then {
3013             return expr.span.with_lo(span.lo());
3014         }
3015     }
3016     unreachable!();
3017 }