src/tools/clippy/clippy_lints/src/from_str_radix_10.rs

   1 use clippy_utils::diagnostics::span_lint_and_sugg;
   2 use clippy_utils::sugg::Sugg;
   3 use clippy_utils::ty::is_type_diagnostic_item;
   4 use if_chain::if_chain;
   5 use rustc_errors::Applicability;
   6 use rustc_hir::{def, Expr, ExprKind, PrimTy, QPath, TyKind};
   7 use rustc_lint::{LateContext, LateLintPass};
   8 use rustc_middle::ty::Ty;
   9 use rustc_session::{declare_lint_pass, declare_tool_lint};
  10 use rustc_span::symbol::sym;
  11
  12 declare_clippy_lint! {
  13     /// ### What it does
  14     ///
  15     /// Checks for function invocations of the form `primitive::from_str_radix(s, 10)`
  16     ///
  17     /// ### Why is this bad?
  18     ///
  19     /// This specific common use case can be rewritten as `s.parse::<primitive>()`
  20     /// (and in most cases, the turbofish can be removed), which reduces code length
  21     /// and complexity.
  22     ///
  23     /// ### Known problems
  24     ///
  25     /// This lint may suggest using (&<expression>).parse() instead of <expression>.parse() directly
  26     /// in some cases, which is correct but adds unnecessary complexity to the code.
  27     ///
  28     /// ### Example
  29     /// ```ignore
  30     /// let input: &str = get_input();
  31     /// let num = u16::from_str_radix(input, 10)?;
  32     /// ```
  33     /// Use instead:
  34     /// ```ignore
  35     /// let input: &str = get_input();
  36     /// let num: u16 = input.parse()?;
  37     /// ```
  38     #[clippy::version = "1.52.0"]
  39     pub FROM_STR_RADIX_10,
  40     style,
  41     "from_str_radix with radix 10"
  42 }
  43
  44 declare_lint_pass!(FromStrRadix10 => [FROM_STR_RADIX_10]);
  45
  46 impl LateLintPass<'tcx> for FromStrRadix10 {
  47     fn check_expr(&mut self, cx: &LateContext<'tcx>, exp: &Expr<'tcx>) {
  48         if_chain! {
  49             if let ExprKind::Call(maybe_path, arguments) = &exp.kind;
  50             if let ExprKind::Path(QPath::TypeRelative(ty, pathseg)) = &maybe_path.kind;
  51
  52             // check if the first part of the path is some integer primitive
  53             if let TyKind::Path(ty_qpath) = &ty.kind;
  54             let ty_res = cx.qpath_res(ty_qpath, ty.hir_id);
  55             if let def::Res::PrimTy(prim_ty) = ty_res;
  56             if matches!(prim_ty, PrimTy::Int(_) | PrimTy::Uint(_));
  57
  58             // check if the second part of the path indeed calls the associated
  59             // function `from_str_radix`
  60             if pathseg.ident.name.as_str() == "from_str_radix";
  61
  62             // check if the second argument is a primitive `10`
  63             if arguments.len() == 2;
  64             if let ExprKind::Lit(lit) = &arguments[1].kind;
  65             if let rustc_ast::ast::LitKind::Int(10, _) = lit.node;
  66
  67             then {
  68                 let expr = if let ExprKind::AddrOf(_, _, expr) = &arguments[0].kind {
  69                     let ty = cx.typeck_results().expr_ty(expr);
  70                     if is_ty_stringish(cx, ty) {
  71                         expr
  72                     } else {
  73                         &arguments[0]
  74                     }
  75                 } else {
  76                     &arguments[0]
  77                 };
  78
  79                 let sugg = Sugg::hir_with_applicability(
  80                     cx,
  81                     expr,
  82                     "<string>",
  83                     &mut Applicability::MachineApplicable
  84                 ).maybe_par();
  85
  86                 span_lint_and_sugg(
  87                     cx,
  88                     FROM_STR_RADIX_10,
  89                     exp.span,
  90                     "this call to `from_str_radix` can be replaced with a call to `str::parse`",
  91                     "try",
  92                     format!("{}.parse::<{}>()", sugg, prim_ty.name_str()),
  93                     Applicability::MaybeIncorrect
  94                 );
  95             }
  96         }
  97     }
  98 }
  99
 100 /// Checks if a Ty is `String` or `&str`
 101 fn is_ty_stringish(cx: &LateContext<'_>, ty: Ty<'_>) -> bool {
 102     is_type_diagnostic_item(cx, ty, sym::String) || is_type_diagnostic_item(cx, ty, sym::str)
 103 }