clippy_lints/src/loops.rs

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