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