clippy_lints/src/literal_representation.rs

   1 //! Lints concerned with the grouping of digits with underscores in integral or
   2 //! floating-point literal expressions.
   3
   4 use crate::utils::{snippet_opt, span_lint_and_sugg};
   5 use if_chain::if_chain;
   6 use rustc::lint::{in_external_macro, EarlyContext, EarlyLintPass, LintArray, LintContext, LintPass};
   7 use rustc::{declare_lint_pass, declare_tool_lint, impl_lint_pass};
   8 use rustc_errors::Applicability;
   9 use syntax::ast::*;
  10 use syntax_pos;
  11
  12 declare_clippy_lint! {
  13     /// **What it does:** Warns if a long integral or floating-point constant does
  14     /// not contain underscores.
  15     ///
  16     /// **Why is this bad?** Reading long numbers is difficult without separators.
  17     ///
  18     /// **Known problems:** None.
  19     ///
  20     /// **Example:**
  21     ///
  22     /// ```rust
  23     /// let x: u64 = 61864918973511;
  24     /// ```
  25     pub UNREADABLE_LITERAL,
  26     style,
  27     "long integer literal without underscores"
  28 }
  29
  30 declare_clippy_lint! {
  31     /// **What it does:** Warns for mistyped suffix in literals
  32     ///
  33     /// **Why is this bad?** This is most probably a typo
  34     ///
  35     /// **Known problems:**
  36     ///                 - Recommends a signed suffix, even though the number might be too big and an unsigned
  37     ///         suffix is required
  38     ///                 - Does not match on `_128` since that is a valid grouping for decimal and octal numbers
  39     ///
  40     /// **Example:**
  41     ///
  42     /// ```rust
  43     /// 2_32;
  44     /// ```
  45     pub MISTYPED_LITERAL_SUFFIXES,
  46     correctness,
  47     "mistyped literal suffix"
  48 }
  49
  50 declare_clippy_lint! {
  51     /// **What it does:** Warns if an integral or floating-point constant is
  52     /// grouped inconsistently with underscores.
  53     ///
  54     /// **Why is this bad?** Readers may incorrectly interpret inconsistently
  55     /// grouped digits.
  56     ///
  57     /// **Known problems:** None.
  58     ///
  59     /// **Example:**
  60     ///
  61     /// ```rust
  62     /// let x: u64 = 618_64_9189_73_511;
  63     /// ```
  64     pub INCONSISTENT_DIGIT_GROUPING,
  65     style,
  66     "integer literals with digits grouped inconsistently"
  67 }
  68
  69 declare_clippy_lint! {
  70     /// **What it does:** Warns if the digits of an integral or floating-point
  71     /// constant are grouped into groups that
  72     /// are too large.
  73     ///
  74     /// **Why is this bad?** Negatively impacts readability.
  75     ///
  76     /// **Known problems:** None.
  77     ///
  78     /// **Example:**
  79     ///
  80     /// ```rust
  81     /// let x: u64 = 6186491_8973511;
  82     /// ```
  83     pub LARGE_DIGIT_GROUPS,
  84     pedantic,
  85     "grouping digits into groups that are too large"
  86 }
  87
  88 declare_clippy_lint! {
  89     /// **What it does:** Warns if there is a better representation for a numeric literal.
  90     ///
  91     /// **Why is this bad?** Especially for big powers of 2 a hexadecimal representation is more
  92     /// readable than a decimal representation.
  93     ///
  94     /// **Known problems:** None.
  95     ///
  96     /// **Example:**
  97     ///
  98     /// `255` => `0xFF`
  99     /// `65_535` => `0xFFFF`
 100     /// `4_042_322_160` => `0xF0F0_F0F0`
 101     pub DECIMAL_LITERAL_REPRESENTATION,
 102     restriction,
 103     "using decimal representation when hexadecimal would be better"
 104 }
 105
 106 #[derive(Debug, PartialEq)]
 107 pub(super) enum Radix {
 108     Binary,
 109     Octal,
 110     Decimal,
 111     Hexadecimal,
 112 }
 113
 114 impl Radix {
 115     /// Returns a reasonable digit group size for this radix.
 116     crate fn suggest_grouping(&self) -> usize {
 117         match *self {
 118             Radix::Binary | Radix::Hexadecimal => 4,
 119             Radix::Octal | Radix::Decimal => 3,
 120         }
 121     }
 122 }
 123
 124 #[derive(Debug)]
 125 pub(super) struct DigitInfo<'a> {
 126     /// Characters of a literal between the radix prefix and type suffix.
 127     crate digits: &'a str,
 128     /// Which radix the literal was represented in.
 129     crate radix: Radix,
 130     /// The radix prefix, if present.
 131     crate prefix: Option<&'a str>,
 132     /// The type suffix, including preceding underscore if present.
 133     crate suffix: Option<&'a str>,
 134     /// True for floating-point literals.
 135     crate float: bool,
 136 }
 137
 138 impl<'a> DigitInfo<'a> {
 139     crate fn new(lit: &'a str, float: bool) -> Self {
 140         // Determine delimiter for radix prefix, if present, and radix.
 141         let radix = if lit.starts_with("0x") {
 142             Radix::Hexadecimal
 143         } else if lit.starts_with("0b") {
 144             Radix::Binary
 145         } else if lit.starts_with("0o") {
 146             Radix::Octal
 147         } else {
 148             Radix::Decimal
 149         };
 150
 151         // Grab part of the literal after prefix, if present.
 152         let (prefix, sans_prefix) = if let Radix::Decimal = radix {
 153             (None, lit)
 154         } else {
 155             let (p, s) = lit.split_at(2);
 156             (Some(p), s)
 157         };
 158
 159         let len = sans_prefix.len();
 160         let mut last_d = '\0';
 161         for (d_idx, d) in sans_prefix.char_indices() {
 162             let suffix_start = if last_d == '_' { d_idx - 1 } else { d_idx };
 163             if float
 164                 && (d == 'f'
 165                     || is_possible_float_suffix_index(&sans_prefix, suffix_start, len)
 166                     || ((d == 'E' || d == 'e') && !has_possible_float_suffix(&sans_prefix)))
 167                 || !float && (d == 'i' || d == 'u' || is_possible_suffix_index(&sans_prefix, suffix_start, len))
 168             {
 169                 let (digits, suffix) = sans_prefix.split_at(suffix_start);
 170                 return Self {
 171                     digits,
 172                     radix,
 173                     prefix,
 174                     suffix: Some(suffix),
 175                     float,
 176                 };
 177             }
 178             last_d = d
 179         }
 180
 181         // No suffix found
 182         Self {
 183             digits: sans_prefix,
 184             radix,
 185             prefix,
 186             suffix: None,
 187             float,
 188         }
 189     }
 190
 191     /// Returns literal formatted in a sensible way.
 192     crate fn grouping_hint(&self) -> String {
 193         let group_size = self.radix.suggest_grouping();
 194         if self.digits.contains('.') {
 195             let mut parts = self.digits.split('.');
 196             let int_part_hint = parts
 197                 .next()
 198                 .expect("split always returns at least one element")
 199                 .chars()
 200                 .rev()
 201                 .filter(|&c| c != '_')
 202                 .collect::<Vec<_>>()
 203                 .chunks(group_size)
 204                 .map(|chunk| chunk.iter().rev().collect())
 205                 .rev()
 206                 .collect::<Vec<String>>()
 207                 .join("_");
 208             let frac_part_hint = parts
 209                 .next()
 210                 .expect("already checked that there is a `.`")
 211                 .chars()
 212                 .filter(|&c| c != '_')
 213                 .collect::<Vec<_>>()
 214                 .chunks(group_size)
 215                 .map(|chunk| chunk.iter().collect())
 216                 .collect::<Vec<String>>()
 217                 .join("_");
 218             let suffix_hint = match self.suffix {
 219                 Some(suffix) if is_mistyped_float_suffix(suffix) => format!("_f{}", &suffix[1..]),
 220                 Some(suffix) => suffix.to_string(),
 221                 None => String::new(),
 222             };
 223             format!("{}.{}{}", int_part_hint, frac_part_hint, suffix_hint)
 224         } else if self.float && (self.digits.contains('E') || self.digits.contains('e')) {
 225             let which_e = if self.digits.contains('E') { 'E' } else { 'e' };
 226             let parts: Vec<&str> = self.digits.split(which_e).collect();
 227             let filtered_digits_vec_0 = parts[0].chars().filter(|&c| c != '_').rev().collect::<Vec<_>>();
 228             let filtered_digits_vec_1 = parts[1].chars().filter(|&c| c != '_').rev().collect::<Vec<_>>();
 229             let before_e_hint = filtered_digits_vec_0
 230                 .chunks(group_size)
 231                 .map(|chunk| chunk.iter().rev().collect())
 232                 .rev()
 233                 .collect::<Vec<String>>()
 234                 .join("_");
 235             let after_e_hint = filtered_digits_vec_1
 236                 .chunks(group_size)
 237                 .map(|chunk| chunk.iter().rev().collect())
 238                 .rev()
 239                 .collect::<Vec<String>>()
 240                 .join("_");
 241             let suffix_hint = match self.suffix {
 242                 Some(suffix) if is_mistyped_float_suffix(suffix) => format!("_f{}", &suffix[1..]),
 243                 Some(suffix) => suffix.to_string(),
 244                 None => String::new(),
 245             };
 246             format!(
 247                 "{}{}{}{}{}",
 248                 self.prefix.unwrap_or(""),
 249                 before_e_hint,
 250                 which_e,
 251                 after_e_hint,
 252                 suffix_hint
 253             )
 254         } else {
 255             let filtered_digits_vec = self.digits.chars().filter(|&c| c != '_').rev().collect::<Vec<_>>();
 256             let mut hint = filtered_digits_vec
 257                 .chunks(group_size)
 258                 .map(|chunk| chunk.iter().rev().collect())
 259                 .rev()
 260                 .collect::<Vec<String>>()
 261                 .join("_");
 262             // Forces hexadecimal values to be grouped by 4 being filled with zeroes (e.g 0x00ab_cdef)
 263             let nb_digits_to_fill = filtered_digits_vec.len() % 4;
 264             if self.radix == Radix::Hexadecimal && nb_digits_to_fill != 0 {
 265                 hint = format!("{:0>4}{}", &hint[..nb_digits_to_fill], &hint[nb_digits_to_fill..]);
 266             }
 267             let suffix_hint = match self.suffix {
 268                 Some(suffix) if is_mistyped_suffix(suffix) => format!("_i{}", &suffix[1..]),
 269                 Some(suffix) => suffix.to_string(),
 270                 None => String::new(),
 271             };
 272             format!("{}{}{}", self.prefix.unwrap_or(""), hint, suffix_hint)
 273         }
 274     }
 275 }
 276
 277 enum WarningType {
 278     UnreadableLiteral,
 279     InconsistentDigitGrouping,
 280     LargeDigitGroups,
 281     DecimalRepresentation,
 282     MistypedLiteralSuffix,
 283 }
 284
 285 impl WarningType {
 286     crate fn display(&self, grouping_hint: &str, cx: &EarlyContext<'_>, span: syntax_pos::Span) {
 287         match self {
 288             WarningType::MistypedLiteralSuffix => span_lint_and_sugg(
 289                 cx,
 290                 MISTYPED_LITERAL_SUFFIXES,
 291                 span,
 292                 "mistyped literal suffix",
 293                 "did you mean to write",
 294                 grouping_hint.to_string(),
 295                 Applicability::MaybeIncorrect,
 296             ),
 297             WarningType::UnreadableLiteral => span_lint_and_sugg(
 298                 cx,
 299                 UNREADABLE_LITERAL,
 300                 span,
 301                 "long literal lacking separators",
 302                 "consider",
 303                 grouping_hint.to_owned(),
 304                 Applicability::MachineApplicable,
 305             ),
 306             WarningType::LargeDigitGroups => span_lint_and_sugg(
 307                 cx,
 308                 LARGE_DIGIT_GROUPS,
 309                 span,
 310                 "digit groups should be smaller",
 311                 "consider",
 312                 grouping_hint.to_owned(),
 313                 Applicability::MachineApplicable,
 314             ),
 315             WarningType::InconsistentDigitGrouping => span_lint_and_sugg(
 316                 cx,
 317                 INCONSISTENT_DIGIT_GROUPING,
 318                 span,
 319                 "digits grouped inconsistently by underscores",
 320                 "consider",
 321                 grouping_hint.to_owned(),
 322                 Applicability::MachineApplicable,
 323             ),
 324             WarningType::DecimalRepresentation => span_lint_and_sugg(
 325                 cx,
 326                 DECIMAL_LITERAL_REPRESENTATION,
 327                 span,
 328                 "integer literal has a better hexadecimal representation",
 329                 "consider",
 330                 grouping_hint.to_owned(),
 331                 Applicability::MachineApplicable,
 332             ),
 333         };
 334     }
 335 }
 336
 337 declare_lint_pass!(LiteralDigitGrouping => [
 338     UNREADABLE_LITERAL,
 339     INCONSISTENT_DIGIT_GROUPING,
 340     LARGE_DIGIT_GROUPS,
 341     MISTYPED_LITERAL_SUFFIXES,
 342 ]);
 343
 344 impl EarlyLintPass for LiteralDigitGrouping {
 345     fn check_expr(&mut self, cx: &EarlyContext<'_>, expr: &Expr) {
 346         if in_external_macro(cx.sess(), expr.span) {
 347             return;
 348         }
 349
 350         if let ExprKind::Lit(ref lit) = expr.node {
 351             self.check_lit(cx, lit)
 352         }
 353     }
 354 }
 355
 356 impl LiteralDigitGrouping {
 357     fn check_lit(self, cx: &EarlyContext<'_>, lit: &Lit) {
 358         match lit.node {
 359             LitKind::Int(..) => {
 360                 // Lint integral literals.
 361                 if_chain! {
 362                     if let Some(src) = snippet_opt(cx, lit.span);
 363                     if let Some(firstch) = src.chars().next();
 364                     if char::to_digit(firstch, 10).is_some();
 365                     then {
 366                         let digit_info = DigitInfo::new(&src, false);
 367                         let _ = Self::do_lint(digit_info.digits, digit_info.suffix).map_err(|warning_type| {
 368                             warning_type.display(&digit_info.grouping_hint(), cx, lit.span)
 369                         });
 370                     }
 371                 }
 372             },
 373             LitKind::Float(..) | LitKind::FloatUnsuffixed(..) => {
 374                 // Lint floating-point literals.
 375                 if_chain! {
 376                     if let Some(src) = snippet_opt(cx, lit.span);
 377                     if let Some(firstch) = src.chars().next();
 378                     if char::to_digit(firstch, 10).is_some();
 379                     then {
 380                         let digit_info = DigitInfo::new(&src, true);
 381                         // Separate digits into integral and fractional parts.
 382                         let parts: Vec<&str> = digit_info
 383                             .digits
 384                             .split_terminator('.')
 385                             .collect();
 386
 387                         // Lint integral and fractional parts separately, and then check consistency of digit
 388                         // groups if both pass.
 389                         let _ = Self::do_lint(parts[0], digit_info.suffix)
 390                             .map(|integral_group_size| {
 391                                 if parts.len() > 1 {
 392                                     // Lint the fractional part of literal just like integral part, but reversed.
 393                                     let fractional_part = &parts[1].chars().rev().collect::<String>();
 394                                     let _ = Self::do_lint(fractional_part, None)
 395                                         .map(|fractional_group_size| {
 396                                             let consistent = Self::parts_consistent(integral_group_size,
 397                                                                                     fractional_group_size,
 398                                                                                     parts[0].len(),
 399                                                                                     parts[1].len());
 400                                                 if !consistent {
 401                                                     WarningType::InconsistentDigitGrouping.display(
 402                                                         &digit_info.grouping_hint(),
 403                                                         cx,
 404                                                         lit.span,
 405                                                     );
 406                                                 }
 407                                         })
 408                                     .map_err(|warning_type| warning_type.display(&digit_info.grouping_hint(),
 409                                     cx,
 410                                     lit.span));
 411                                 }
 412                             })
 413                         .map_err(|warning_type| warning_type.display(&digit_info.grouping_hint(), cx, lit.span));
 414                     }
 415                 }
 416             },
 417             _ => (),
 418         }
 419     }
 420
 421     /// Given the sizes of the digit groups of both integral and fractional
 422     /// parts, and the length
 423     /// of both parts, determine if the digits have been grouped consistently.
 424     fn parts_consistent(int_group_size: usize, frac_group_size: usize, int_size: usize, frac_size: usize) -> bool {
 425         match (int_group_size, frac_group_size) {
 426             // No groups on either side of decimal point - trivially consistent.
 427             (0, 0) => true,
 428             // Integral part has grouped digits, fractional part does not.
 429             (_, 0) => frac_size <= int_group_size,
 430             // Fractional part has grouped digits, integral part does not.
 431             (0, _) => int_size <= frac_group_size,
 432             // Both parts have grouped digits. Groups should be the same size.
 433             (_, _) => int_group_size == frac_group_size,
 434         }
 435     }
 436
 437     /// Performs lint on `digits` (no decimal point) and returns the group
 438     /// size on success or `WarningType` when emitting a warning.
 439     fn do_lint(digits: &str, suffix: Option<&str>) -> Result<usize, WarningType> {
 440         if let Some(suffix) = suffix {
 441             if is_mistyped_suffix(suffix) {
 442                 return Err(WarningType::MistypedLiteralSuffix);
 443             }
 444         }
 445         // Grab underscore indices with respect to the units digit.
 446         let underscore_positions: Vec<usize> = digits
 447             .chars()
 448             .rev()
 449             .enumerate()
 450             .filter_map(|(idx, digit)| if digit == '_' { Some(idx) } else { None })
 451             .collect();
 452
 453         if underscore_positions.is_empty() {
 454             // Check if literal needs underscores.
 455             if digits.len() > 5 {
 456                 Err(WarningType::UnreadableLiteral)
 457             } else {
 458                 Ok(0)
 459             }
 460         } else {
 461             // Check consistency and the sizes of the groups.
 462             let group_size = underscore_positions[0];
 463             let consistent = underscore_positions
 464                 .windows(2)
 465                 .all(|ps| ps[1] - ps[0] == group_size + 1)
 466                 // number of digits to the left of the last group cannot be bigger than group size.
 467                 && (digits.len() - underscore_positions.last()
 468                                                        .expect("there's at least one element") <= group_size + 1);
 469
 470             if !consistent {
 471                 return Err(WarningType::InconsistentDigitGrouping);
 472             } else if group_size > 4 {
 473                 return Err(WarningType::LargeDigitGroups);
 474             }
 475             Ok(group_size)
 476         }
 477     }
 478 }
 479
 480 #[allow(clippy::module_name_repetitions)]
 481 #[derive(Copy, Clone)]
 482 pub struct DecimalLiteralRepresentation {
 483     threshold: u64,
 484 }
 485
 486 impl_lint_pass!(DecimalLiteralRepresentation => [DECIMAL_LITERAL_REPRESENTATION]);
 487
 488 impl EarlyLintPass for DecimalLiteralRepresentation {
 489     fn check_expr(&mut self, cx: &EarlyContext<'_>, expr: &Expr) {
 490         if in_external_macro(cx.sess(), expr.span) {
 491             return;
 492         }
 493
 494         if let ExprKind::Lit(ref lit) = expr.node {
 495             self.check_lit(cx, lit)
 496         }
 497     }
 498 }
 499
 500 impl DecimalLiteralRepresentation {
 501     pub fn new(threshold: u64) -> Self {
 502         Self { threshold }
 503     }
 504     fn check_lit(self, cx: &EarlyContext<'_>, lit: &Lit) {
 505         // Lint integral literals.
 506         if_chain! {
 507             if let LitKind::Int(..) = lit.node;
 508             if let Some(src) = snippet_opt(cx, lit.span);
 509             if let Some(firstch) = src.chars().next();
 510             if char::to_digit(firstch, 10).is_some();
 511             let digit_info = DigitInfo::new(&src, false);
 512             if digit_info.radix == Radix::Decimal;
 513             if let Ok(val) = digit_info.digits
 514                 .chars()
 515                 .filter(|&c| c != '_')
 516                 .collect::<String>()
 517                 .parse::<u128>();
 518             if val >= u128::from(self.threshold);
 519             then {
 520                 let hex = format!("{:#X}", val);
 521                 let digit_info = DigitInfo::new(&hex, false);
 522                 let _ = Self::do_lint(digit_info.digits).map_err(|warning_type| {
 523                     warning_type.display(&digit_info.grouping_hint(), cx, lit.span)
 524                 });
 525             }
 526         }
 527     }
 528
 529     fn do_lint(digits: &str) -> Result<(), WarningType> {
 530         if digits.len() == 1 {
 531             // Lint for 1 digit literals, if someone really sets the threshold that low
 532             if digits == "1"
 533                 || digits == "2"
 534                 || digits == "4"
 535                 || digits == "8"
 536                 || digits == "3"
 537                 || digits == "7"
 538                 || digits == "F"
 539             {
 540                 return Err(WarningType::DecimalRepresentation);
 541             }
 542         } else if digits.len() < 4 {
 543             // Lint for Literals with a hex-representation of 2 or 3 digits
 544             let f = &digits[0..1]; // first digit
 545             let s = &digits[1..]; // suffix
 546
 547             // Powers of 2
 548             if ((f.eq("1") || f.eq("2") || f.eq("4") || f.eq("8")) && s.chars().all(|c| c == '0'))
 549                 // Powers of 2 minus 1
 550                 || ((f.eq("1") || f.eq("3") || f.eq("7") || f.eq("F")) && s.chars().all(|c| c == 'F'))
 551             {
 552                 return Err(WarningType::DecimalRepresentation);
 553             }
 554         } else {
 555             // Lint for Literals with a hex-representation of 4 digits or more
 556             let f = &digits[0..1]; // first digit
 557             let m = &digits[1..digits.len() - 1]; // middle digits, except last
 558             let s = &digits[1..]; // suffix
 559
 560             // Powers of 2 with a margin of +15/-16
 561             if ((f.eq("1") || f.eq("2") || f.eq("4") || f.eq("8")) && m.chars().all(|c| c == '0'))
 562                 || ((f.eq("1") || f.eq("3") || f.eq("7") || f.eq("F")) && m.chars().all(|c| c == 'F'))
 563                 // Lint for representations with only 0s and Fs, while allowing 7 as the first
 564                 // digit
 565                 || ((f.eq("7") || f.eq("F")) && s.chars().all(|c| c == '0' || c == 'F'))
 566             {
 567                 return Err(WarningType::DecimalRepresentation);
 568             }
 569         }
 570
 571         Ok(())
 572     }
 573 }
 574
 575 fn is_mistyped_suffix(suffix: &str) -> bool {
 576     ["_8", "_16", "_32", "_64"].contains(&suffix)
 577 }
 578
 579 fn is_possible_suffix_index(lit: &str, idx: usize, len: usize) -> bool {
 580     ((len > 3 && idx == len - 3) || (len > 2 && idx == len - 2)) && is_mistyped_suffix(lit.split_at(idx).1)
 581 }
 582
 583 fn is_mistyped_float_suffix(suffix: &str) -> bool {
 584     ["_32", "_64"].contains(&suffix)
 585 }
 586
 587 fn is_possible_float_suffix_index(lit: &str, idx: usize, len: usize) -> bool {
 588     (len > 3 && idx == len - 3) && is_mistyped_float_suffix(lit.split_at(idx).1)
 589 }
 590
 591 fn has_possible_float_suffix(lit: &str) -> bool {
 592     lit.ends_with("_32") || lit.ends_with("_64")
 593 }