clippy_lints/src/loops.rs

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