clippy_lints/src/question_mark.rs

   1 // Copyright 2014-2018 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution.
   3 //
   4 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   5 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   7 // option. This file may not be copied, modified, or distributed
   8 // except according to those terms.
   9
  10 use crate::rustc::hir::def::Def;
  11 use crate::rustc::hir::*;
  12 use crate::rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
  13 use crate::rustc::{declare_tool_lint, lint_array};
  14 use crate::syntax::ptr::P;
  15 use crate::utils::sugg::Sugg;
  16 use if_chain::if_chain;
  17
  18 use crate::rustc_errors::Applicability;
  19 use crate::utils::paths::*;
  20 use crate::utils::{match_def_path, match_type, span_lint_and_then, SpanlessEq};
  21
  22 /// **What it does:** Checks for expressions that could be replaced by the question mark operator
  23 ///
  24 /// **Why is this bad?** Question mark usage is more idiomatic
  25 ///
  26 /// **Known problems:** None
  27 ///
  28 /// **Example:**
  29 /// ```rust
  30 /// if option.is_none() {
  31 ///     return None;
  32 /// }
  33 /// ```
  34 ///
  35 /// Could be written:
  36 ///
  37 /// ```rust
  38 /// option?;
  39 /// ```
  40 declare_clippy_lint! {
  41     pub QUESTION_MARK,
  42     style,
  43     "checks for expressions that could be replaced by the question mark operator"
  44 }
  45
  46 #[derive(Copy, Clone)]
  47 pub struct Pass;
  48
  49 impl LintPass for Pass {
  50     fn get_lints(&self) -> LintArray {
  51         lint_array!(QUESTION_MARK)
  52     }
  53 }
  54
  55 impl Pass {
  56     /// Check if the given expression on the given context matches the following structure:
  57     ///
  58     /// ```ignore
  59     /// if option.is_none() {
  60     ///    return None;
  61     /// }
  62     /// ```
  63     ///
  64     /// If it matches, it will suggest to use the question mark operator instead
  65     fn check_is_none_and_early_return_none(cx: &LateContext<'_, '_>, expr: &Expr) {
  66         if_chain! {
  67             if let ExprKind::If(if_expr, body, else_) = &expr.node;
  68             if let ExprKind::MethodCall(segment, _, args) = &if_expr.node;
  69             if segment.ident.name == "is_none";
  70             if Self::expression_returns_none(cx, body);
  71             if let Some(subject) = args.get(0);
  72             if Self::is_option(cx, subject);
  73
  74             then {
  75                 let receiver_str = &Sugg::hir(cx, subject, "..");
  76                 let mut replacement_str = String::new();
  77                 if let Some(else_) = else_ {
  78                     if_chain! {
  79                         if let ExprKind::Block(block, None) = &else_.node;
  80                         if block.stmts.len() == 0;
  81                         if let Some(block_expr) = &block.expr;
  82                         if SpanlessEq::new(cx).ignore_fn().eq_expr(subject, block_expr);
  83                         then {
  84                             replacement_str = format!("Some({}?)", receiver_str);
  85                         }
  86                     }
  87                 } else if Self::moves_by_default(cx, subject) {
  88                         replacement_str = format!("{}.as_ref()?;", receiver_str);
  89                 } else {
  90                         replacement_str = format!("{}?;", receiver_str);
  91                 }
  92                 span_lint_and_then(
  93                     cx,
  94                     QUESTION_MARK,
  95                     expr.span,
  96                     "this block may be rewritten with the `?` operator",
  97                     |db| {
  98                         db.span_suggestion_with_applicability(
  99                             expr.span,
 100                             "replace_it_with",
 101                             replacement_str,
 102                             Applicability::MaybeIncorrect, // snippet
 103                         );
 104                     }
 105                 )
 106             }
 107         }
 108     }
 109
 110     fn moves_by_default(cx: &LateContext<'_, '_>, expression: &Expr) -> bool {
 111         let expr_ty = cx.tables.expr_ty(expression);
 112
 113         expr_ty.moves_by_default(cx.tcx, cx.param_env, expression.span)
 114     }
 115
 116     fn is_option(cx: &LateContext<'_, '_>, expression: &Expr) -> bool {
 117         let expr_ty = cx.tables.expr_ty(expression);
 118
 119         match_type(cx, expr_ty, &OPTION)
 120     }
 121
 122     fn expression_returns_none(cx: &LateContext<'_, '_>, expression: &Expr) -> bool {
 123         match expression.node {
 124             ExprKind::Block(ref block, _) => {
 125                 if let Some(return_expression) = Self::return_expression(block) {
 126                     return Self::expression_returns_none(cx, &return_expression);
 127                 }
 128
 129                 false
 130             },
 131             ExprKind::Ret(Some(ref expr)) => Self::expression_returns_none(cx, expr),
 132             ExprKind::Path(ref qp) => {
 133                 if let Def::VariantCtor(def_id, _) = cx.tables.qpath_def(qp, expression.hir_id) {
 134                     return match_def_path(cx.tcx, def_id, &OPTION_NONE);
 135                 }
 136
 137                 false
 138             },
 139             _ => false,
 140         }
 141     }
 142
 143     fn return_expression(block: &Block) -> Option<P<Expr>> {
 144         // Check if last expression is a return statement. Then, return the expression
 145         if_chain! {
 146             if block.stmts.len() == 1;
 147             if let Some(expr) = block.stmts.iter().last();
 148             if let StmtKind::Semi(ref expr, _) = expr.node;
 149             if let ExprKind::Ret(ref ret_expr) = expr.node;
 150             if let &Some(ref ret_expr) = ret_expr;
 151
 152             then {
 153                 return Some(ret_expr.clone());
 154             }
 155         }
 156
 157         // Check for `return` without a semicolon.
 158         if_chain! {
 159             if block.stmts.len() == 0;
 160             if let Some(ExprKind::Ret(Some(ret_expr))) = block.expr.as_ref().map(|e| &e.node);
 161             then {
 162                 return Some(ret_expr.clone());
 163             }
 164         }
 165
 166         None
 167     }
 168 }
 169
 170 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Pass {
 171     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
 172         Self::check_is_none_and_early_return_none(cx, expr);
 173     }
 174 }