clippy_lints/src/loops/while_let_loop.rs

   1 use super::WHILE_LET_LOOP;
   2 use clippy_utils::diagnostics::span_lint_and_sugg;
   3 use clippy_utils::higher;
   4 use clippy_utils::source::snippet_with_applicability;
   5 use clippy_utils::ty::needs_ordered_drop;
   6 use clippy_utils::visitors::any_temporaries_need_ordered_drop;
   7 use rustc_errors::Applicability;
   8 use rustc_hir::{Block, Expr, ExprKind, Local, MatchSource, Pat, StmtKind};
   9 use rustc_lint::LateContext;
  10
  11 pub(super) fn check<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>, loop_block: &'tcx Block<'_>) {
  12     let (init, has_trailing_exprs) = match (loop_block.stmts, loop_block.expr) {
  13         ([stmt, stmts @ ..], expr) => {
  14             if let StmtKind::Local(&Local { init: Some(e), els: None, .. }) | StmtKind::Semi(e) | StmtKind::Expr(e) = stmt.kind {
  15                 (e, !stmts.is_empty() || expr.is_some())
  16             } else {
  17                 return;
  18             }
  19         },
  20         ([], Some(e)) => (e, false),
  21         _ => return,
  22     };
  23
  24     if let Some(if_let) = higher::IfLet::hir(cx, init)
  25         && let Some(else_expr) = if_let.if_else
  26         && is_simple_break_expr(else_expr)
  27     {
  28         could_be_while_let(cx, expr, if_let.let_pat, if_let.let_expr, has_trailing_exprs);
  29     } else if let ExprKind::Match(scrutinee, [arm1, arm2], MatchSource::Normal) = init.kind
  30         && arm1.guard.is_none()
  31         && arm2.guard.is_none()
  32         && is_simple_break_expr(arm2.body)
  33     {
  34         could_be_while_let(cx, expr, arm1.pat, scrutinee, has_trailing_exprs);
  35     }
  36 }
  37
  38 /// Returns `true` if expr contains a single break expression without a label or eub-expression.
  39 fn is_simple_break_expr(e: &Expr<'_>) -> bool {
  40     matches!(peel_blocks(e).kind, ExprKind::Break(dest, None) if dest.label.is_none())
  41 }
  42
  43 /// Removes any blocks containing only a single expression.
  44 fn peel_blocks<'tcx>(e: &'tcx Expr<'tcx>) -> &'tcx Expr<'tcx> {
  45     if let ExprKind::Block(b, _) = e.kind {
  46         match (b.stmts, b.expr) {
  47             ([s], None) => {
  48                 if let StmtKind::Expr(e) | StmtKind::Semi(e) = s.kind {
  49                     peel_blocks(e)
  50                 } else {
  51                     e
  52                 }
  53             },
  54             ([], Some(e)) => peel_blocks(e),
  55             _ => e,
  56         }
  57     } else {
  58         e
  59     }
  60 }
  61
  62 fn could_be_while_let<'tcx>(
  63     cx: &LateContext<'tcx>,
  64     expr: &'tcx Expr<'_>,
  65     let_pat: &'tcx Pat<'_>,
  66     let_expr: &'tcx Expr<'_>,
  67     has_trailing_exprs: bool,
  68 ) {
  69     if has_trailing_exprs
  70         && (needs_ordered_drop(cx, cx.typeck_results().expr_ty(let_expr))
  71             || any_temporaries_need_ordered_drop(cx, let_expr))
  72     {
  73         // Switching to a `while let` loop will extend the lifetime of some values.
  74         return;
  75     }
  76
  77     // NOTE: we used to build a body here instead of using
  78     // ellipsis, this was removed because:
  79     // 1) it was ugly with big bodies;
  80     // 2) it was not indented properly;
  81     // 3) it wasn’t very smart (see #675).
  82     let mut applicability = Applicability::HasPlaceholders;
  83     span_lint_and_sugg(
  84         cx,
  85         WHILE_LET_LOOP,
  86         expr.span,
  87         "this loop could be written as a `while let` loop",
  88         "try",
  89         format!(
  90             "while let {} = {} {{ .. }}",
  91             snippet_with_applicability(cx, let_pat.span, "..", &mut applicability),
  92             snippet_with_applicability(cx, let_expr.span, "..", &mut applicability),
  93         ),
  94         applicability,
  95     );
  96 }