1 // Copyright 2014-2018 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution.
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.
10 //! Lints concerned with the grouping of digits with underscores in integral or
11 //! floating-point literal expressions.
13 use crate::rustc::lint::{in_external_macro, EarlyContext, EarlyLintPass, LintArray, LintContext, LintPass};
14 use crate::rustc::{declare_tool_lint, lint_array};
15 use crate::rustc_errors::Applicability;
16 use crate::syntax::ast::*;
17 use crate::syntax_pos;
18 use crate::utils::{snippet_opt, span_lint_and_sugg};
19 use if_chain::if_chain;
21 /// **What it does:** Warns if a long integral or floating-point constant does
22 /// not contain underscores.
24 /// **Why is this bad?** Reading long numbers is difficult without separators.
26 /// **Known problems:** None.
33 declare_clippy_lint! {
34 pub UNREADABLE_LITERAL,
36 "long integer literal without underscores"
39 /// **What it does:** Warns for mistyped suffix in literals
41 /// **Why is this bad?** This is most probably a typo
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
53 declare_clippy_lint! {
54 pub MISTYPED_LITERAL_SUFFIXES,
56 "mistyped literal suffix"
59 /// **What it does:** Warns if an integral or floating-point constant is
60 /// grouped inconsistently with underscores.
62 /// **Why is this bad?** Readers may incorrectly interpret inconsistently
65 /// **Known problems:** None.
70 /// 618_64_9189_73_511
72 declare_clippy_lint! {
73 pub INCONSISTENT_DIGIT_GROUPING,
75 "integer literals with digits grouped inconsistently"
78 /// **What it does:** Warns if the digits of an integral or floating-point
79 /// constant are grouped into groups that
82 /// **Why is this bad?** Negatively impacts readability.
84 /// **Known problems:** None.
91 declare_clippy_lint! {
92 pub LARGE_DIGIT_GROUPS,
94 "grouping digits into groups that are too large"
97 /// **What it does:** Warns if there is a better representation for a numeric literal.
99 /// **Why is this bad?** Especially for big powers of 2 a hexadecimal representation is more
100 /// readable than a decimal representation.
102 /// **Known problems:** None.
107 /// `65_535` => `0xFFFF`
108 /// `4_042_322_160` => `0xF0F0_F0F0`
109 declare_clippy_lint! {
110 pub DECIMAL_LITERAL_REPRESENTATION,
112 "using decimal representation when hexadecimal would be better"
115 #[derive(Debug, PartialEq)]
116 pub(super) enum Radix {
124 /// Return a reasonable digit group size for this radix.
125 crate fn suggest_grouping(&self) -> usize {
127 Radix::Binary | Radix::Hexadecimal => 4,
128 Radix::Octal | Radix::Decimal => 3,
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.
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.
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") {
152 } else if lit.starts_with("0b") {
154 } else if lit.starts_with("0o") {
160 // Grab part of the literal after prefix, if present.
161 let (prefix, sans_prefix) = if let Radix::Decimal = radix {
164 let (p, s) = lit.split_at(2);
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 == '_' { d_idx - 1 } else { d_idx };
174 || is_possible_float_suffix_index(&sans_prefix, suffix_start, len)
175 || ((d == 'E' || d == 'e') && !has_possible_float_suffix(&sans_prefix)))
176 || !float && (d == 'i' || d == 'u' || is_possible_suffix_index(&sans_prefix, suffix_start, len))
178 let (digits, suffix) = sans_prefix.split_at(suffix_start);
183 suffix: Some(suffix),
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
207 .expect("split always returns at least one element")
210 .filter(|&c| c != '_')
213 .map(|chunk| chunk.iter().rev().collect())
215 .collect::<Vec<String>>()
217 let frac_part_hint = parts
219 .expect("already checked that there is a `.`")
221 .filter(|&c| c != '_')
224 .map(|chunk| chunk.iter().collect())
225 .collect::<Vec<String>>()
227 let suffix_hint = match self.suffix {
228 Some(suffix) if is_mistyped_float_suffix(suffix) => format!("_f{}", &suffix[1..]),
229 Some(suffix) => suffix.to_string(),
230 None => String::new(),
232 format!("{}.{}{}", int_part_hint, frac_part_hint, suffix_hint)
233 } else if self.float && (self.digits.contains('E') || self.digits.contains('e')) {
234 let which_e = if self.digits.contains('E') { 'E' } else { 'e' };
235 let parts: Vec<&str> = self.digits.split(which_e).collect();
236 let filtered_digits_vec_0 = parts[0].chars().filter(|&c| c != '_').rev().collect::<Vec<_>>();
237 let filtered_digits_vec_1 = parts[1].chars().filter(|&c| c != '_').rev().collect::<Vec<_>>();
238 let before_e_hint = filtered_digits_vec_0
240 .map(|chunk| chunk.iter().rev().collect())
242 .collect::<Vec<String>>()
244 let after_e_hint = filtered_digits_vec_1
246 .map(|chunk| chunk.iter().rev().collect())
248 .collect::<Vec<String>>()
250 let suffix_hint = match self.suffix {
251 Some(suffix) if is_mistyped_float_suffix(suffix) => format!("_f{}", &suffix[1..]),
252 Some(suffix) => suffix.to_string(),
253 None => String::new(),
257 self.prefix.unwrap_or(""),
264 let filtered_digits_vec = self.digits.chars().filter(|&c| c != '_').rev().collect::<Vec<_>>();
265 let mut hint = filtered_digits_vec
267 .map(|chunk| chunk.iter().rev().collect())
269 .collect::<Vec<String>>()
271 // Forces hexadecimal values to be grouped by 4 being filled with zeroes (e.g 0x00ab_cdef)
272 let nb_digits_to_fill = filtered_digits_vec.len() % 4;
273 if self.radix == Radix::Hexadecimal && nb_digits_to_fill != 0 {
274 hint = format!("{:0>4}{}", &hint[..nb_digits_to_fill], &hint[nb_digits_to_fill..]);
276 let suffix_hint = match self.suffix {
277 Some(suffix) if is_mistyped_suffix(suffix) => format!("_i{}", &suffix[1..]),
278 Some(suffix) => suffix.to_string(),
279 None => String::new(),
281 format!("{}{}{}", self.prefix.unwrap_or(""), hint, suffix_hint)
288 InconsistentDigitGrouping,
290 DecimalRepresentation,
291 MistypedLiteralSuffix,
295 crate fn display(&self, grouping_hint: &str, cx: &EarlyContext<'_>, span: syntax_pos::Span) {
297 WarningType::MistypedLiteralSuffix => span_lint_and_sugg(
299 MISTYPED_LITERAL_SUFFIXES,
301 "mistyped literal suffix",
302 "did you mean to write",
303 grouping_hint.to_string(),
304 Applicability::MaybeIncorrect,
306 WarningType::UnreadableLiteral => span_lint_and_sugg(
310 "long literal lacking separators",
312 grouping_hint.to_owned(),
313 Applicability::MachineApplicable,
315 WarningType::LargeDigitGroups => span_lint_and_sugg(
319 "digit groups should be smaller",
321 grouping_hint.to_owned(),
322 Applicability::MachineApplicable,
324 WarningType::InconsistentDigitGrouping => span_lint_and_sugg(
326 INCONSISTENT_DIGIT_GROUPING,
328 "digits grouped inconsistently by underscores",
330 grouping_hint.to_owned(),
331 Applicability::MachineApplicable,
333 WarningType::DecimalRepresentation => span_lint_and_sugg(
335 DECIMAL_LITERAL_REPRESENTATION,
337 "integer literal has a better hexadecimal representation",
339 grouping_hint.to_owned(),
340 Applicability::MachineApplicable,
346 #[derive(Copy, Clone)]
347 pub struct LiteralDigitGrouping;
349 impl LintPass for LiteralDigitGrouping {
350 fn get_lints(&self) -> LintArray {
353 INCONSISTENT_DIGIT_GROUPING,
355 MISTYPED_LITERAL_SUFFIXES,
360 impl EarlyLintPass for LiteralDigitGrouping {
361 fn check_expr(&mut self, cx: &EarlyContext<'_>, expr: &Expr) {
362 if in_external_macro(cx.sess(), expr.span) {
366 if let ExprKind::Lit(ref lit) = expr.node {
367 self.check_lit(cx, lit)
372 impl LiteralDigitGrouping {
373 fn check_lit(self, cx: &EarlyContext<'_>, lit: &Lit) {
375 LitKind::Int(..) => {
376 // Lint integral literals.
378 if let Some(src) = snippet_opt(cx, lit.span);
379 if let Some(firstch) = src.chars().next();
380 if char::to_digit(firstch, 10).is_some();
382 let digit_info = DigitInfo::new(&src, false);
383 let _ = Self::do_lint(digit_info.digits, digit_info.suffix).map_err(|warning_type| {
384 warning_type.display(&digit_info.grouping_hint(), cx, lit.span)
389 LitKind::Float(..) | LitKind::FloatUnsuffixed(..) => {
390 // Lint floating-point literals.
392 if let Some(src) = snippet_opt(cx, lit.span);
393 if let Some(firstch) = src.chars().next();
394 if char::to_digit(firstch, 10).is_some();
396 let digit_info = DigitInfo::new(&src, true);
397 // Separate digits into integral and fractional parts.
398 let parts: Vec<&str> = digit_info
400 .split_terminator('.')
403 // Lint integral and fractional parts separately, and then check consistency of digit
404 // groups if both pass.
405 let _ = Self::do_lint(parts[0], digit_info.suffix)
406 .map(|integral_group_size| {
408 // Lint the fractional part of literal just like integral part, but reversed.
409 let fractional_part = &parts[1].chars().rev().collect::<String>();
410 let _ = Self::do_lint(fractional_part, None)
411 .map(|fractional_group_size| {
412 let consistent = Self::parts_consistent(integral_group_size,
413 fractional_group_size,
417 WarningType::InconsistentDigitGrouping.display(
418 &digit_info.grouping_hint(),
424 .map_err(|warning_type| warning_type.display(&digit_info.grouping_hint(),
429 .map_err(|warning_type| warning_type.display(&digit_info.grouping_hint(), cx, lit.span));
437 /// Given the sizes of the digit groups of both integral and fractional
438 /// parts, and the length
439 /// of both parts, determine if the digits have been grouped consistently.
440 fn parts_consistent(int_group_size: usize, frac_group_size: usize, int_size: usize, frac_size: usize) -> bool {
441 match (int_group_size, frac_group_size) {
442 // No groups on either side of decimal point - trivially consistent.
444 // Integral part has grouped digits, fractional part does not.
445 (_, 0) => frac_size <= int_group_size,
446 // Fractional part has grouped digits, integral part does not.
447 (0, _) => int_size <= frac_group_size,
448 // Both parts have grouped digits. Groups should be the same size.
449 (_, _) => int_group_size == frac_group_size,
453 /// Performs lint on `digits` (no decimal point) and returns the group
454 /// size on success or `WarningType` when emitting a warning.
455 fn do_lint(digits: &str, suffix: Option<&str>) -> Result<usize, WarningType> {
456 if let Some(suffix) = suffix {
457 if is_mistyped_suffix(suffix) {
458 return Err(WarningType::MistypedLiteralSuffix);
461 // Grab underscore indices with respect to the units digit.
462 let underscore_positions: Vec<usize> = digits
466 .filter_map(|(idx, digit)| if digit == '_' { Some(idx) } else { None })
469 if underscore_positions.is_empty() {
470 // Check if literal needs underscores.
471 if digits.len() > 5 {
472 Err(WarningType::UnreadableLiteral)
477 // Check consistency and the sizes of the groups.
478 let group_size = underscore_positions[0];
479 let consistent = underscore_positions
481 .all(|ps| ps[1] - ps[0] == group_size + 1)
482 // number of digits to the left of the last group cannot be bigger than group size.
483 && (digits.len() - underscore_positions.last()
484 .expect("there's at least one element") <= group_size + 1);
487 return Err(WarningType::InconsistentDigitGrouping);
488 } else if group_size > 4 {
489 return Err(WarningType::LargeDigitGroups);
496 #[derive(Copy, Clone)]
497 pub struct LiteralRepresentation {
501 impl LintPass for LiteralRepresentation {
502 fn get_lints(&self) -> LintArray {
503 lint_array!(DECIMAL_LITERAL_REPRESENTATION)
507 impl EarlyLintPass for LiteralRepresentation {
508 fn check_expr(&mut self, cx: &EarlyContext<'_>, expr: &Expr) {
509 if in_external_macro(cx.sess(), expr.span) {
513 if let ExprKind::Lit(ref lit) = expr.node {
514 self.check_lit(cx, lit)
519 impl LiteralRepresentation {
520 pub fn new(threshold: u64) -> Self {
523 fn check_lit(self, cx: &EarlyContext<'_>, lit: &Lit) {
524 // Lint integral literals.
526 if let LitKind::Int(..) = lit.node;
527 if let Some(src) = snippet_opt(cx, lit.span);
528 if let Some(firstch) = src.chars().next();
529 if char::to_digit(firstch, 10).is_some();
531 let digit_info = DigitInfo::new(&src, false);
532 if digit_info.radix == Radix::Decimal {
533 let val = digit_info.digits
535 .filter(|&c| c != '_')
537 .parse::<u128>().unwrap();
538 if val < u128::from(self.threshold) {
541 let hex = format!("{:#X}", val);
542 let digit_info = DigitInfo::new(&hex[..], false);
543 let _ = Self::do_lint(digit_info.digits).map_err(|warning_type| {
544 warning_type.display(&digit_info.grouping_hint(), cx, lit.span)
551 fn do_lint(digits: &str) -> Result<(), WarningType> {
552 if digits.len() == 1 {
553 // Lint for 1 digit literals, if someone really sets the threshold that low
562 return Err(WarningType::DecimalRepresentation);
564 } else if digits.len() < 4 {
565 // Lint for Literals with a hex-representation of 2 or 3 digits
566 let f = &digits[0..1]; // first digit
567 let s = &digits[1..]; // suffix
570 if ((f.eq("1") || f.eq("2") || f.eq("4") || f.eq("8")) && s.chars().all(|c| c == '0'))
571 // Powers of 2 minus 1
572 || ((f.eq("1") || f.eq("3") || f.eq("7") || f.eq("F")) && s.chars().all(|c| c == 'F'))
574 return Err(WarningType::DecimalRepresentation);
577 // Lint for Literals with a hex-representation of 4 digits or more
578 let f = &digits[0..1]; // first digit
579 let m = &digits[1..digits.len() - 1]; // middle digits, except last
580 let s = &digits[1..]; // suffix
582 // Powers of 2 with a margin of +15/-16
583 if ((f.eq("1") || f.eq("2") || f.eq("4") || f.eq("8")) && m.chars().all(|c| c == '0'))
584 || ((f.eq("1") || f.eq("3") || f.eq("7") || f.eq("F")) && m.chars().all(|c| c == 'F'))
585 // Lint for representations with only 0s and Fs, while allowing 7 as the first
587 || ((f.eq("7") || f.eq("F")) && s.chars().all(|c| c == '0' || c == 'F'))
589 return Err(WarningType::DecimalRepresentation);
597 fn is_mistyped_suffix(suffix: &str) -> bool {
598 ["_8", "_16", "_32", "_64"].contains(&suffix)
601 fn is_possible_suffix_index(lit: &str, idx: usize, len: usize) -> bool {
602 ((len > 3 && idx == len - 3) || (len > 2 && idx == len - 2)) && is_mistyped_suffix(lit.split_at(idx).1)
605 fn is_mistyped_float_suffix(suffix: &str) -> bool {
606 ["_32", "_64"].contains(&suffix)
609 fn is_possible_float_suffix_index(lit: &str, idx: usize, len: usize) -> bool {
610 (len > 3 && idx == len - 3) && is_mistyped_float_suffix(lit.split_at(idx).1)
613 fn has_possible_float_suffix(lit: &str) -> bool {
614 lit.ends_with("_32") || lit.ends_with("_64")