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