src/tools/clippy/clippy_lints/src/loops.rs

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