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