clippy_lints/src/literal_representation.rs

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