clippy_utils/src/numeric_literal.rs

   1 use rustc_ast::ast::{Lit, LitFloatType, LitIntType, LitKind};
   2 use std::iter;
   3
   4 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
   5 pub enum Radix {
   6     Binary,
   7     Octal,
   8     Decimal,
   9     Hexadecimal,
  10 }
  11
  12 impl Radix {
  13     /// Returns a reasonable digit group size for this radix.
  14     #[must_use]
  15     fn suggest_grouping(self) -> usize {
  16         match self {
  17             Self::Binary | Self::Hexadecimal => 4,
  18             Self::Octal | Self::Decimal => 3,
  19         }
  20     }
  21 }
  22
  23 /// A helper method to format numeric literals with digit grouping.
  24 /// `lit` must be a valid numeric literal without suffix.
  25 pub fn format(lit: &str, type_suffix: Option<&str>, float: bool) -> String {
  26     NumericLiteral::new(lit, type_suffix, float).format()
  27 }
  28
  29 #[derive(Debug)]
  30 pub struct NumericLiteral<'a> {
  31     /// Which radix the literal was represented in.
  32     pub radix: Radix,
  33     /// The radix prefix, if present.
  34     pub prefix: Option<&'a str>,
  35
  36     /// The integer part of the number.
  37     pub integer: &'a str,
  38     /// The fraction part of the number.
  39     pub fraction: Option<&'a str>,
  40     /// The exponent separator (b'e' or b'E') including preceding underscore if present
  41     /// and the exponent part.
  42     pub exponent: Option<(&'a str, &'a str)>,
  43
  44     /// The type suffix, including preceding underscore if present.
  45     pub suffix: Option<&'a str>,
  46 }
  47
  48 impl<'a> NumericLiteral<'a> {
  49     pub fn from_lit(src: &'a str, lit: &Lit) -> Option<NumericLiteral<'a>> {
  50         NumericLiteral::from_lit_kind(src, &lit.kind)
  51     }
  52
  53     pub fn from_lit_kind(src: &'a str, lit_kind: &LitKind) -> Option<NumericLiteral<'a>> {
  54         let unsigned_src = src.strip_prefix('-').map_or(src, |s| s);
  55         if lit_kind.is_numeric()
  56             && unsigned_src
  57                 .trim_start()
  58                 .chars()
  59                 .next()
  60                 .map_or(false, |c| c.is_ascii_digit())
  61         {
  62             let (unsuffixed, suffix) = split_suffix(src, lit_kind);
  63             let float = matches!(lit_kind, LitKind::Float(..));
  64             Some(NumericLiteral::new(unsuffixed, suffix, float))
  65         } else {
  66             None
  67         }
  68     }
  69
  70     #[must_use]
  71     pub fn new(lit: &'a str, suffix: Option<&'a str>, float: bool) -> Self {
  72         // Determine delimiter for radix prefix, if present, and radix.
  73         let radix = if lit.starts_with("0x") {
  74             Radix::Hexadecimal
  75         } else if lit.starts_with("0b") {
  76             Radix::Binary
  77         } else if lit.starts_with("0o") {
  78             Radix::Octal
  79         } else {
  80             Radix::Decimal
  81         };
  82
  83         // Grab part of the literal after prefix, if present.
  84         let (prefix, mut sans_prefix) = if radix == Radix::Decimal {
  85             (None, lit)
  86         } else {
  87             let (p, s) = lit.split_at(2);
  88             (Some(p), s)
  89         };
  90
  91         if suffix.is_some() && sans_prefix.ends_with('_') {
  92             // The '_' before the suffix isn't part of the digits
  93             sans_prefix = &sans_prefix[..sans_prefix.len() - 1];
  94         }
  95
  96         let (integer, fraction, exponent) = Self::split_digit_parts(sans_prefix, float);
  97
  98         Self {
  99             radix,
 100             prefix,
 101             integer,
 102             fraction,
 103             exponent,
 104             suffix,
 105         }
 106     }
 107
 108     pub fn is_decimal(&self) -> bool {
 109         self.radix == Radix::Decimal
 110     }
 111
 112     pub fn split_digit_parts(digits: &str, float: bool) -> (&str, Option<&str>, Option<(&str, &str)>) {
 113         let mut integer = digits;
 114         let mut fraction = None;
 115         let mut exponent = None;
 116
 117         if float {
 118             for (i, c) in digits.char_indices() {
 119                 match c {
 120                     '.' => {
 121                         integer = &digits[..i];
 122                         fraction = Some(&digits[i + 1..]);
 123                     },
 124                     'e' | 'E' => {
 125                         let exp_start = if digits[..i].ends_with('_') { i - 1 } else { i };
 126
 127                         if integer.len() > exp_start {
 128                             integer = &digits[..exp_start];
 129                         } else {
 130                             fraction = Some(&digits[integer.len() + 1..exp_start]);
 131                         };
 132                         exponent = Some((&digits[exp_start..=i], &digits[i + 1..]));
 133                         break;
 134                     },
 135                     _ => {},
 136                 }
 137             }
 138         }
 139
 140         (integer, fraction, exponent)
 141     }
 142
 143     /// Returns literal formatted in a sensible way.
 144     pub fn format(&self) -> String {
 145         let mut output = String::new();
 146
 147         if let Some(prefix) = self.prefix {
 148             output.push_str(prefix);
 149         }
 150
 151         let group_size = self.radix.suggest_grouping();
 152
 153         Self::group_digits(
 154             &mut output,
 155             self.integer,
 156             group_size,
 157             true,
 158             self.radix == Radix::Hexadecimal,
 159         );
 160
 161         if let Some(fraction) = self.fraction {
 162             output.push('.');
 163             Self::group_digits(&mut output, fraction, group_size, false, false);
 164         }
 165
 166         if let Some((separator, exponent)) = self.exponent {
 167             if exponent != "0" {
 168                 output.push_str(separator);
 169                 Self::group_digits(&mut output, exponent, group_size, true, false);
 170             }
 171         }
 172
 173         if let Some(suffix) = self.suffix {
 174             if output.ends_with('.') {
 175                 output.push('0');
 176             }
 177             output.push('_');
 178             output.push_str(suffix);
 179         }
 180
 181         output
 182     }
 183
 184     pub fn group_digits(output: &mut String, input: &str, group_size: usize, partial_group_first: bool, pad: bool) {
 185         debug_assert!(group_size > 0);
 186
 187         let mut digits = input.chars().filter(|&c| c != '_');
 188
 189         // The exponent may have a sign, output it early, otherwise it will be
 190         // treated as a digit
 191         if digits.clone().next() == Some('-') {
 192             let _ = digits.next();
 193             output.push('-');
 194         }
 195
 196         let first_group_size;
 197
 198         if partial_group_first {
 199             first_group_size = (digits.clone().count() - 1) % group_size + 1;
 200             if pad {
 201                 for _ in 0..group_size - first_group_size {
 202                     output.push('0');
 203                 }
 204             }
 205         } else {
 206             first_group_size = group_size;
 207         }
 208
 209         for _ in 0..first_group_size {
 210             if let Some(digit) = digits.next() {
 211                 output.push(digit);
 212             }
 213         }
 214
 215         for (c, i) in iter::zip(digits, (0..group_size).cycle()) {
 216             if i == 0 {
 217                 output.push('_');
 218             }
 219             output.push(c);
 220         }
 221     }
 222 }
 223
 224 fn split_suffix<'a>(src: &'a str, lit_kind: &LitKind) -> (&'a str, Option<&'a str>) {
 225     debug_assert!(lit_kind.is_numeric());
 226     lit_suffix_length(lit_kind)
 227         .and_then(|suffix_length| src.len().checked_sub(suffix_length))
 228         .map_or((src, None), |split_pos| {
 229             let (unsuffixed, suffix) = src.split_at(split_pos);
 230             (unsuffixed, Some(suffix))
 231         })
 232 }
 233
 234 fn lit_suffix_length(lit_kind: &LitKind) -> Option<usize> {
 235     debug_assert!(lit_kind.is_numeric());
 236     let suffix = match lit_kind {
 237         LitKind::Int(_, int_lit_kind) => match int_lit_kind {
 238             LitIntType::Signed(int_ty) => Some(int_ty.name_str()),
 239             LitIntType::Unsigned(uint_ty) => Some(uint_ty.name_str()),
 240             LitIntType::Unsuffixed => None,
 241         },
 242         LitKind::Float(_, float_lit_kind) => match float_lit_kind {
 243             LitFloatType::Suffixed(float_ty) => Some(float_ty.name_str()),
 244             LitFloatType::Unsuffixed => None,
 245         },
 246         _ => None,
 247     };
 248
 249     suffix.map(str::len)
 250 }