clippy_lints/src/loops.rs

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