src/tools/clippy/clippy_lints/src/checked_conversions.rs

   1 //! lint on manually implemented checked conversions that could be transformed into `try_from`
   2
   3 use if_chain::if_chain;
   4 use rustc_ast::ast::LitKind;
   5 use rustc_errors::Applicability;
   6 use rustc_hir::{BinOp, BinOpKind, Expr, ExprKind, QPath, TyKind};
   7 use rustc_lint::{LateContext, LateLintPass, LintContext};
   8 use rustc_middle::lint::in_external_macro;
   9 use rustc_session::{declare_lint_pass, declare_tool_lint};
  10
  11 use crate::utils::{snippet_with_applicability, span_lint_and_sugg, SpanlessEq};
  12
  13 declare_clippy_lint! {
  14     /// **What it does:** Checks for explicit bounds checking when casting.
  15     ///
  16     /// **Why is this bad?** Reduces the readability of statements & is error prone.
  17     ///
  18     /// **Known problems:** None.
  19     ///
  20     /// **Example:**
  21     /// ```rust
  22     /// # let foo: u32 = 5;
  23     /// # let _ =
  24     /// foo <= i32::MAX as u32
  25     /// # ;
  26     /// ```
  27     ///
  28     /// Could be written:
  29     ///
  30     /// ```rust
  31     /// # use std::convert::TryFrom;
  32     /// # let foo = 1;
  33     /// # let _ =
  34     /// i32::try_from(foo).is_ok()
  35     /// # ;
  36     /// ```
  37     pub CHECKED_CONVERSIONS,
  38     pedantic,
  39     "`try_from` could replace manual bounds checking when casting"
  40 }
  41
  42 declare_lint_pass!(CheckedConversions => [CHECKED_CONVERSIONS]);
  43
  44 impl<'tcx> LateLintPass<'tcx> for CheckedConversions {
  45     fn check_expr(&mut self, cx: &LateContext<'_>, item: &Expr<'_>) {
  46         let result = if_chain! {
  47             if !in_external_macro(cx.sess(), item.span);
  48             if let ExprKind::Binary(op, ref left, ref right) = &item.kind;
  49
  50             then {
  51                 match op.node {
  52                     BinOpKind::Ge | BinOpKind::Le => single_check(item),
  53                     BinOpKind::And => double_check(cx, left, right),
  54                     _ => None,
  55                 }
  56             } else {
  57                 None
  58             }
  59         };
  60
  61         if let Some(cv) = result {
  62             if let Some(to_type) = cv.to_type {
  63                 let mut applicability = Applicability::MachineApplicable;
  64                 let snippet = snippet_with_applicability(cx, cv.expr_to_cast.span, "_", &mut applicability);
  65                 span_lint_and_sugg(
  66                     cx,
  67                     CHECKED_CONVERSIONS,
  68                     item.span,
  69                     "checked cast can be simplified",
  70                     "try",
  71                     format!("{}::try_from({}).is_ok()", to_type, snippet),
  72                     applicability,
  73                 );
  74             }
  75         }
  76     }
  77 }
  78
  79 /// Searches for a single check from unsigned to _ is done
  80 /// todo: check for case signed -> larger unsigned == only x >= 0
  81 fn single_check<'tcx>(expr: &'tcx Expr<'tcx>) -> Option<Conversion<'tcx>> {
  82     check_upper_bound(expr).filter(|cv| cv.cvt == ConversionType::FromUnsigned)
  83 }
  84
  85 /// Searches for a combination of upper & lower bound checks
  86 fn double_check<'a>(cx: &LateContext<'_>, left: &'a Expr<'_>, right: &'a Expr<'_>) -> Option<Conversion<'a>> {
  87     let upper_lower = |l, r| {
  88         let upper = check_upper_bound(l);
  89         let lower = check_lower_bound(r);
  90
  91         upper.zip(lower).and_then(|(l, r)| l.combine(r, cx))
  92     };
  93
  94     upper_lower(left, right).or_else(|| upper_lower(right, left))
  95 }
  96
  97 /// Contains the result of a tried conversion check
  98 #[derive(Clone, Debug)]
  99 struct Conversion<'a> {
 100     cvt: ConversionType,
 101     expr_to_cast: &'a Expr<'a>,
 102     to_type: Option<&'a str>,
 103 }
 104
 105 /// The kind of conversion that is checked
 106 #[derive(Copy, Clone, Debug, PartialEq)]
 107 enum ConversionType {
 108     SignedToUnsigned,
 109     SignedToSigned,
 110     FromUnsigned,
 111 }
 112
 113 impl<'a> Conversion<'a> {
 114     /// Combine multiple conversions if the are compatible
 115     pub fn combine(self, other: Self, cx: &LateContext<'_>) -> Option<Conversion<'a>> {
 116         if self.is_compatible(&other, cx) {
 117             // Prefer a Conversion that contains a type-constraint
 118             Some(if self.to_type.is_some() { self } else { other })
 119         } else {
 120             None
 121         }
 122     }
 123
 124     /// Checks if two conversions are compatible
 125     /// same type of conversion, same 'castee' and same 'to type'
 126     pub fn is_compatible(&self, other: &Self, cx: &LateContext<'_>) -> bool {
 127         (self.cvt == other.cvt)
 128             && (SpanlessEq::new(cx).eq_expr(self.expr_to_cast, other.expr_to_cast))
 129             && (self.has_compatible_to_type(other))
 130     }
 131
 132     /// Checks if the to-type is the same (if there is a type constraint)
 133     fn has_compatible_to_type(&self, other: &Self) -> bool {
 134         match (self.to_type, other.to_type) {
 135             (Some(l), Some(r)) => l == r,
 136             _ => true,
 137         }
 138     }
 139
 140     /// Try to construct a new conversion if the conversion type is valid
 141     fn try_new(expr_to_cast: &'a Expr<'_>, from_type: &str, to_type: &'a str) -> Option<Conversion<'a>> {
 142         ConversionType::try_new(from_type, to_type).map(|cvt| Conversion {
 143             cvt,
 144             expr_to_cast,
 145             to_type: Some(to_type),
 146         })
 147     }
 148
 149     /// Construct a new conversion without type constraint
 150     fn new_any(expr_to_cast: &'a Expr<'_>) -> Conversion<'a> {
 151         Conversion {
 152             cvt: ConversionType::SignedToUnsigned,
 153             expr_to_cast,
 154             to_type: None,
 155         }
 156     }
 157 }
 158
 159 impl ConversionType {
 160     /// Creates a conversion type if the type is allowed & conversion is valid
 161     #[must_use]
 162     fn try_new(from: &str, to: &str) -> Option<Self> {
 163         if UINTS.contains(&from) {
 164             Some(Self::FromUnsigned)
 165         } else if SINTS.contains(&from) {
 166             if UINTS.contains(&to) {
 167                 Some(Self::SignedToUnsigned)
 168             } else if SINTS.contains(&to) {
 169                 Some(Self::SignedToSigned)
 170             } else {
 171                 None
 172             }
 173         } else {
 174             None
 175         }
 176     }
 177 }
 178
 179 /// Check for `expr <= (to_type::MAX as from_type)`
 180 fn check_upper_bound<'tcx>(expr: &'tcx Expr<'tcx>) -> Option<Conversion<'tcx>> {
 181     if_chain! {
 182          if let ExprKind::Binary(ref op, ref left, ref right) = &expr.kind;
 183          if let Some((candidate, check)) = normalize_le_ge(op, left, right);
 184          if let Some((from, to)) = get_types_from_cast(check, INTS, "max_value", "MAX");
 185
 186          then {
 187              Conversion::try_new(candidate, from, to)
 188          } else {
 189             None
 190         }
 191     }
 192 }
 193
 194 /// Check for `expr >= 0|(to_type::MIN as from_type)`
 195 fn check_lower_bound<'tcx>(expr: &'tcx Expr<'tcx>) -> Option<Conversion<'tcx>> {
 196     fn check_function<'a>(candidate: &'a Expr<'a>, check: &'a Expr<'a>) -> Option<Conversion<'a>> {
 197         (check_lower_bound_zero(candidate, check)).or_else(|| (check_lower_bound_min(candidate, check)))
 198     }
 199
 200     // First of we need a binary containing the expression & the cast
 201     if let ExprKind::Binary(ref op, ref left, ref right) = &expr.kind {
 202         normalize_le_ge(op, right, left).and_then(|(l, r)| check_function(l, r))
 203     } else {
 204         None
 205     }
 206 }
 207
 208 /// Check for `expr >= 0`
 209 fn check_lower_bound_zero<'a>(candidate: &'a Expr<'_>, check: &'a Expr<'_>) -> Option<Conversion<'a>> {
 210     if_chain! {
 211         if let ExprKind::Lit(ref lit) = &check.kind;
 212         if let LitKind::Int(0, _) = &lit.node;
 213
 214         then {
 215             Some(Conversion::new_any(candidate))
 216         } else {
 217             None
 218         }
 219     }
 220 }
 221
 222 /// Check for `expr >= (to_type::MIN as from_type)`
 223 fn check_lower_bound_min<'a>(candidate: &'a Expr<'_>, check: &'a Expr<'_>) -> Option<Conversion<'a>> {
 224     if let Some((from, to)) = get_types_from_cast(check, SINTS, "min_value", "MIN") {
 225         Conversion::try_new(candidate, from, to)
 226     } else {
 227         None
 228     }
 229 }
 230
 231 /// Tries to extract the from- and to-type from a cast expression
 232 fn get_types_from_cast<'a>(
 233     expr: &'a Expr<'_>,
 234     types: &'a [&str],
 235     func: &'a str,
 236     assoc_const: &'a str,
 237 ) -> Option<(&'a str, &'a str)> {
 238     // `to_type::max_value() as from_type`
 239     // or `to_type::MAX as from_type`
 240     let call_from_cast: Option<(&Expr<'_>, &str)> = if_chain! {
 241         // to_type::max_value(), from_type
 242         if let ExprKind::Cast(ref limit, ref from_type) = &expr.kind;
 243         if let TyKind::Path(ref from_type_path) = &from_type.kind;
 244         if let Some(from_sym) = int_ty_to_sym(from_type_path);
 245
 246         then {
 247             Some((limit, from_sym))
 248         } else {
 249             None
 250         }
 251     };
 252
 253     // `from_type::from(to_type::max_value())`
 254     let limit_from: Option<(&Expr<'_>, &str)> = call_from_cast.or_else(|| {
 255         if_chain! {
 256             // `from_type::from, to_type::max_value()`
 257             if let ExprKind::Call(ref from_func, ref args) = &expr.kind;
 258             // `to_type::max_value()`
 259             if args.len() == 1;
 260             if let limit = &args[0];
 261             // `from_type::from`
 262             if let ExprKind::Path(ref path) = &from_func.kind;
 263             if let Some(from_sym) = get_implementing_type(path, INTS, "from");
 264
 265             then {
 266                 Some((limit, from_sym))
 267             } else {
 268                 None
 269             }
 270         }
 271     });
 272
 273     if let Some((limit, from_type)) = limit_from {
 274         match limit.kind {
 275             // `from_type::from(_)`
 276             ExprKind::Call(path, _) => {
 277                 if let ExprKind::Path(ref path) = path.kind {
 278                     // `to_type`
 279                     if let Some(to_type) = get_implementing_type(path, types, func) {
 280                         return Some((from_type, to_type));
 281                     }
 282                 }
 283             },
 284             // `to_type::MAX`
 285             ExprKind::Path(ref path) => {
 286                 if let Some(to_type) = get_implementing_type(path, types, assoc_const) {
 287                     return Some((from_type, to_type));
 288                 }
 289             },
 290             _ => {},
 291         }
 292     };
 293     None
 294 }
 295
 296 /// Gets the type which implements the called function
 297 fn get_implementing_type<'a>(path: &QPath<'_>, candidates: &'a [&str], function: &str) -> Option<&'a str> {
 298     if_chain! {
 299         if let QPath::TypeRelative(ref ty, ref path) = &path;
 300         if path.ident.name.as_str() == function;
 301         if let TyKind::Path(QPath::Resolved(None, ref tp)) = &ty.kind;
 302         if let [int] = &*tp.segments;
 303         let name = &int.ident.name.as_str();
 304
 305         then {
 306             candidates.iter().find(|c| name == *c).cloned()
 307         } else {
 308             None
 309         }
 310     }
 311 }
 312
 313 /// Gets the type as a string, if it is a supported integer
 314 fn int_ty_to_sym<'tcx>(path: &QPath<'_>) -> Option<&'tcx str> {
 315     if_chain! {
 316         if let QPath::Resolved(_, ref path) = *path;
 317         if let [ty] = &*path.segments;
 318         let name = &ty.ident.name.as_str();
 319
 320         then {
 321             INTS.iter().find(|c| name == *c).cloned()
 322         } else {
 323             None
 324         }
 325     }
 326 }
 327
 328 /// Will return the expressions as if they were expr1 <= expr2
 329 fn normalize_le_ge<'a>(op: &BinOp, left: &'a Expr<'a>, right: &'a Expr<'a>) -> Option<(&'a Expr<'a>, &'a Expr<'a>)> {
 330     match op.node {
 331         BinOpKind::Le => Some((left, right)),
 332         BinOpKind::Ge => Some((right, left)),
 333         _ => None,
 334     }
 335 }
 336
 337 // Constants
 338 const UINTS: &[&str] = &["u8", "u16", "u32", "u64", "usize"];
 339 const SINTS: &[&str] = &["i8", "i16", "i32", "i64", "isize"];
 340 const INTS: &[&str] = &["u8", "u16", "u32", "u64", "usize", "i8", "i16", "i32", "i64", "isize"];