clippy_lints/src/collapsible_if.rs

   1 //! Checks for if expressions that contain only an if expression.
   2 //!
   3 //! For example, the lint would catch:
   4 //!
   5 //! ```rust,ignore
   6 //! if x {
   7 //!     if y {
   8 //!         println!("Hello world");
   9 //!     }
  10 //! }
  11 //! ```
  12 //!
  13 //! This lint is **warn** by default
  14
  15 use crate::rustc::lint::{EarlyContext, EarlyLintPass, LintArray, LintPass};
  16 use crate::rustc::{declare_tool_lint, lint_array};
  17 use if_chain::if_chain;
  18 use crate::syntax::ast;
  19
  20 use crate::utils::{in_macro, snippet_block, span_lint_and_sugg, span_lint_and_then};
  21 use crate::utils::sugg::Sugg;
  22 use crate::rustc_errors::Applicability;
  23
  24 /// **What it does:** Checks for nested `if` statements which can be collapsed
  25 /// by `&&`-combining their conditions and for `else { if ... }` expressions
  26 /// that
  27 /// can be collapsed to `else if ...`.
  28 ///
  29 /// **Why is this bad?** Each `if`-statement adds one level of nesting, which
  30 /// makes code look more complex than it really is.
  31 ///
  32 /// **Known problems:** None.
  33 ///
  34 /// **Example:**
  35 /// ```rust,ignore
  36 /// if x {
  37 ///     if y {
  38 ///         …
  39 ///     }
  40 /// }
  41 ///
  42 /// // or
  43 ///
  44 /// if x {
  45 ///     …
  46 /// } else {
  47 ///     if y {
  48 ///         …
  49 ///     }
  50 /// }
  51 /// ```
  52 ///
  53 /// Should be written:
  54 ///
  55 /// ```rust.ignore
  56 /// if x && y {
  57 ///     …
  58 /// }
  59 ///
  60 /// // or
  61 ///
  62 /// if x {
  63 ///     …
  64 /// } else if y {
  65 ///     …
  66 /// }
  67 /// ```
  68 declare_clippy_lint! {
  69     pub COLLAPSIBLE_IF,
  70     style,
  71     "`if`s that can be collapsed (e.g. `if x { if y { ... } }` and `else { if x { ... } }`)"
  72 }
  73
  74 #[derive(Copy, Clone)]
  75 pub struct CollapsibleIf;
  76
  77 impl LintPass for CollapsibleIf {
  78     fn get_lints(&self) -> LintArray {
  79         lint_array!(COLLAPSIBLE_IF)
  80     }
  81 }
  82
  83 impl EarlyLintPass for CollapsibleIf {
  84     fn check_expr(&mut self, cx: &EarlyContext<'_>, expr: &ast::Expr) {
  85         if !in_macro(expr.span) {
  86             check_if(cx, expr)
  87         }
  88     }
  89 }
  90
  91 fn check_if(cx: &EarlyContext<'_>, expr: &ast::Expr) {
  92     match expr.node {
  93         ast::ExprKind::If(ref check, ref then, ref else_) => if let Some(ref else_) = *else_ {
  94             check_collapsible_maybe_if_let(cx, else_);
  95         } else {
  96             check_collapsible_no_if_let(cx, expr, check, then);
  97         },
  98         ast::ExprKind::IfLet(_, _, _, Some(ref else_)) => {
  99             check_collapsible_maybe_if_let(cx, else_);
 100         },
 101         _ => (),
 102     }
 103 }
 104
 105 fn check_collapsible_maybe_if_let(cx: &EarlyContext<'_>, else_: &ast::Expr) {
 106     if_chain! {
 107         if let ast::ExprKind::Block(ref block, _) = else_.node;
 108         if let Some(else_) = expr_block(block);
 109         if !in_macro(else_.span);
 110         then {
 111             match else_.node {
 112                 ast::ExprKind::If(..) | ast::ExprKind::IfLet(..) => {
 113                     span_lint_and_sugg(cx,
 114                                        COLLAPSIBLE_IF,
 115                                        block.span,
 116                                        "this `else { if .. }` block can be collapsed",
 117                                        "try",
 118                                        snippet_block(cx, else_.span, "..").into_owned());
 119                 }
 120                 _ => (),
 121             }
 122         }
 123     }
 124 }
 125
 126 fn check_collapsible_no_if_let(cx: &EarlyContext<'_>, expr: &ast::Expr, check: &ast::Expr, then: &ast::Block) {
 127     if_chain! {
 128         if let Some(inner) = expr_block(then);
 129         if let ast::ExprKind::If(ref check_inner, ref content, None) = inner.node;
 130         then {
 131             if expr.span.ctxt() != inner.span.ctxt() {
 132                 return;
 133             }
 134             span_lint_and_then(cx, COLLAPSIBLE_IF, expr.span, "this if statement can be collapsed", |db| {
 135                 let lhs = Sugg::ast(cx, check, "..");
 136                 let rhs = Sugg::ast(cx, check_inner, "..");
 137                 db.span_suggestion_with_applicability(
 138                     expr.span,
 139                     "try",
 140                     format!(
 141                         "if {} {}",
 142                         lhs.and(&rhs),
 143                         snippet_block(cx, content.span, ".."),
 144                     ),
 145                     Applicability::MachineApplicable, // snippet
 146                 );
 147             });
 148         }
 149     }
 150 }
 151
 152 /// If the block contains only one expression, return it.
 153 fn expr_block(block: &ast::Block) -> Option<&ast::Expr> {
 154     let mut it = block.stmts.iter();
 155
 156     if let (Some(stmt), None) = (it.next(), it.next()) {
 157         match stmt.node {
 158             ast::StmtKind::Expr(ref expr) | ast::StmtKind::Semi(ref expr) => Some(expr),
 159             _ => None,
 160         }
 161     } else {
 162         None
 163     }
 164 }