src/tools/clippy/clippy_lints/src/match_str_case_mismatch.rs

   1 use clippy_utils::diagnostics::span_lint_and_sugg;
   2 use clippy_utils::ty::is_type_diagnostic_item;
   3 use rustc_ast::ast::LitKind;
   4 use rustc_errors::Applicability;
   5 use rustc_hir::intravisit::{walk_expr, NestedVisitorMap, Visitor};
   6 use rustc_hir::{Arm, Expr, ExprKind, MatchSource, PatKind};
   7 use rustc_lint::{LateContext, LateLintPass};
   8 use rustc_middle::hir::map::Map;
   9 use rustc_middle::lint::in_external_macro;
  10 use rustc_middle::ty;
  11 use rustc_session::{declare_lint_pass, declare_tool_lint};
  12 use rustc_span::symbol::SymbolStr;
  13 use rustc_span::{sym, Span};
  14
  15 declare_clippy_lint! {
  16     /// ### What it does
  17     /// Checks for `match` expressions modifying the case of a string with non-compliant arms
  18     ///
  19     /// ### Why is this bad?
  20     /// The arm is unreachable, which is likely a mistake
  21     ///
  22     /// ### Example
  23     /// ```rust
  24     /// # let text = "Foo";
  25     ///
  26     /// match &*text.to_ascii_lowercase() {
  27     ///     "foo" => {},
  28     ///     "Bar" => {},
  29     ///     _ => {},
  30     /// }
  31     /// ```
  32     /// Use instead:
  33     /// ```rust
  34     /// # let text = "Foo";
  35     ///
  36     /// match &*text.to_ascii_lowercase() {
  37     ///     "foo" => {},
  38     ///     "bar" => {},
  39     ///     _ => {},
  40     /// }
  41     /// ```
  42     pub MATCH_STR_CASE_MISMATCH,
  43     correctness,
  44     "creation of a case altering match expression with non-compliant arms"
  45 }
  46
  47 declare_lint_pass!(MatchStrCaseMismatch => [MATCH_STR_CASE_MISMATCH]);
  48
  49 #[derive(Debug)]
  50 enum CaseMethod {
  51     LowerCase,
  52     AsciiLowerCase,
  53     UpperCase,
  54     AsciiUppercase,
  55 }
  56
  57 impl LateLintPass<'_> for MatchStrCaseMismatch {
  58     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
  59         if_chain! {
  60             if !in_external_macro(cx.tcx.sess, expr.span);
  61             if let ExprKind::Match(match_expr, arms, MatchSource::Normal) = expr.kind;
  62             if let ty::Ref(_, ty, _) = cx.typeck_results().expr_ty(match_expr).kind();
  63             if let ty::Str = ty.kind();
  64             then {
  65                 let mut visitor = MatchExprVisitor {
  66                     cx,
  67                     case_method: None,
  68                 };
  69
  70                 visitor.visit_expr(match_expr);
  71
  72                 if let Some(case_method) = visitor.case_method {
  73                     if let Some((bad_case_span, bad_case_str)) = verify_case(&case_method, arms) {
  74                         lint(cx, &case_method, bad_case_span, &bad_case_str);
  75                     }
  76                 }
  77             }
  78         }
  79     }
  80 }
  81
  82 struct MatchExprVisitor<'a, 'tcx> {
  83     cx: &'a LateContext<'tcx>,
  84     case_method: Option<CaseMethod>,
  85 }
  86
  87 impl<'a, 'tcx> Visitor<'tcx> for MatchExprVisitor<'a, 'tcx> {
  88     type Map = Map<'tcx>;
  89
  90     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
  91         NestedVisitorMap::None
  92     }
  93
  94     fn visit_expr(&mut self, ex: &'tcx Expr<'_>) {
  95         match ex.kind {
  96             ExprKind::MethodCall(segment, _, [receiver], _)
  97                 if self.case_altered(&*segment.ident.as_str(), receiver) => {},
  98             _ => walk_expr(self, ex),
  99         }
 100     }
 101 }
 102
 103 impl<'a, 'tcx> MatchExprVisitor<'a, 'tcx> {
 104     fn case_altered(&mut self, segment_ident: &str, receiver: &Expr<'_>) -> bool {
 105         if let Some(case_method) = get_case_method(segment_ident) {
 106             let ty = self.cx.typeck_results().expr_ty(receiver).peel_refs();
 107
 108             if is_type_diagnostic_item(self.cx, ty, sym::String) || ty.kind() == &ty::Str {
 109                 self.case_method = Some(case_method);
 110                 return true;
 111             }
 112         }
 113
 114         false
 115     }
 116 }
 117
 118 fn get_case_method(segment_ident_str: &str) -> Option<CaseMethod> {
 119     match segment_ident_str {
 120         "to_lowercase" => Some(CaseMethod::LowerCase),
 121         "to_ascii_lowercase" => Some(CaseMethod::AsciiLowerCase),
 122         "to_uppercase" => Some(CaseMethod::UpperCase),
 123         "to_ascii_uppercase" => Some(CaseMethod::AsciiUppercase),
 124         _ => None,
 125     }
 126 }
 127
 128 fn verify_case<'a>(case_method: &'a CaseMethod, arms: &'a [Arm<'_>]) -> Option<(Span, SymbolStr)> {
 129     let case_check = match case_method {
 130         CaseMethod::LowerCase => |input: &str| -> bool { input.chars().all(char::is_lowercase) },
 131         CaseMethod::AsciiLowerCase => |input: &str| -> bool { input.chars().all(|c| matches!(c, 'a'..='z')) },
 132         CaseMethod::UpperCase => |input: &str| -> bool { input.chars().all(char::is_uppercase) },
 133         CaseMethod::AsciiUppercase => |input: &str| -> bool { input.chars().all(|c| matches!(c, 'A'..='Z')) },
 134     };
 135
 136     for arm in arms {
 137         if_chain! {
 138             if let PatKind::Lit(Expr {
 139                                 kind: ExprKind::Lit(lit),
 140                                 ..
 141                             }) = arm.pat.kind;
 142             if let LitKind::Str(symbol, _) = lit.node;
 143             let input = symbol.as_str();
 144             if !case_check(&input);
 145             then {
 146                 return Some((lit.span, input));
 147             }
 148         }
 149     }
 150
 151     None
 152 }
 153
 154 fn lint(cx: &LateContext<'_>, case_method: &CaseMethod, bad_case_span: Span, bad_case_str: &str) {
 155     let (method_str, suggestion) = match case_method {
 156         CaseMethod::LowerCase => ("to_lower_case", bad_case_str.to_lowercase()),
 157         CaseMethod::AsciiLowerCase => ("to_ascii_lowercase", bad_case_str.to_ascii_lowercase()),
 158         CaseMethod::UpperCase => ("to_uppercase", bad_case_str.to_uppercase()),
 159         CaseMethod::AsciiUppercase => ("to_ascii_uppercase", bad_case_str.to_ascii_uppercase()),
 160     };
 161
 162     span_lint_and_sugg(
 163         cx,
 164         MATCH_STR_CASE_MISMATCH,
 165         bad_case_span,
 166         "this `match` arm has a differing case than its expression",
 167         &*format!("consider changing the case of this arm to respect `{}`", method_str),
 168         format!("\"{}\"", suggestion),
 169         Applicability::MachineApplicable,
 170     );
 171 }