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