clippy_lints/src/loops.rs

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