clippy_lints/src/loops.rs

   1 use crate::consts::constant;
   2 use crate::reexport::Name;
   3 use crate::utils::paths;
   4 use crate::utils::usage::{is_unused, mutated_variables};
   5 use crate::utils::{
   6     get_enclosing_block, get_parent_expr, get_trait_def_id, has_iter_method, higher, implements_trait,
   7     is_integer_const, is_no_std_crate, is_refutable, last_path_segment, match_trait_method, match_type, match_var,
   8     multispan_sugg, snippet, snippet_opt, snippet_with_applicability, span_lint, span_lint_and_help,
   9     span_lint_and_sugg, span_lint_and_then, SpanlessEq,
  10 };
  11 use crate::utils::{is_type_diagnostic_item, qpath_res, sugg};
  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     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::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_lint_pass!(Loops => [
 424     MANUAL_MEMCPY,
 425     NEEDLESS_RANGE_LOOP,
 426     EXPLICIT_ITER_LOOP,
 427     EXPLICIT_INTO_ITER_LOOP,
 428     ITER_NEXT_LOOP,
 429     FOR_LOOPS_OVER_FALLIBLES,
 430     WHILE_LET_LOOP,
 431     NEEDLESS_COLLECT,
 432     EXPLICIT_COUNTER_LOOP,
 433     EMPTY_LOOP,
 434     WHILE_LET_ON_ITERATOR,
 435     FOR_KV_MAP,
 436     NEVER_LOOP,
 437     MUT_RANGE_BOUND,
 438     WHILE_IMMUTABLE_CONDITION,
 439 ]);
 440
 441 impl<'tcx> LateLintPass<'tcx> for Loops {
 442     #[allow(clippy::too_many_lines)]
 443     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
 444         if let Some((pat, arg, body)) = higher::for_loop(expr) {
 445             // we don't want to check expanded macros
 446             // this check is not at the top of the function
 447             // since higher::for_loop expressions are marked as expansions
 448             if body.span.from_expansion() {
 449                 return;
 450             }
 451             check_for_loop(cx, pat, arg, body, expr);
 452         }
 453
 454         // we don't want to check expanded macros
 455         if expr.span.from_expansion() {
 456             return;
 457         }
 458
 459         // check for never_loop
 460         if let ExprKind::Loop(ref block, _, _) = expr.kind {
 461             match never_loop_block(block, expr.hir_id) {
 462                 NeverLoopResult::AlwaysBreak => span_lint(cx, NEVER_LOOP, expr.span, "this loop never actually loops"),
 463                 NeverLoopResult::MayContinueMainLoop | NeverLoopResult::Otherwise => (),
 464             }
 465         }
 466
 467         // check for `loop { if let {} else break }` that could be `while let`
 468         // (also matches an explicit "match" instead of "if let")
 469         // (even if the "match" or "if let" is used for declaration)
 470         if let ExprKind::Loop(ref block, _, LoopSource::Loop) = expr.kind {
 471             // also check for empty `loop {}` statements
 472             if block.stmts.is_empty() && block.expr.is_none() && !is_no_std_crate(cx.tcx.hir().krate()) {
 473                 span_lint(
 474                     cx,
 475                     EMPTY_LOOP,
 476                     expr.span,
 477                     "empty `loop {}` detected. You may want to either use `panic!()` or add \
 478                      `std::thread::sleep(..);` to the loop body.",
 479                 );
 480             }
 481
 482             // extract the expression from the first statement (if any) in a block
 483             let inner_stmt_expr = extract_expr_from_first_stmt(block);
 484             // or extract the first expression (if any) from the block
 485             if let Some(inner) = inner_stmt_expr.or_else(|| extract_first_expr(block)) {
 486                 if let ExprKind::Match(ref matchexpr, ref arms, ref source) = inner.kind {
 487                     // ensure "if let" compatible match structure
 488                     match *source {
 489                         MatchSource::Normal | MatchSource::IfLetDesugar { .. } => {
 490                             if arms.len() == 2
 491                                 && arms[0].guard.is_none()
 492                                 && arms[1].guard.is_none()
 493                                 && is_simple_break_expr(&arms[1].body)
 494                             {
 495                                 if in_external_macro(cx.sess(), expr.span) {
 496                                     return;
 497                                 }
 498
 499                                 // NOTE: we used to build a body here instead of using
 500                                 // ellipsis, this was removed because:
 501                                 // 1) it was ugly with big bodies;
 502                                 // 2) it was not indented properly;
 503                                 // 3) it wasn’t very smart (see #675).
 504                                 let mut applicability = Applicability::HasPlaceholders;
 505                                 span_lint_and_sugg(
 506                                     cx,
 507                                     WHILE_LET_LOOP,
 508                                     expr.span,
 509                                     "this loop could be written as a `while let` loop",
 510                                     "try",
 511                                     format!(
 512                                         "while let {} = {} {{ .. }}",
 513                                         snippet_with_applicability(cx, arms[0].pat.span, "..", &mut applicability),
 514                                         snippet_with_applicability(cx, matchexpr.span, "..", &mut applicability),
 515                                     ),
 516                                     applicability,
 517                                 );
 518                             }
 519                         },
 520                         _ => (),
 521                     }
 522                 }
 523             }
 524         }
 525         if let ExprKind::Match(ref match_expr, ref arms, MatchSource::WhileLetDesugar) = expr.kind {
 526             let pat = &arms[0].pat.kind;
 527             if let (
 528                 &PatKind::TupleStruct(ref qpath, ref pat_args, _),
 529                 &ExprKind::MethodCall(ref method_path, _, ref method_args, _),
 530             ) = (pat, &match_expr.kind)
 531             {
 532                 let iter_expr = &method_args[0];
 533
 534                 // Don't lint when the iterator is recreated on every iteration
 535                 if_chain! {
 536                     if let ExprKind::MethodCall(..) | ExprKind::Call(..) = iter_expr.kind;
 537                     if let Some(iter_def_id) = get_trait_def_id(cx, &paths::ITERATOR);
 538                     if implements_trait(cx, cx.typeck_results().expr_ty(iter_expr), iter_def_id, &[]);
 539                     then {
 540                         return;
 541                     }
 542                 }
 543
 544                 let lhs_constructor = last_path_segment(qpath);
 545                 if method_path.ident.name == sym!(next)
 546                     && match_trait_method(cx, match_expr, &paths::ITERATOR)
 547                     && lhs_constructor.ident.name == sym!(Some)
 548                     && (pat_args.is_empty()
 549                         || !is_refutable(cx, &pat_args[0])
 550                             && !is_used_inside(cx, iter_expr, &arms[0].body)
 551                             && !is_iterator_used_after_while_let(cx, iter_expr)
 552                             && !is_nested(cx, expr, &method_args[0]))
 553                 {
 554                     let mut applicability = Applicability::MachineApplicable;
 555                     let iterator = snippet_with_applicability(cx, method_args[0].span, "_", &mut applicability);
 556                     let loop_var = if pat_args.is_empty() {
 557                         "_".to_string()
 558                     } else {
 559                         snippet_with_applicability(cx, pat_args[0].span, "_", &mut applicability).into_owned()
 560                     };
 561                     span_lint_and_sugg(
 562                         cx,
 563                         WHILE_LET_ON_ITERATOR,
 564                         expr.span.with_hi(match_expr.span.hi()),
 565                         "this loop could be written as a `for` loop",
 566                         "try",
 567                         format!("for {} in {}", loop_var, iterator),
 568                         applicability,
 569                     );
 570                 }
 571             }
 572         }
 573
 574         if let Some((cond, body)) = higher::while_loop(&expr) {
 575             check_infinite_loop(cx, cond, body);
 576         }
 577
 578         check_needless_collect(expr, cx);
 579     }
 580 }
 581
 582 enum NeverLoopResult {
 583     // A break/return always get triggered but not necessarily for the main loop.
 584     AlwaysBreak,
 585     // A continue may occur for the main loop.
 586     MayContinueMainLoop,
 587     Otherwise,
 588 }
 589
 590 #[must_use]
 591 fn absorb_break(arg: &NeverLoopResult) -> NeverLoopResult {
 592     match *arg {
 593         NeverLoopResult::AlwaysBreak | NeverLoopResult::Otherwise => NeverLoopResult::Otherwise,
 594         NeverLoopResult::MayContinueMainLoop => NeverLoopResult::MayContinueMainLoop,
 595     }
 596 }
 597
 598 // Combine two results for parts that are called in order.
 599 #[must_use]
 600 fn combine_seq(first: NeverLoopResult, second: NeverLoopResult) -> NeverLoopResult {
 601     match first {
 602         NeverLoopResult::AlwaysBreak | NeverLoopResult::MayContinueMainLoop => first,
 603         NeverLoopResult::Otherwise => second,
 604     }
 605 }
 606
 607 // Combine two results where both parts are called but not necessarily in order.
 608 #[must_use]
 609 fn combine_both(left: NeverLoopResult, right: NeverLoopResult) -> NeverLoopResult {
 610     match (left, right) {
 611         (NeverLoopResult::MayContinueMainLoop, _) | (_, NeverLoopResult::MayContinueMainLoop) => {
 612             NeverLoopResult::MayContinueMainLoop
 613         },
 614         (NeverLoopResult::AlwaysBreak, _) | (_, NeverLoopResult::AlwaysBreak) => NeverLoopResult::AlwaysBreak,
 615         (NeverLoopResult::Otherwise, NeverLoopResult::Otherwise) => NeverLoopResult::Otherwise,
 616     }
 617 }
 618
 619 // Combine two results where only one of the part may have been executed.
 620 #[must_use]
 621 fn combine_branches(b1: NeverLoopResult, b2: NeverLoopResult) -> NeverLoopResult {
 622     match (b1, b2) {
 623         (NeverLoopResult::AlwaysBreak, NeverLoopResult::AlwaysBreak) => NeverLoopResult::AlwaysBreak,
 624         (NeverLoopResult::MayContinueMainLoop, _) | (_, NeverLoopResult::MayContinueMainLoop) => {
 625             NeverLoopResult::MayContinueMainLoop
 626         },
 627         (NeverLoopResult::Otherwise, _) | (_, NeverLoopResult::Otherwise) => NeverLoopResult::Otherwise,
 628     }
 629 }
 630
 631 fn never_loop_block(block: &Block<'_>, main_loop_id: HirId) -> NeverLoopResult {
 632     let stmts = block.stmts.iter().map(stmt_to_expr);
 633     let expr = once(block.expr.as_deref());
 634     let mut iter = stmts.chain(expr).filter_map(|e| e);
 635     never_loop_expr_seq(&mut iter, main_loop_id)
 636 }
 637
 638 fn stmt_to_expr<'tcx>(stmt: &Stmt<'tcx>) -> Option<&'tcx Expr<'tcx>> {
 639     match stmt.kind {
 640         StmtKind::Semi(ref e, ..) | StmtKind::Expr(ref e, ..) => Some(e),
 641         StmtKind::Local(ref local) => local.init.as_deref(),
 642         _ => None,
 643     }
 644 }
 645
 646 fn never_loop_expr(expr: &Expr<'_>, main_loop_id: HirId) -> NeverLoopResult {
 647     match expr.kind {
 648         ExprKind::Box(ref e)
 649         | ExprKind::Unary(_, ref e)
 650         | ExprKind::Cast(ref e, _)
 651         | ExprKind::Type(ref e, _)
 652         | ExprKind::Field(ref e, _)
 653         | ExprKind::AddrOf(_, _, ref e)
 654         | ExprKind::Struct(_, _, Some(ref e))
 655         | ExprKind::Repeat(ref e, _)
 656         | ExprKind::DropTemps(ref e) => never_loop_expr(e, main_loop_id),
 657         ExprKind::Array(ref es) | ExprKind::MethodCall(_, _, ref es, _) | ExprKind::Tup(ref es) => {
 658             never_loop_expr_all(&mut es.iter(), main_loop_id)
 659         },
 660         ExprKind::Call(ref e, ref es) => never_loop_expr_all(&mut once(&**e).chain(es.iter()), main_loop_id),
 661         ExprKind::Binary(_, ref e1, ref e2)
 662         | ExprKind::Assign(ref e1, ref e2, _)
 663         | ExprKind::AssignOp(_, ref e1, ref e2)
 664         | ExprKind::Index(ref e1, ref e2) => never_loop_expr_all(&mut [&**e1, &**e2].iter().cloned(), main_loop_id),
 665         ExprKind::Loop(ref b, _, _) => {
 666             // Break can come from the inner loop so remove them.
 667             absorb_break(&never_loop_block(b, main_loop_id))
 668         },
 669         ExprKind::Match(ref e, ref arms, _) => {
 670             let e = never_loop_expr(e, main_loop_id);
 671             if arms.is_empty() {
 672                 e
 673             } else {
 674                 let arms = never_loop_expr_branch(&mut arms.iter().map(|a| &*a.body), main_loop_id);
 675                 combine_seq(e, arms)
 676             }
 677         },
 678         ExprKind::Block(ref b, _) => never_loop_block(b, main_loop_id),
 679         ExprKind::Continue(d) => {
 680             let id = d
 681                 .target_id
 682                 .expect("target ID can only be missing in the presence of compilation errors");
 683             if id == main_loop_id {
 684                 NeverLoopResult::MayContinueMainLoop
 685             } else {
 686                 NeverLoopResult::AlwaysBreak
 687             }
 688         },
 689         ExprKind::Break(_, ref e) | ExprKind::Ret(ref e) => e.as_ref().map_or(NeverLoopResult::AlwaysBreak, |e| {
 690             combine_seq(never_loop_expr(e, main_loop_id), NeverLoopResult::AlwaysBreak)
 691         }),
 692         ExprKind::InlineAsm(ref asm) => asm
 693             .operands
 694             .iter()
 695             .map(|o| match o {
 696                 InlineAsmOperand::In { expr, .. }
 697                 | InlineAsmOperand::InOut { expr, .. }
 698                 | InlineAsmOperand::Const { expr }
 699                 | InlineAsmOperand::Sym { expr } => never_loop_expr(expr, main_loop_id),
 700                 InlineAsmOperand::Out { expr, .. } => never_loop_expr_all(&mut expr.iter(), main_loop_id),
 701                 InlineAsmOperand::SplitInOut { in_expr, out_expr, .. } => {
 702                     never_loop_expr_all(&mut once(in_expr).chain(out_expr.iter()), main_loop_id)
 703                 },
 704             })
 705             .fold(NeverLoopResult::Otherwise, combine_both),
 706         ExprKind::Struct(_, _, None)
 707         | ExprKind::Yield(_, _)
 708         | ExprKind::Closure(_, _, _, _, _)
 709         | ExprKind::LlvmInlineAsm(_)
 710         | ExprKind::Path(_)
 711         | ExprKind::Lit(_)
 712         | ExprKind::Err => NeverLoopResult::Otherwise,
 713     }
 714 }
 715
 716 fn never_loop_expr_seq<'a, T: Iterator<Item = &'a Expr<'a>>>(es: &mut T, main_loop_id: HirId) -> NeverLoopResult {
 717     es.map(|e| never_loop_expr(e, main_loop_id))
 718         .fold(NeverLoopResult::Otherwise, combine_seq)
 719 }
 720
 721 fn never_loop_expr_all<'a, T: Iterator<Item = &'a Expr<'a>>>(es: &mut T, main_loop_id: HirId) -> NeverLoopResult {
 722     es.map(|e| never_loop_expr(e, main_loop_id))
 723         .fold(NeverLoopResult::Otherwise, combine_both)
 724 }
 725
 726 fn never_loop_expr_branch<'a, T: Iterator<Item = &'a Expr<'a>>>(e: &mut T, main_loop_id: HirId) -> NeverLoopResult {
 727     e.map(|e| never_loop_expr(e, main_loop_id))
 728         .fold(NeverLoopResult::AlwaysBreak, combine_branches)
 729 }
 730
 731 fn check_for_loop<'tcx>(
 732     cx: &LateContext<'tcx>,
 733     pat: &'tcx Pat<'_>,
 734     arg: &'tcx Expr<'_>,
 735     body: &'tcx Expr<'_>,
 736     expr: &'tcx Expr<'_>,
 737 ) {
 738     check_for_loop_range(cx, pat, arg, body, expr);
 739     check_for_loop_arg(cx, pat, arg, expr);
 740     check_for_loop_explicit_counter(cx, pat, arg, body, expr);
 741     check_for_loop_over_map_kv(cx, pat, arg, body, expr);
 742     check_for_mut_range_bound(cx, arg, body);
 743     detect_manual_memcpy(cx, pat, arg, body, expr);
 744 }
 745
 746 fn same_var<'tcx>(cx: &LateContext<'tcx>, expr: &Expr<'_>, var: HirId) -> bool {
 747     if_chain! {
 748         if let ExprKind::Path(qpath) = &expr.kind;
 749         if let QPath::Resolved(None, path) = qpath;
 750         if path.segments.len() == 1;
 751         if let Res::Local(local_id) = qpath_res(cx, qpath, expr.hir_id);
 752         then {
 753             // our variable!
 754             local_id == var
 755         } else {
 756             false
 757         }
 758     }
 759 }
 760
 761 #[derive(Clone, Copy)]
 762 enum OffsetSign {
 763     Positive,
 764     Negative,
 765 }
 766
 767 struct Offset {
 768     value: String,
 769     sign: OffsetSign,
 770 }
 771
 772 impl Offset {
 773     fn negative(value: String) -> Self {
 774         Self {
 775             value,
 776             sign: OffsetSign::Negative,
 777         }
 778     }
 779
 780     fn positive(value: String) -> Self {
 781         Self {
 782             value,
 783             sign: OffsetSign::Positive,
 784         }
 785     }
 786 }
 787
 788 struct FixedOffsetVar<'hir> {
 789     var: &'hir Expr<'hir>,
 790     offset: Offset,
 791 }
 792
 793 fn is_slice_like<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'_>) -> bool {
 794     let is_slice = match ty.kind {
 795         ty::Ref(_, subty, _) => is_slice_like(cx, subty),
 796         ty::Slice(..) | ty::Array(..) => true,
 797         _ => false,
 798     };
 799
 800     is_slice || is_type_diagnostic_item(cx, ty, sym!(vec_type)) || is_type_diagnostic_item(cx, ty, sym!(vecdeque_type))
 801 }
 802
 803 fn fetch_cloned_expr<'tcx>(expr: &'tcx Expr<'tcx>) -> &'tcx Expr<'tcx> {
 804     if_chain! {
 805         if let ExprKind::MethodCall(method, _, args, _) = expr.kind;
 806         if method.ident.name == sym!(clone);
 807         if args.len() == 1;
 808         if let Some(arg) = args.get(0);
 809         then { arg } else { expr }
 810     }
 811 }
 812
 813 fn get_offset<'tcx>(cx: &LateContext<'tcx>, idx: &Expr<'_>, var: HirId) -> Option<Offset> {
 814     fn extract_offset<'tcx>(cx: &LateContext<'tcx>, e: &Expr<'_>, var: HirId) -> Option<String> {
 815         match &e.kind {
 816             ExprKind::Lit(l) => match l.node {
 817                 ast::LitKind::Int(x, _ty) => Some(x.to_string()),
 818                 _ => None,
 819             },
 820             ExprKind::Path(..) if !same_var(cx, e, var) => Some(snippet_opt(cx, e.span).unwrap_or_else(|| "??".into())),
 821             _ => None,
 822         }
 823     }
 824
 825     match idx.kind {
 826         ExprKind::Binary(op, lhs, rhs) => match op.node {
 827             BinOpKind::Add => {
 828                 let offset_opt = if same_var(cx, lhs, var) {
 829                     extract_offset(cx, rhs, var)
 830                 } else if same_var(cx, rhs, var) {
 831                     extract_offset(cx, lhs, var)
 832                 } else {
 833                     None
 834                 };
 835
 836                 offset_opt.map(Offset::positive)
 837             },
 838             BinOpKind::Sub if same_var(cx, lhs, var) => extract_offset(cx, rhs, var).map(Offset::negative),
 839             _ => None,
 840         },
 841         ExprKind::Path(..) if same_var(cx, idx, var) => Some(Offset::positive("0".into())),
 842         _ => None,
 843     }
 844 }
 845
 846 fn get_assignments<'tcx>(body: &'tcx Expr<'tcx>) -> impl Iterator<Item = Option<(&'tcx Expr<'tcx>, &'tcx Expr<'tcx>)>> {
 847     fn get_assignment<'tcx>(e: &'tcx Expr<'tcx>) -> Option<(&'tcx Expr<'tcx>, &'tcx Expr<'tcx>)> {
 848         if let ExprKind::Assign(lhs, rhs, _) = e.kind {
 849             Some((lhs, rhs))
 850         } else {
 851             None
 852         }
 853     }
 854
 855     // This is one of few ways to return different iterators
 856     // derived from: https://stackoverflow.com/questions/29760668/conditionally-iterate-over-one-of-several-possible-iterators/52064434#52064434
 857     let mut iter_a = None;
 858     let mut iter_b = None;
 859
 860     if let ExprKind::Block(b, _) = body.kind {
 861         let Block { stmts, expr, .. } = *b;
 862
 863         iter_a = stmts
 864             .iter()
 865             .filter_map(|stmt| match stmt.kind {
 866                 StmtKind::Local(..) | StmtKind::Item(..) => None,
 867                 StmtKind::Expr(e) | StmtKind::Semi(e) => Some(e),
 868             })
 869             .chain(expr.into_iter())
 870             .map(get_assignment)
 871             .into()
 872     } else {
 873         iter_b = Some(get_assignment(body))
 874     }
 875
 876     iter_a.into_iter().flatten().chain(iter_b.into_iter())
 877 }
 878
 879 fn build_manual_memcpy_suggestion<'tcx>(
 880     cx: &LateContext<'tcx>,
 881     start: &Expr<'_>,
 882     end: &Expr<'_>,
 883     limits: ast::RangeLimits,
 884     dst_var: FixedOffsetVar<'_>,
 885     src_var: FixedOffsetVar<'_>,
 886 ) -> String {
 887     fn print_sum(arg1: &str, arg2: &Offset) -> String {
 888         match (arg1, &arg2.value[..], arg2.sign) {
 889             ("0", "0", _) => "0".into(),
 890             ("0", x, OffsetSign::Positive) | (x, "0", _) => x.into(),
 891             ("0", x, OffsetSign::Negative) => format!("-{}", x),
 892             (x, y, OffsetSign::Positive) => format!("({} + {})", x, y),
 893             (x, y, OffsetSign::Negative) => {
 894                 if x == y {
 895                     "0".into()
 896                 } else {
 897                     format!("({} - {})", x, y)
 898                 }
 899             },
 900         }
 901     }
 902
 903     fn print_offset(start_str: &str, inline_offset: &Offset) -> String {
 904         let offset = print_sum(start_str, inline_offset);
 905         if offset.as_str() == "0" {
 906             "".into()
 907         } else {
 908             offset
 909         }
 910     }
 911
 912     let print_limit = |end: &Expr<'_>, offset: Offset, var: &Expr<'_>| {
 913         if_chain! {
 914             if let ExprKind::MethodCall(method, _, len_args, _) = end.kind;
 915             if method.ident.name == sym!(len);
 916             if len_args.len() == 1;
 917             if let Some(arg) = len_args.get(0);
 918             if var_def_id(cx, arg) == var_def_id(cx, var);
 919             then {
 920                 match offset.sign {
 921                     OffsetSign::Negative => format!("({} - {})", snippet(cx, end.span, "<src>.len()"), offset.value),
 922                     OffsetSign::Positive => "".into(),
 923                 }
 924             } else {
 925                 let end_str = match limits {
 926                     ast::RangeLimits::Closed => {
 927                         let end = sugg::Sugg::hir(cx, end, "<count>");
 928                         format!("{}", end + sugg::ONE)
 929                     },
 930                     ast::RangeLimits::HalfOpen => format!("{}", snippet(cx, end.span, "..")),
 931                 };
 932
 933                 print_sum(&end_str, &offset)
 934             }
 935         }
 936     };
 937
 938     let start_str = snippet(cx, start.span, "").to_string();
 939     let dst_offset = print_offset(&start_str, &dst_var.offset);
 940     let dst_limit = print_limit(end, dst_var.offset, dst_var.var);
 941     let src_offset = print_offset(&start_str, &src_var.offset);
 942     let src_limit = print_limit(end, src_var.offset, src_var.var);
 943
 944     let dst_var_name = snippet_opt(cx, dst_var.var.span).unwrap_or_else(|| "???".into());
 945     let src_var_name = snippet_opt(cx, src_var.var.span).unwrap_or_else(|| "???".into());
 946
 947     let dst = if dst_offset == "" && dst_limit == "" {
 948         dst_var_name
 949     } else {
 950         format!("{}[{}..{}]", dst_var_name, dst_offset, dst_limit)
 951     };
 952
 953     format!(
 954         "{}.clone_from_slice(&{}[{}..{}])",
 955         dst, src_var_name, src_offset, src_limit
 956     )
 957 }
 958 /// Checks for for loops that sequentially copy items from one slice-like
 959 /// object to another.
 960 fn detect_manual_memcpy<'tcx>(
 961     cx: &LateContext<'tcx>,
 962     pat: &'tcx Pat<'_>,
 963     arg: &'tcx Expr<'_>,
 964     body: &'tcx Expr<'_>,
 965     expr: &'tcx Expr<'_>,
 966 ) {
 967     if let Some(higher::Range {
 968         start: Some(start),
 969         end: Some(end),
 970         limits,
 971     }) = higher::range(cx, arg)
 972     {
 973         // the var must be a single name
 974         if let PatKind::Binding(_, canonical_id, _, _) = pat.kind {
 975             // The only statements in the for loops can be indexed assignments from
 976             // indexed retrievals.
 977             let big_sugg = get_assignments(body)
 978                 .map(|o| {
 979                     o.and_then(|(lhs, rhs)| {
 980                         let rhs = fetch_cloned_expr(rhs);
 981                         if_chain! {
 982                             if let ExprKind::Index(seqexpr_left, idx_left) = lhs.kind;
 983                             if let ExprKind::Index(seqexpr_right, idx_right) = rhs.kind;
 984                             if is_slice_like(cx, cx.typeck_results().expr_ty(seqexpr_left))
 985                                 && is_slice_like(cx, cx.typeck_results().expr_ty(seqexpr_right));
 986                             if let Some(offset_left) = get_offset(cx, &idx_left, canonical_id);
 987                             if let Some(offset_right) = get_offset(cx, &idx_right, canonical_id);
 988
 989                             // Source and destination must be different
 990                             if var_def_id(cx, seqexpr_left) != var_def_id(cx, seqexpr_right);
 991                             then {
 992                                 Some((FixedOffsetVar { var: seqexpr_left, offset: offset_left },
 993                                     FixedOffsetVar { var: seqexpr_right, offset: offset_right }))
 994                             } else {
 995                                 None
 996                             }
 997                         }
 998                     })
 999                 })
1000                 .map(|o| o.map(|(dst, src)| build_manual_memcpy_suggestion(cx, start, end, limits, dst, src)))
1001                 .collect::<Option<Vec<_>>>()
1002                 .filter(|v| !v.is_empty())
1003                 .map(|v| v.join("\n    "));
1004
1005             if let Some(big_sugg) = big_sugg {
1006                 span_lint_and_sugg(
1007                     cx,
1008                     MANUAL_MEMCPY,
1009                     expr.span,
1010                     "it looks like you're manually copying between slices",
1011                     "try replacing the loop by",
1012                     big_sugg,
1013                     Applicability::Unspecified,
1014                 );
1015             }
1016         }
1017     }
1018 }
1019
1020 /// Checks for looping over a range and then indexing a sequence with it.
1021 /// The iteratee must be a range literal.
1022 #[allow(clippy::too_many_lines)]
1023 fn check_for_loop_range<'tcx>(
1024     cx: &LateContext<'tcx>,
1025     pat: &'tcx Pat<'_>,
1026     arg: &'tcx Expr<'_>,
1027     body: &'tcx Expr<'_>,
1028     expr: &'tcx Expr<'_>,
1029 ) {
1030     if let Some(higher::Range {
1031         start: Some(start),
1032         ref end,
1033         limits,
1034     }) = higher::range(cx, arg)
1035     {
1036         // the var must be a single name
1037         if let PatKind::Binding(_, canonical_id, ident, _) = pat.kind {
1038             let mut visitor = VarVisitor {
1039                 cx,
1040                 var: canonical_id,
1041                 indexed_mut: FxHashSet::default(),
1042                 indexed_indirectly: FxHashMap::default(),
1043                 indexed_directly: FxHashMap::default(),
1044                 referenced: FxHashSet::default(),
1045                 nonindex: false,
1046                 prefer_mutable: false,
1047             };
1048             walk_expr(&mut visitor, body);
1049
1050             // linting condition: we only indexed one variable, and indexed it directly
1051             if visitor.indexed_indirectly.is_empty() && visitor.indexed_directly.len() == 1 {
1052                 let (indexed, (indexed_extent, indexed_ty)) = visitor
1053                     .indexed_directly
1054                     .into_iter()
1055                     .next()
1056                     .expect("already checked that we have exactly 1 element");
1057
1058                 // ensure that the indexed variable was declared before the loop, see #601
1059                 if let Some(indexed_extent) = indexed_extent {
1060                     let parent_id = cx.tcx.hir().get_parent_item(expr.hir_id);
1061                     let parent_def_id = cx.tcx.hir().local_def_id(parent_id);
1062                     let region_scope_tree = cx.tcx.region_scope_tree(parent_def_id);
1063                     let pat_extent = region_scope_tree.var_scope(pat.hir_id.local_id);
1064                     if region_scope_tree.is_subscope_of(indexed_extent, pat_extent) {
1065                         return;
1066                     }
1067                 }
1068
1069                 // don't lint if the container that is indexed does not have .iter() method
1070                 let has_iter = has_iter_method(cx, indexed_ty);
1071                 if has_iter.is_none() {
1072                     return;
1073                 }
1074
1075                 // don't lint if the container that is indexed into is also used without
1076                 // indexing
1077                 if visitor.referenced.contains(&indexed) {
1078                     return;
1079                 }
1080
1081                 let starts_at_zero = is_integer_const(cx, start, 0);
1082
1083                 let skip = if starts_at_zero {
1084                     String::new()
1085                 } else {
1086                     format!(".skip({})", snippet(cx, start.span, ".."))
1087                 };
1088
1089                 let mut end_is_start_plus_val = false;
1090
1091                 let take = if let Some(end) = *end {
1092                     let mut take_expr = end;
1093
1094                     if let ExprKind::Binary(ref op, ref left, ref right) = end.kind {
1095                         if let BinOpKind::Add = op.node {
1096                             let start_equal_left = SpanlessEq::new(cx).eq_expr(start, left);
1097                             let start_equal_right = SpanlessEq::new(cx).eq_expr(start, right);
1098
1099                             if start_equal_left {
1100                                 take_expr = right;
1101                             } else if start_equal_right {
1102                                 take_expr = left;
1103                             }
1104
1105                             end_is_start_plus_val = start_equal_left | start_equal_right;
1106                         }
1107                     }
1108
1109                     if is_len_call(end, indexed) || is_end_eq_array_len(cx, end, limits, indexed_ty) {
1110                         String::new()
1111                     } else {
1112                         match limits {
1113                             ast::RangeLimits::Closed => {
1114                                 let take_expr = sugg::Sugg::hir(cx, take_expr, "<count>");
1115                                 format!(".take({})", take_expr + sugg::ONE)
1116                             },
1117                             ast::RangeLimits::HalfOpen => format!(".take({})", snippet(cx, take_expr.span, "..")),
1118                         }
1119                     }
1120                 } else {
1121                     String::new()
1122                 };
1123
1124                 let (ref_mut, method) = if visitor.indexed_mut.contains(&indexed) {
1125                     ("mut ", "iter_mut")
1126                 } else {
1127                     ("", "iter")
1128                 };
1129
1130                 let take_is_empty = take.is_empty();
1131                 let mut method_1 = take;
1132                 let mut method_2 = skip;
1133
1134                 if end_is_start_plus_val {
1135                     mem::swap(&mut method_1, &mut method_2);
1136                 }
1137
1138                 if visitor.nonindex {
1139                     span_lint_and_then(
1140                         cx,
1141                         NEEDLESS_RANGE_LOOP,
1142                         expr.span,
1143                         &format!("the loop variable `{}` is used to index `{}`", ident.name, indexed),
1144                         |diag| {
1145                             multispan_sugg(
1146                                 diag,
1147                                 "consider using an iterator",
1148                                 vec![
1149                                     (pat.span, format!("({}, <item>)", ident.name)),
1150                                     (
1151                                         arg.span,
1152                                         format!("{}.{}().enumerate(){}{}", indexed, method, method_1, method_2),
1153                                     ),
1154                                 ],
1155                             );
1156                         },
1157                     );
1158                 } else {
1159                     let repl = if starts_at_zero && take_is_empty {
1160                         format!("&{}{}", ref_mut, indexed)
1161                     } else {
1162                         format!("{}.{}(){}{}", indexed, method, method_1, method_2)
1163                     };
1164
1165                     span_lint_and_then(
1166                         cx,
1167                         NEEDLESS_RANGE_LOOP,
1168                         expr.span,
1169                         &format!(
1170                             "the loop variable `{}` is only used to index `{}`.",
1171                             ident.name, indexed
1172                         ),
1173                         |diag| {
1174                             multispan_sugg(
1175                                 diag,
1176                                 "consider using an iterator",
1177                                 vec![(pat.span, "<item>".to_string()), (arg.span, repl)],
1178                             );
1179                         },
1180                     );
1181                 }
1182             }
1183         }
1184     }
1185 }
1186
1187 fn is_len_call(expr: &Expr<'_>, var: Name) -> bool {
1188     if_chain! {
1189         if let ExprKind::MethodCall(ref method, _, ref len_args, _) = expr.kind;
1190         if len_args.len() == 1;
1191         if method.ident.name == sym!(len);
1192         if let ExprKind::Path(QPath::Resolved(_, ref path)) = len_args[0].kind;
1193         if path.segments.len() == 1;
1194         if path.segments[0].ident.name == var;
1195         then {
1196             return true;
1197         }
1198     }
1199
1200     false
1201 }
1202
1203 fn is_end_eq_array_len<'tcx>(
1204     cx: &LateContext<'tcx>,
1205     end: &Expr<'_>,
1206     limits: ast::RangeLimits,
1207     indexed_ty: Ty<'tcx>,
1208 ) -> bool {
1209     if_chain! {
1210         if let ExprKind::Lit(ref lit) = end.kind;
1211         if let ast::LitKind::Int(end_int, _) = lit.node;
1212         if let ty::Array(_, arr_len_const) = indexed_ty.kind;
1213         if let Some(arr_len) = arr_len_const.try_eval_usize(cx.tcx, cx.param_env);
1214         then {
1215             return match limits {
1216                 ast::RangeLimits::Closed => end_int + 1 >= arr_len.into(),
1217                 ast::RangeLimits::HalfOpen => end_int >= arr_len.into(),
1218             };
1219         }
1220     }
1221
1222     false
1223 }
1224
1225 fn lint_iter_method(cx: &LateContext<'_>, args: &[Expr<'_>], arg: &Expr<'_>, method_name: &str) {
1226     let mut applicability = Applicability::MachineApplicable;
1227     let object = snippet_with_applicability(cx, args[0].span, "_", &mut applicability);
1228     let muta = if method_name == "iter_mut" { "mut " } else { "" };
1229     span_lint_and_sugg(
1230         cx,
1231         EXPLICIT_ITER_LOOP,
1232         arg.span,
1233         "it is more concise to loop over references to containers instead of using explicit \
1234          iteration methods",
1235         "to write this more concisely, try",
1236         format!("&{}{}", muta, object),
1237         applicability,
1238     )
1239 }
1240
1241 fn check_for_loop_arg(cx: &LateContext<'_>, pat: &Pat<'_>, arg: &Expr<'_>, expr: &Expr<'_>) {
1242     let mut next_loop_linted = false; // whether or not ITER_NEXT_LOOP lint was used
1243     if let ExprKind::MethodCall(ref method, _, ref args, _) = arg.kind {
1244         // just the receiver, no arguments
1245         if args.len() == 1 {
1246             let method_name = &*method.ident.as_str();
1247             // check for looping over x.iter() or x.iter_mut(), could use &x or &mut x
1248             if method_name == "iter" || method_name == "iter_mut" {
1249                 if is_ref_iterable_type(cx, &args[0]) {
1250                     lint_iter_method(cx, args, arg, method_name);
1251                 }
1252             } else if method_name == "into_iter" && match_trait_method(cx, arg, &paths::INTO_ITERATOR) {
1253                 let receiver_ty = cx.typeck_results().expr_ty(&args[0]);
1254                 let receiver_ty_adjusted = cx.typeck_results().expr_ty_adjusted(&args[0]);
1255                 if TyS::same_type(receiver_ty, receiver_ty_adjusted) {
1256                     let mut applicability = Applicability::MachineApplicable;
1257                     let object = snippet_with_applicability(cx, args[0].span, "_", &mut applicability);
1258                     span_lint_and_sugg(
1259                         cx,
1260                         EXPLICIT_INTO_ITER_LOOP,
1261                         arg.span,
1262                         "it is more concise to loop over containers instead of using explicit \
1263                          iteration methods",
1264                         "to write this more concisely, try",
1265                         object.to_string(),
1266                         applicability,
1267                     );
1268                 } else {
1269                     let ref_receiver_ty = cx.tcx.mk_ref(
1270                         cx.tcx.lifetimes.re_erased,
1271                         ty::TypeAndMut {
1272                             ty: receiver_ty,
1273                             mutbl: Mutability::Not,
1274                         },
1275                     );
1276                     if TyS::same_type(receiver_ty_adjusted, ref_receiver_ty) {
1277                         lint_iter_method(cx, args, arg, method_name)
1278                     }
1279                 }
1280             } else if method_name == "next" && match_trait_method(cx, arg, &paths::ITERATOR) {
1281                 span_lint(
1282                     cx,
1283                     ITER_NEXT_LOOP,
1284                     expr.span,
1285                     "you are iterating over `Iterator::next()` which is an Option; this will compile but is \
1286                     probably not what you want",
1287                 );
1288                 next_loop_linted = true;
1289             }
1290         }
1291     }
1292     if !next_loop_linted {
1293         check_arg_type(cx, pat, arg);
1294     }
1295 }
1296
1297 /// Checks for `for` loops over `Option`s and `Result`s.
1298 fn check_arg_type(cx: &LateContext<'_>, pat: &Pat<'_>, arg: &Expr<'_>) {
1299     let ty = cx.typeck_results().expr_ty(arg);
1300     if is_type_diagnostic_item(cx, ty, sym!(option_type)) {
1301         span_lint_and_help(
1302             cx,
1303             FOR_LOOPS_OVER_FALLIBLES,
1304             arg.span,
1305             &format!(
1306                 "for loop over `{0}`, which is an `Option`. This is more readably written as an \
1307                 `if let` statement.",
1308                 snippet(cx, arg.span, "_")
1309             ),
1310             None,
1311             &format!(
1312                 "consider replacing `for {0} in {1}` with `if let Some({0}) = {1}`",
1313                 snippet(cx, pat.span, "_"),
1314                 snippet(cx, arg.span, "_")
1315             ),
1316         );
1317     } else if is_type_diagnostic_item(cx, ty, sym!(result_type)) {
1318         span_lint_and_help(
1319             cx,
1320             FOR_LOOPS_OVER_FALLIBLES,
1321             arg.span,
1322             &format!(
1323                 "for loop over `{0}`, which is a `Result`. This is more readably written as an \
1324                 `if let` statement.",
1325                 snippet(cx, arg.span, "_")
1326             ),
1327             None,
1328             &format!(
1329                 "consider replacing `for {0} in {1}` with `if let Ok({0}) = {1}`",
1330                 snippet(cx, pat.span, "_"),
1331                 snippet(cx, arg.span, "_")
1332             ),
1333         );
1334     }
1335 }
1336
1337 fn check_for_loop_explicit_counter<'tcx>(
1338     cx: &LateContext<'tcx>,
1339     pat: &'tcx Pat<'_>,
1340     arg: &'tcx Expr<'_>,
1341     body: &'tcx Expr<'_>,
1342     expr: &'tcx Expr<'_>,
1343 ) {
1344     // Look for variables that are incremented once per loop iteration.
1345     let mut visitor = IncrementVisitor {
1346         cx,
1347         states: FxHashMap::default(),
1348         depth: 0,
1349         done: false,
1350     };
1351     walk_expr(&mut visitor, body);
1352
1353     // For each candidate, check the parent block to see if
1354     // it's initialized to zero at the start of the loop.
1355     if let Some(block) = get_enclosing_block(&cx, expr.hir_id) {
1356         for (id, _) in visitor.states.iter().filter(|&(_, v)| *v == VarState::IncrOnce) {
1357             let mut visitor2 = InitializeVisitor {
1358                 cx,
1359                 end_expr: expr,
1360                 var_id: *id,
1361                 state: VarState::IncrOnce,
1362                 name: None,
1363                 depth: 0,
1364                 past_loop: false,
1365             };
1366             walk_block(&mut visitor2, block);
1367
1368             if visitor2.state == VarState::Warn {
1369                 if let Some(name) = visitor2.name {
1370                     let mut applicability = Applicability::MachineApplicable;
1371
1372                     // for some reason this is the only way to get the `Span`
1373                     // of the entire `for` loop
1374                     let for_span = if let ExprKind::Match(_, arms, _) = &expr.kind {
1375                         arms[0].body.span
1376                     } else {
1377                         unreachable!()
1378                     };
1379
1380                     span_lint_and_sugg(
1381                         cx,
1382                         EXPLICIT_COUNTER_LOOP,
1383                         for_span.with_hi(arg.span.hi()),
1384                         &format!("the variable `{}` is used as a loop counter.", name),
1385                         "consider using",
1386                         format!(
1387                             "for ({}, {}) in {}.enumerate()",
1388                             name,
1389                             snippet_with_applicability(cx, pat.span, "item", &mut applicability),
1390                             make_iterator_snippet(cx, arg, &mut applicability),
1391                         ),
1392                         applicability,
1393                     );
1394                 }
1395             }
1396         }
1397     }
1398 }
1399
1400 /// If `arg` was the argument to a `for` loop, return the "cleanest" way of writing the
1401 /// actual `Iterator` that the loop uses.
1402 fn make_iterator_snippet(cx: &LateContext<'_>, arg: &Expr<'_>, applic_ref: &mut Applicability) -> String {
1403     let impls_iterator = get_trait_def_id(cx, &paths::ITERATOR).map_or(false, |id| {
1404         implements_trait(cx, cx.typeck_results().expr_ty(arg), id, &[])
1405     });
1406     if impls_iterator {
1407         format!(
1408             "{}",
1409             sugg::Sugg::hir_with_applicability(cx, arg, "_", applic_ref).maybe_par()
1410         )
1411     } else {
1412         // (&x).into_iter() ==> x.iter()
1413         // (&mut x).into_iter() ==> x.iter_mut()
1414         match &arg.kind {
1415             ExprKind::AddrOf(BorrowKind::Ref, mutability, arg_inner)
1416                 if has_iter_method(cx, cx.typeck_results().expr_ty(&arg_inner)).is_some() =>
1417             {
1418                 let meth_name = match mutability {
1419                     Mutability::Mut => "iter_mut",
1420                     Mutability::Not => "iter",
1421                 };
1422                 format!(
1423                     "{}.{}()",
1424                     sugg::Sugg::hir_with_applicability(cx, &arg_inner, "_", applic_ref).maybe_par(),
1425                     meth_name,
1426                 )
1427             }
1428             _ => format!(
1429                 "{}.into_iter()",
1430                 sugg::Sugg::hir_with_applicability(cx, arg, "_", applic_ref).maybe_par()
1431             ),
1432         }
1433     }
1434 }
1435
1436 /// Checks for the `FOR_KV_MAP` lint.
1437 fn check_for_loop_over_map_kv<'tcx>(
1438     cx: &LateContext<'tcx>,
1439     pat: &'tcx Pat<'_>,
1440     arg: &'tcx Expr<'_>,
1441     body: &'tcx Expr<'_>,
1442     expr: &'tcx Expr<'_>,
1443 ) {
1444     let pat_span = pat.span;
1445
1446     if let PatKind::Tuple(ref pat, _) = pat.kind {
1447         if pat.len() == 2 {
1448             let arg_span = arg.span;
1449             let (new_pat_span, kind, ty, mutbl) = match cx.typeck_results().expr_ty(arg).kind {
1450                 ty::Ref(_, ty, mutbl) => match (&pat[0].kind, &pat[1].kind) {
1451                     (key, _) if pat_is_wild(key, body) => (pat[1].span, "value", ty, mutbl),
1452                     (_, value) if pat_is_wild(value, body) => (pat[0].span, "key", ty, Mutability::Not),
1453                     _ => return,
1454                 },
1455                 _ => return,
1456             };
1457             let mutbl = match mutbl {
1458                 Mutability::Not => "",
1459                 Mutability::Mut => "_mut",
1460             };
1461             let arg = match arg.kind {
1462                 ExprKind::AddrOf(BorrowKind::Ref, _, ref expr) => &**expr,
1463                 _ => arg,
1464             };
1465
1466             if is_type_diagnostic_item(cx, ty, sym!(hashmap_type)) || match_type(cx, ty, &paths::BTREEMAP) {
1467                 span_lint_and_then(
1468                     cx,
1469                     FOR_KV_MAP,
1470                     expr.span,
1471                     &format!("you seem to want to iterate on a map's {}s", kind),
1472                     |diag| {
1473                         let map = sugg::Sugg::hir(cx, arg, "map");
1474                         multispan_sugg(
1475                             diag,
1476                             "use the corresponding method",
1477                             vec![
1478                                 (pat_span, snippet(cx, new_pat_span, kind).into_owned()),
1479                                 (arg_span, format!("{}.{}s{}()", map.maybe_par(), kind, mutbl)),
1480                             ],
1481                         );
1482                     },
1483                 );
1484             }
1485         }
1486     }
1487 }
1488
1489 struct MutatePairDelegate<'a, 'tcx> {
1490     cx: &'a LateContext<'tcx>,
1491     hir_id_low: Option<HirId>,
1492     hir_id_high: Option<HirId>,
1493     span_low: Option<Span>,
1494     span_high: Option<Span>,
1495 }
1496
1497 impl<'tcx> Delegate<'tcx> for MutatePairDelegate<'_, 'tcx> {
1498     fn consume(&mut self, _: &PlaceWithHirId<'tcx>, _: ConsumeMode) {}
1499
1500     fn borrow(&mut self, cmt: &PlaceWithHirId<'tcx>, bk: ty::BorrowKind) {
1501         if let ty::BorrowKind::MutBorrow = bk {
1502             if let PlaceBase::Local(id) = cmt.place.base {
1503                 if Some(id) == self.hir_id_low {
1504                     self.span_low = Some(self.cx.tcx.hir().span(cmt.hir_id))
1505                 }
1506                 if Some(id) == self.hir_id_high {
1507                     self.span_high = Some(self.cx.tcx.hir().span(cmt.hir_id))
1508                 }
1509             }
1510         }
1511     }
1512
1513     fn mutate(&mut self, cmt: &PlaceWithHirId<'tcx>) {
1514         if let PlaceBase::Local(id) = cmt.place.base {
1515             if Some(id) == self.hir_id_low {
1516                 self.span_low = Some(self.cx.tcx.hir().span(cmt.hir_id))
1517             }
1518             if Some(id) == self.hir_id_high {
1519                 self.span_high = Some(self.cx.tcx.hir().span(cmt.hir_id))
1520             }
1521         }
1522     }
1523 }
1524
1525 impl MutatePairDelegate<'_, '_> {
1526     fn mutation_span(&self) -> (Option<Span>, Option<Span>) {
1527         (self.span_low, self.span_high)
1528     }
1529 }
1530
1531 fn check_for_mut_range_bound(cx: &LateContext<'_>, arg: &Expr<'_>, body: &Expr<'_>) {
1532     if let Some(higher::Range {
1533         start: Some(start),
1534         end: Some(end),
1535         ..
1536     }) = higher::range(cx, arg)
1537     {
1538         let mut_ids = vec![check_for_mutability(cx, start), check_for_mutability(cx, end)];
1539         if mut_ids[0].is_some() || mut_ids[1].is_some() {
1540             let (span_low, span_high) = check_for_mutation(cx, body, &mut_ids);
1541             mut_warn_with_span(cx, span_low);
1542             mut_warn_with_span(cx, span_high);
1543         }
1544     }
1545 }
1546
1547 fn mut_warn_with_span(cx: &LateContext<'_>, span: Option<Span>) {
1548     if let Some(sp) = span {
1549         span_lint(
1550             cx,
1551             MUT_RANGE_BOUND,
1552             sp,
1553             "attempt to mutate range bound within loop; note that the range of the loop is unchanged",
1554         );
1555     }
1556 }
1557
1558 fn check_for_mutability(cx: &LateContext<'_>, bound: &Expr<'_>) -> Option<HirId> {
1559     if_chain! {
1560         if let ExprKind::Path(ref qpath) = bound.kind;
1561         if let QPath::Resolved(None, _) = *qpath;
1562         then {
1563             let res = qpath_res(cx, qpath, bound.hir_id);
1564             if let Res::Local(hir_id) = res {
1565                 let node_str = cx.tcx.hir().get(hir_id);
1566                 if_chain! {
1567                     if let Node::Binding(pat) = node_str;
1568                     if let PatKind::Binding(bind_ann, ..) = pat.kind;
1569                     if let BindingAnnotation::Mutable = bind_ann;
1570                     then {
1571                         return Some(hir_id);
1572                     }
1573                 }
1574             }
1575         }
1576     }
1577     None
1578 }
1579
1580 fn check_for_mutation<'tcx>(
1581     cx: &LateContext<'tcx>,
1582     body: &Expr<'_>,
1583     bound_ids: &[Option<HirId>],
1584 ) -> (Option<Span>, Option<Span>) {
1585     let mut delegate = MutatePairDelegate {
1586         cx,
1587         hir_id_low: bound_ids[0],
1588         hir_id_high: bound_ids[1],
1589         span_low: None,
1590         span_high: None,
1591     };
1592     let def_id = body.hir_id.owner.to_def_id();
1593     cx.tcx.infer_ctxt().enter(|infcx| {
1594         ExprUseVisitor::new(
1595             &mut delegate,
1596             &infcx,
1597             def_id.expect_local(),
1598             cx.param_env,
1599             cx.typeck_results(),
1600         )
1601         .walk_expr(body);
1602     });
1603     delegate.mutation_span()
1604 }
1605
1606 /// Returns `true` if the pattern is a `PatWild` or an ident prefixed with `_`.
1607 fn pat_is_wild<'tcx>(pat: &'tcx PatKind<'_>, body: &'tcx Expr<'_>) -> bool {
1608     match *pat {
1609         PatKind::Wild => true,
1610         PatKind::Binding(.., ident, None) if ident.as_str().starts_with('_') => is_unused(&ident, body),
1611         _ => false,
1612     }
1613 }
1614
1615 struct LocalUsedVisitor<'a, 'tcx> {
1616     cx: &'a LateContext<'tcx>,
1617     local: HirId,
1618     used: bool,
1619 }
1620
1621 impl<'a, 'tcx> Visitor<'tcx> for LocalUsedVisitor<'a, 'tcx> {
1622     type Map = Map<'tcx>;
1623
1624     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
1625         if same_var(self.cx, expr, self.local) {
1626             self.used = true;
1627         } else {
1628             walk_expr(self, expr);
1629         }
1630     }
1631
1632     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
1633         NestedVisitorMap::None
1634     }
1635 }
1636
1637 struct VarVisitor<'a, 'tcx> {
1638     /// context reference
1639     cx: &'a LateContext<'tcx>,
1640     /// var name to look for as index
1641     var: HirId,
1642     /// indexed variables that are used mutably
1643     indexed_mut: FxHashSet<Name>,
1644     /// indirectly indexed variables (`v[(i + 4) % N]`), the extend is `None` for global
1645     indexed_indirectly: FxHashMap<Name, Option<region::Scope>>,
1646     /// subset of `indexed` of vars that are indexed directly: `v[i]`
1647     /// this will not contain cases like `v[calc_index(i)]` or `v[(i + 4) % N]`
1648     indexed_directly: FxHashMap<Name, (Option<region::Scope>, Ty<'tcx>)>,
1649     /// Any names that are used outside an index operation.
1650     /// Used to detect things like `&mut vec` used together with `vec[i]`
1651     referenced: FxHashSet<Name>,
1652     /// has the loop variable been used in expressions other than the index of
1653     /// an index op?
1654     nonindex: bool,
1655     /// Whether we are inside the `$` in `&mut $` or `$ = foo` or `$.bar`, where bar
1656     /// takes `&mut self`
1657     prefer_mutable: bool,
1658 }
1659
1660 impl<'a, 'tcx> VarVisitor<'a, 'tcx> {
1661     fn check(&mut self, idx: &'tcx Expr<'_>, seqexpr: &'tcx Expr<'_>, expr: &'tcx Expr<'_>) -> bool {
1662         if_chain! {
1663             // the indexed container is referenced by a name
1664             if let ExprKind::Path(ref seqpath) = seqexpr.kind;
1665             if let QPath::Resolved(None, ref seqvar) = *seqpath;
1666             if seqvar.segments.len() == 1;
1667             then {
1668                 let index_used_directly = same_var(self.cx, idx, self.var);
1669                 let indexed_indirectly = {
1670                     let mut used_visitor = LocalUsedVisitor {
1671                         cx: self.cx,
1672                         local: self.var,
1673                         used: false,
1674                     };
1675                     walk_expr(&mut used_visitor, idx);
1676                     used_visitor.used
1677                 };
1678
1679                 if indexed_indirectly || index_used_directly {
1680                     if self.prefer_mutable {
1681                         self.indexed_mut.insert(seqvar.segments[0].ident.name);
1682                     }
1683                     let res = qpath_res(self.cx, seqpath, seqexpr.hir_id);
1684                     match res {
1685                         Res::Local(hir_id) => {
1686                             let parent_id = self.cx.tcx.hir().get_parent_item(expr.hir_id);
1687                             let parent_def_id = self.cx.tcx.hir().local_def_id(parent_id);
1688                             let extent = self.cx.tcx.region_scope_tree(parent_def_id).var_scope(hir_id.local_id);
1689                             if indexed_indirectly {
1690                                 self.indexed_indirectly.insert(seqvar.segments[0].ident.name, Some(extent));
1691                             }
1692                             if index_used_directly {
1693                                 self.indexed_directly.insert(
1694                                     seqvar.segments[0].ident.name,
1695                                     (Some(extent), self.cx.typeck_results().node_type(seqexpr.hir_id)),
1696                                 );
1697                             }
1698                             return false;  // no need to walk further *on the variable*
1699                         }
1700                         Res::Def(DefKind::Static | DefKind::Const, ..) => {
1701                             if indexed_indirectly {
1702                                 self.indexed_indirectly.insert(seqvar.segments[0].ident.name, None);
1703                             }
1704                             if index_used_directly {
1705                                 self.indexed_directly.insert(
1706                                     seqvar.segments[0].ident.name,
1707                                     (None, self.cx.typeck_results().node_type(seqexpr.hir_id)),
1708                                 );
1709                             }
1710                             return false;  // no need to walk further *on the variable*
1711                         }
1712                         _ => (),
1713                     }
1714                 }
1715             }
1716         }
1717         true
1718     }
1719 }
1720
1721 impl<'a, 'tcx> Visitor<'tcx> for VarVisitor<'a, 'tcx> {
1722     type Map = Map<'tcx>;
1723
1724     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
1725         if_chain! {
1726             // a range index op
1727             if let ExprKind::MethodCall(ref meth, _, ref args, _) = expr.kind;
1728             if (meth.ident.name == sym!(index) && match_trait_method(self.cx, expr, &paths::INDEX))
1729                 || (meth.ident.name == sym!(index_mut) && match_trait_method(self.cx, expr, &paths::INDEX_MUT));
1730             if !self.check(&args[1], &args[0], expr);
1731             then { return }
1732         }
1733
1734         if_chain! {
1735             // an index op
1736             if let ExprKind::Index(ref seqexpr, ref idx) = expr.kind;
1737             if !self.check(idx, seqexpr, expr);
1738             then { return }
1739         }
1740
1741         if_chain! {
1742             // directly using a variable
1743             if let ExprKind::Path(ref qpath) = expr.kind;
1744             if let QPath::Resolved(None, ref path) = *qpath;
1745             if path.segments.len() == 1;
1746             then {
1747                 if let Res::Local(local_id) = qpath_res(self.cx, qpath, expr.hir_id) {
1748                     if local_id == self.var {
1749                         self.nonindex = true;
1750                     } else {
1751                         // not the correct variable, but still a variable
1752                         self.referenced.insert(path.segments[0].ident.name);
1753                     }
1754                 }
1755             }
1756         }
1757
1758         let old = self.prefer_mutable;
1759         match expr.kind {
1760             ExprKind::AssignOp(_, ref lhs, ref rhs) | ExprKind::Assign(ref lhs, ref rhs, _) => {
1761                 self.prefer_mutable = true;
1762                 self.visit_expr(lhs);
1763                 self.prefer_mutable = false;
1764                 self.visit_expr(rhs);
1765             },
1766             ExprKind::AddrOf(BorrowKind::Ref, mutbl, ref expr) => {
1767                 if mutbl == Mutability::Mut {
1768                     self.prefer_mutable = true;
1769                 }
1770                 self.visit_expr(expr);
1771             },
1772             ExprKind::Call(ref f, args) => {
1773                 self.visit_expr(f);
1774                 for expr in args {
1775                     let ty = self.cx.typeck_results().expr_ty_adjusted(expr);
1776                     self.prefer_mutable = false;
1777                     if let ty::Ref(_, _, mutbl) = ty.kind {
1778                         if mutbl == Mutability::Mut {
1779                             self.prefer_mutable = true;
1780                         }
1781                     }
1782                     self.visit_expr(expr);
1783                 }
1784             },
1785             ExprKind::MethodCall(_, _, args, _) => {
1786                 let def_id = self.cx.typeck_results().type_dependent_def_id(expr.hir_id).unwrap();
1787                 for (ty, expr) in self.cx.tcx.fn_sig(def_id).inputs().skip_binder().iter().zip(args) {
1788                     self.prefer_mutable = false;
1789                     if let ty::Ref(_, _, mutbl) = ty.kind {
1790                         if mutbl == Mutability::Mut {
1791                             self.prefer_mutable = true;
1792                         }
1793                     }
1794                     self.visit_expr(expr);
1795                 }
1796             },
1797             ExprKind::Closure(_, _, body_id, ..) => {
1798                 let body = self.cx.tcx.hir().body(body_id);
1799                 self.visit_expr(&body.value);
1800             },
1801             _ => walk_expr(self, expr),
1802         }
1803         self.prefer_mutable = old;
1804     }
1805     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
1806         NestedVisitorMap::None
1807     }
1808 }
1809
1810 fn is_used_inside<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>, container: &'tcx Expr<'_>) -> bool {
1811     let def_id = match var_def_id(cx, expr) {
1812         Some(id) => id,
1813         None => return false,
1814     };
1815     if let Some(used_mutably) = mutated_variables(container, cx) {
1816         if used_mutably.contains(&def_id) {
1817             return true;
1818         }
1819     }
1820     false
1821 }
1822
1823 fn is_iterator_used_after_while_let<'tcx>(cx: &LateContext<'tcx>, iter_expr: &'tcx Expr<'_>) -> bool {
1824     let def_id = match var_def_id(cx, iter_expr) {
1825         Some(id) => id,
1826         None => return false,
1827     };
1828     let mut visitor = VarUsedAfterLoopVisitor {
1829         cx,
1830         def_id,
1831         iter_expr_id: iter_expr.hir_id,
1832         past_while_let: false,
1833         var_used_after_while_let: false,
1834     };
1835     if let Some(enclosing_block) = get_enclosing_block(cx, def_id) {
1836         walk_block(&mut visitor, enclosing_block);
1837     }
1838     visitor.var_used_after_while_let
1839 }
1840
1841 struct VarUsedAfterLoopVisitor<'a, 'tcx> {
1842     cx: &'a LateContext<'tcx>,
1843     def_id: HirId,
1844     iter_expr_id: HirId,
1845     past_while_let: bool,
1846     var_used_after_while_let: bool,
1847 }
1848
1849 impl<'a, 'tcx> Visitor<'tcx> for VarUsedAfterLoopVisitor<'a, 'tcx> {
1850     type Map = Map<'tcx>;
1851
1852     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
1853         if self.past_while_let {
1854             if Some(self.def_id) == var_def_id(self.cx, expr) {
1855                 self.var_used_after_while_let = true;
1856             }
1857         } else if self.iter_expr_id == expr.hir_id {
1858             self.past_while_let = true;
1859         }
1860         walk_expr(self, expr);
1861     }
1862     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
1863         NestedVisitorMap::None
1864     }
1865 }
1866
1867 /// Returns `true` if the type of expr is one that provides `IntoIterator` impls
1868 /// for `&T` and `&mut T`, such as `Vec`.
1869 #[rustfmt::skip]
1870 fn is_ref_iterable_type(cx: &LateContext<'_>, e: &Expr<'_>) -> bool {
1871     // no walk_ptrs_ty: calling iter() on a reference can make sense because it
1872     // will allow further borrows afterwards
1873     let ty = cx.typeck_results().expr_ty(e);
1874     is_iterable_array(ty, cx) ||
1875     is_type_diagnostic_item(cx, ty, sym!(vec_type)) ||
1876     match_type(cx, ty, &paths::LINKED_LIST) ||
1877     is_type_diagnostic_item(cx, ty, sym!(hashmap_type)) ||
1878     is_type_diagnostic_item(cx, ty, sym!(hashset_type)) ||
1879     is_type_diagnostic_item(cx, ty, sym!(vecdeque_type)) ||
1880     match_type(cx, ty, &paths::BINARY_HEAP) ||
1881     match_type(cx, ty, &paths::BTREEMAP) ||
1882     match_type(cx, ty, &paths::BTREESET)
1883 }
1884
1885 fn is_iterable_array<'tcx>(ty: Ty<'tcx>, cx: &LateContext<'tcx>) -> bool {
1886     // IntoIterator is currently only implemented for array sizes <= 32 in rustc
1887     match ty.kind {
1888         ty::Array(_, n) => n
1889             .try_eval_usize(cx.tcx, cx.param_env)
1890             .map_or(false, |val| (0..=32).contains(&val)),
1891         _ => false,
1892     }
1893 }
1894
1895 /// If a block begins with a statement (possibly a `let` binding) and has an
1896 /// expression, return it.
1897 fn extract_expr_from_first_stmt<'tcx>(block: &Block<'tcx>) -> Option<&'tcx Expr<'tcx>> {
1898     if block.stmts.is_empty() {
1899         return None;
1900     }
1901     if let StmtKind::Local(ref local) = block.stmts[0].kind {
1902         local.init //.map(|expr| expr)
1903     } else {
1904         None
1905     }
1906 }
1907
1908 /// If a block begins with an expression (with or without semicolon), return it.
1909 fn extract_first_expr<'tcx>(block: &Block<'tcx>) -> Option<&'tcx Expr<'tcx>> {
1910     match block.expr {
1911         Some(ref expr) if block.stmts.is_empty() => Some(expr),
1912         None if !block.stmts.is_empty() => match block.stmts[0].kind {
1913             StmtKind::Expr(ref expr) | StmtKind::Semi(ref expr) => Some(expr),
1914             StmtKind::Local(..) | StmtKind::Item(..) => None,
1915         },
1916         _ => None,
1917     }
1918 }
1919
1920 /// Returns `true` if expr contains a single break expr without destination label
1921 /// and
1922 /// passed expression. The expression may be within a block.
1923 fn is_simple_break_expr(expr: &Expr<'_>) -> bool {
1924     match expr.kind {
1925         ExprKind::Break(dest, ref passed_expr) if dest.label.is_none() && passed_expr.is_none() => true,
1926         ExprKind::Block(ref b, _) => extract_first_expr(b).map_or(false, |subexpr| is_simple_break_expr(subexpr)),
1927         _ => false,
1928     }
1929 }
1930
1931 // To trigger the EXPLICIT_COUNTER_LOOP lint, a variable must be
1932 // incremented exactly once in the loop body, and initialized to zero
1933 // at the start of the loop.
1934 #[derive(Debug, PartialEq)]
1935 enum VarState {
1936     Initial,  // Not examined yet
1937     IncrOnce, // Incremented exactly once, may be a loop counter
1938     Declared, // Declared but not (yet) initialized to zero
1939     Warn,
1940     DontWarn,
1941 }
1942
1943 /// Scan a for loop for variables that are incremented exactly once.
1944 struct IncrementVisitor<'a, 'tcx> {
1945     cx: &'a LateContext<'tcx>,          // context reference
1946     states: FxHashMap<HirId, VarState>, // incremented variables
1947     depth: u32,                         // depth of conditional expressions
1948     done: bool,
1949 }
1950
1951 impl<'a, 'tcx> Visitor<'tcx> for IncrementVisitor<'a, 'tcx> {
1952     type Map = Map<'tcx>;
1953
1954     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
1955         if self.done {
1956             return;
1957         }
1958
1959         // If node is a variable
1960         if let Some(def_id) = var_def_id(self.cx, expr) {
1961             if let Some(parent) = get_parent_expr(self.cx, expr) {
1962                 let state = self.states.entry(def_id).or_insert(VarState::Initial);
1963
1964                 match parent.kind {
1965                     ExprKind::AssignOp(op, ref lhs, ref rhs) => {
1966                         if lhs.hir_id == expr.hir_id {
1967                             if op.node == BinOpKind::Add && is_integer_const(self.cx, rhs, 1) {
1968                                 *state = match *state {
1969                                     VarState::Initial if self.depth == 0 => VarState::IncrOnce,
1970                                     _ => VarState::DontWarn,
1971                                 };
1972                             } else {
1973                                 // Assigned some other value
1974                                 *state = VarState::DontWarn;
1975                             }
1976                         }
1977                     },
1978                     ExprKind::Assign(ref lhs, _, _) if lhs.hir_id == expr.hir_id => *state = VarState::DontWarn,
1979                     ExprKind::AddrOf(BorrowKind::Ref, mutability, _) if mutability == Mutability::Mut => {
1980                         *state = VarState::DontWarn
1981                     },
1982                     _ => (),
1983                 }
1984             }
1985         } else if is_loop(expr) || is_conditional(expr) {
1986             self.depth += 1;
1987             walk_expr(self, expr);
1988             self.depth -= 1;
1989             return;
1990         } else if let ExprKind::Continue(_) = expr.kind {
1991             self.done = true;
1992             return;
1993         }
1994         walk_expr(self, expr);
1995     }
1996     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
1997         NestedVisitorMap::None
1998     }
1999 }
2000
2001 /// Checks whether a variable is initialized to zero at the start of a loop.
2002 struct InitializeVisitor<'a, 'tcx> {
2003     cx: &'a LateContext<'tcx>,  // context reference
2004     end_expr: &'tcx Expr<'tcx>, // the for loop. Stop scanning here.
2005     var_id: HirId,
2006     state: VarState,
2007     name: Option<Name>,
2008     depth: u32, // depth of conditional expressions
2009     past_loop: bool,
2010 }
2011
2012 impl<'a, 'tcx> Visitor<'tcx> for InitializeVisitor<'a, 'tcx> {
2013     type Map = Map<'tcx>;
2014
2015     fn visit_stmt(&mut self, stmt: &'tcx Stmt<'_>) {
2016         // Look for declarations of the variable
2017         if let StmtKind::Local(ref local) = stmt.kind {
2018             if local.pat.hir_id == self.var_id {
2019                 if let PatKind::Binding(.., ident, _) = local.pat.kind {
2020                     self.name = Some(ident.name);
2021
2022                     self.state = local.init.as_ref().map_or(VarState::Declared, |init| {
2023                         if is_integer_const(&self.cx, init, 0) {
2024                             VarState::Warn
2025                         } else {
2026                             VarState::Declared
2027                         }
2028                     })
2029                 }
2030             }
2031         }
2032         walk_stmt(self, stmt);
2033     }
2034
2035     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
2036         if self.state == VarState::DontWarn {
2037             return;
2038         }
2039         if expr.hir_id == self.end_expr.hir_id {
2040             self.past_loop = true;
2041             return;
2042         }
2043         // No need to visit expressions before the variable is
2044         // declared
2045         if self.state == VarState::IncrOnce {
2046             return;
2047         }
2048
2049         // If node is the desired variable, see how it's used
2050         if var_def_id(self.cx, expr) == Some(self.var_id) {
2051             if let Some(parent) = get_parent_expr(self.cx, expr) {
2052                 match parent.kind {
2053                     ExprKind::AssignOp(_, ref lhs, _) if lhs.hir_id == expr.hir_id => {
2054                         self.state = VarState::DontWarn;
2055                     },
2056                     ExprKind::Assign(ref lhs, ref rhs, _) if lhs.hir_id == expr.hir_id => {
2057                         self.state = if is_integer_const(&self.cx, rhs, 0) && self.depth == 0 {
2058                             VarState::Warn
2059                         } else {
2060                             VarState::DontWarn
2061                         }
2062                     },
2063                     ExprKind::AddrOf(BorrowKind::Ref, mutability, _) if mutability == Mutability::Mut => {
2064                         self.state = VarState::DontWarn
2065                     },
2066                     _ => (),
2067                 }
2068             }
2069
2070             if self.past_loop {
2071                 self.state = VarState::DontWarn;
2072                 return;
2073             }
2074         } else if !self.past_loop && is_loop(expr) {
2075             self.state = VarState::DontWarn;
2076             return;
2077         } else if is_conditional(expr) {
2078             self.depth += 1;
2079             walk_expr(self, expr);
2080             self.depth -= 1;
2081             return;
2082         }
2083         walk_expr(self, expr);
2084     }
2085
2086     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
2087         NestedVisitorMap::OnlyBodies(self.cx.tcx.hir())
2088     }
2089 }
2090
2091 fn var_def_id(cx: &LateContext<'_>, expr: &Expr<'_>) -> Option<HirId> {
2092     if let ExprKind::Path(ref qpath) = expr.kind {
2093         let path_res = qpath_res(cx, qpath, expr.hir_id);
2094         if let Res::Local(hir_id) = path_res {
2095             return Some(hir_id);
2096         }
2097     }
2098     None
2099 }
2100
2101 fn is_loop(expr: &Expr<'_>) -> bool {
2102     matches!(expr.kind, ExprKind::Loop(..))
2103 }
2104
2105 fn is_conditional(expr: &Expr<'_>) -> bool {
2106     matches!(expr.kind, ExprKind::Match(..))
2107 }
2108
2109 fn is_nested(cx: &LateContext<'_>, match_expr: &Expr<'_>, iter_expr: &Expr<'_>) -> bool {
2110     if_chain! {
2111         if let Some(loop_block) = get_enclosing_block(cx, match_expr.hir_id);
2112         let parent_node = cx.tcx.hir().get_parent_node(loop_block.hir_id);
2113         if let Some(Node::Expr(loop_expr)) = cx.tcx.hir().find(parent_node);
2114         then {
2115             return is_loop_nested(cx, loop_expr, iter_expr)
2116         }
2117     }
2118     false
2119 }
2120
2121 fn is_loop_nested(cx: &LateContext<'_>, loop_expr: &Expr<'_>, iter_expr: &Expr<'_>) -> bool {
2122     let mut id = loop_expr.hir_id;
2123     let iter_name = if let Some(name) = path_name(iter_expr) {
2124         name
2125     } else {
2126         return true;
2127     };
2128     loop {
2129         let parent = cx.tcx.hir().get_parent_node(id);
2130         if parent == id {
2131             return false;
2132         }
2133         match cx.tcx.hir().find(parent) {
2134             Some(Node::Expr(expr)) => {
2135                 if let ExprKind::Loop(..) = expr.kind {
2136                     return true;
2137                 };
2138             },
2139             Some(Node::Block(block)) => {
2140                 let mut block_visitor = LoopNestVisitor {
2141                     hir_id: id,
2142                     iterator: iter_name,
2143                     nesting: Unknown,
2144                 };
2145                 walk_block(&mut block_visitor, block);
2146                 if block_visitor.nesting == RuledOut {
2147                     return false;
2148                 }
2149             },
2150             Some(Node::Stmt(_)) => (),
2151             _ => {
2152                 return false;
2153             },
2154         }
2155         id = parent;
2156     }
2157 }
2158
2159 #[derive(PartialEq, Eq)]
2160 enum Nesting {
2161     Unknown,     // no nesting detected yet
2162     RuledOut,    // the iterator is initialized or assigned within scope
2163     LookFurther, // no nesting detected, no further walk required
2164 }
2165
2166 use self::Nesting::{LookFurther, RuledOut, Unknown};
2167
2168 struct LoopNestVisitor {
2169     hir_id: HirId,
2170     iterator: Name,
2171     nesting: Nesting,
2172 }
2173
2174 impl<'tcx> Visitor<'tcx> for LoopNestVisitor {
2175     type Map = Map<'tcx>;
2176
2177     fn visit_stmt(&mut self, stmt: &'tcx Stmt<'_>) {
2178         if stmt.hir_id == self.hir_id {
2179             self.nesting = LookFurther;
2180         } else if self.nesting == Unknown {
2181             walk_stmt(self, stmt);
2182         }
2183     }
2184
2185     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
2186         if self.nesting != Unknown {
2187             return;
2188         }
2189         if expr.hir_id == self.hir_id {
2190             self.nesting = LookFurther;
2191             return;
2192         }
2193         match expr.kind {
2194             ExprKind::Assign(ref path, _, _) | ExprKind::AssignOp(_, ref path, _) => {
2195                 if match_var(path, self.iterator) {
2196                     self.nesting = RuledOut;
2197                 }
2198             },
2199             _ => walk_expr(self, expr),
2200         }
2201     }
2202
2203     fn visit_pat(&mut self, pat: &'tcx Pat<'_>) {
2204         if self.nesting != Unknown {
2205             return;
2206         }
2207         if let PatKind::Binding(.., span_name, _) = pat.kind {
2208             if self.iterator == span_name.name {
2209                 self.nesting = RuledOut;
2210                 return;
2211             }
2212         }
2213         walk_pat(self, pat)
2214     }
2215
2216     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
2217         NestedVisitorMap::None
2218     }
2219 }
2220
2221 fn path_name(e: &Expr<'_>) -> Option<Name> {
2222     if let ExprKind::Path(QPath::Resolved(_, ref path)) = e.kind {
2223         let segments = &path.segments;
2224         if segments.len() == 1 {
2225             return Some(segments[0].ident.name);
2226         }
2227     };
2228     None
2229 }
2230
2231 fn check_infinite_loop<'tcx>(cx: &LateContext<'tcx>, cond: &'tcx Expr<'_>, expr: &'tcx Expr<'_>) {
2232     if constant(cx, cx.typeck_results(), cond).is_some() {
2233         // A pure constant condition (e.g., `while false`) is not linted.
2234         return;
2235     }
2236
2237     let mut var_visitor = VarCollectorVisitor {
2238         cx,
2239         ids: FxHashSet::default(),
2240         def_ids: FxHashMap::default(),
2241         skip: false,
2242     };
2243     var_visitor.visit_expr(cond);
2244     if var_visitor.skip {
2245         return;
2246     }
2247     let used_in_condition = &var_visitor.ids;
2248     let no_cond_variable_mutated = if let Some(used_mutably) = mutated_variables(expr, cx) {
2249         used_in_condition.is_disjoint(&used_mutably)
2250     } else {
2251         return;
2252     };
2253     let mutable_static_in_cond = var_visitor.def_ids.iter().any(|(_, v)| *v);
2254
2255     let mut has_break_or_return_visitor = HasBreakOrReturnVisitor {
2256         has_break_or_return: false,
2257     };
2258     has_break_or_return_visitor.visit_expr(expr);
2259     let has_break_or_return = has_break_or_return_visitor.has_break_or_return;
2260
2261     if no_cond_variable_mutated && !mutable_static_in_cond {
2262         span_lint_and_then(
2263             cx,
2264             WHILE_IMMUTABLE_CONDITION,
2265             cond.span,
2266             "variables in the condition are not mutated in the loop body",
2267             |diag| {
2268                 diag.note("this may lead to an infinite or to a never running loop");
2269
2270                 if has_break_or_return {
2271                     diag.note("this loop contains `return`s or `break`s");
2272                     diag.help("rewrite it as `if cond { loop { } }`");
2273                 }
2274             },
2275         );
2276     }
2277 }
2278
2279 struct HasBreakOrReturnVisitor {
2280     has_break_or_return: bool,
2281 }
2282
2283 impl<'tcx> Visitor<'tcx> for HasBreakOrReturnVisitor {
2284     type Map = Map<'tcx>;
2285
2286     fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
2287         if self.has_break_or_return {
2288             return;
2289         }
2290
2291         match expr.kind {
2292             ExprKind::Ret(_) | ExprKind::Break(_, _) => {
2293                 self.has_break_or_return = true;
2294                 return;
2295             },
2296             _ => {},
2297         }
2298
2299         walk_expr(self, expr);
2300     }
2301
2302     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
2303         NestedVisitorMap::None
2304     }
2305 }
2306
2307 /// Collects the set of variables in an expression
2308 /// Stops analysis if a function call is found
2309 /// Note: In some cases such as `self`, there are no mutable annotation,
2310 /// All variables definition IDs are collected
2311 struct VarCollectorVisitor<'a, 'tcx> {
2312     cx: &'a LateContext<'tcx>,
2313     ids: FxHashSet<HirId>,
2314     def_ids: FxHashMap<def_id::DefId, bool>,
2315     skip: bool,
2316 }
2317
2318 impl<'a, 'tcx> VarCollectorVisitor<'a, 'tcx> {
2319     fn insert_def_id(&mut self, ex: &'tcx Expr<'_>) {
2320         if_chain! {
2321             if let ExprKind::Path(ref qpath) = ex.kind;
2322             if let QPath::Resolved(None, _) = *qpath;
2323             let res = qpath_res(self.cx, qpath, ex.hir_id);
2324             then {
2325                 match res {
2326                     Res::Local(hir_id) => {
2327                         self.ids.insert(hir_id);
2328                     },
2329                     Res::Def(DefKind::Static, def_id) => {
2330                         let mutable = self.cx.tcx.is_mutable_static(def_id);
2331                         self.def_ids.insert(def_id, mutable);
2332                     },
2333                     _ => {},
2334                 }
2335             }
2336         }
2337     }
2338 }
2339
2340 impl<'a, 'tcx> Visitor<'tcx> for VarCollectorVisitor<'a, 'tcx> {
2341     type Map = Map<'tcx>;
2342
2343     fn visit_expr(&mut self, ex: &'tcx Expr<'_>) {
2344         match ex.kind {
2345             ExprKind::Path(_) => self.insert_def_id(ex),
2346             // If there is any function/method call… we just stop analysis
2347             ExprKind::Call(..) | ExprKind::MethodCall(..) => self.skip = true,
2348
2349             _ => walk_expr(self, ex),
2350         }
2351     }
2352
2353     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
2354         NestedVisitorMap::None
2355     }
2356 }
2357
2358 const NEEDLESS_COLLECT_MSG: &str = "avoid using `collect()` when not needed";
2359
2360 fn check_needless_collect<'tcx>(expr: &'tcx Expr<'_>, cx: &LateContext<'tcx>) {
2361     if_chain! {
2362         if let ExprKind::MethodCall(ref method, _, ref args, _) = expr.kind;
2363         if let ExprKind::MethodCall(ref chain_method, _, _, _) = args[0].kind;
2364         if chain_method.ident.name == sym!(collect) && match_trait_method(cx, &args[0], &paths::ITERATOR);
2365         if let Some(ref generic_args) = chain_method.args;
2366         if let Some(GenericArg::Type(ref ty)) = generic_args.args.get(0);
2367         then {
2368             let ty = cx.typeck_results().node_type(ty.hir_id);
2369             if is_type_diagnostic_item(cx, ty, sym!(vec_type)) ||
2370                 is_type_diagnostic_item(cx, ty, sym!(vecdeque_type)) ||
2371                 match_type(cx, ty, &paths::BTREEMAP) ||
2372                 is_type_diagnostic_item(cx, ty, sym!(hashmap_type)) {
2373                 if method.ident.name == sym!(len) {
2374                     let span = shorten_span(expr, sym!(collect));
2375                     span_lint_and_sugg(
2376                         cx,
2377                         NEEDLESS_COLLECT,
2378                         span,
2379                         NEEDLESS_COLLECT_MSG,
2380                         "replace with",
2381                         "count()".to_string(),
2382                         Applicability::MachineApplicable,
2383                     );
2384                 }
2385                 if method.ident.name == sym!(is_empty) {
2386                     let span = shorten_span(expr, sym!(iter));
2387                     span_lint_and_sugg(
2388                         cx,
2389                         NEEDLESS_COLLECT,
2390                         span,
2391                         NEEDLESS_COLLECT_MSG,
2392                         "replace with",
2393                         "get(0).is_none()".to_string(),
2394                         Applicability::MachineApplicable,
2395                     );
2396                 }
2397                 if method.ident.name == sym!(contains) {
2398                     let contains_arg = snippet(cx, args[1].span, "??");
2399                     let span = shorten_span(expr, sym!(collect));
2400                     span_lint_and_then(
2401                         cx,
2402                         NEEDLESS_COLLECT,
2403                         span,
2404                         NEEDLESS_COLLECT_MSG,
2405                         |diag| {
2406                             let (arg, pred) = if contains_arg.starts_with('&') {
2407                                 ("x", &contains_arg[1..])
2408                             } else {
2409                                 ("&x", &*contains_arg)
2410                             };
2411                             diag.span_suggestion(
2412                                 span,
2413                                 "replace with",
2414                                 format!(
2415                                     "any(|{}| x == {})",
2416                                     arg, pred
2417                                 ),
2418                                 Applicability::MachineApplicable,
2419                             );
2420                         }
2421                     );
2422                 }
2423             }
2424         }
2425     }
2426 }
2427
2428 fn shorten_span(expr: &Expr<'_>, target_fn_name: Symbol) -> Span {
2429     let mut current_expr = expr;
2430     while let ExprKind::MethodCall(ref path, ref span, ref args, _) = current_expr.kind {
2431         if path.ident.name == target_fn_name {
2432             return expr.span.with_lo(span.lo());
2433         }
2434         current_expr = &args[0];
2435     }
2436     unreachable!()
2437 }