clippy_lints/src/loops.rs

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