clippy_lints/src/loops.rs

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