llvm/llvm-project

modernize-use-digit-separator

Open

#35,414 opened on Jan 23, 2018

View on GitHub
 (15 comments) (0 reactions) (1 assignee)C++ (10,782 forks)batch import
bugzillacheck-requestclang-tidygood first issue

Repository metrics

Stars
 (26,378 stars)
PR merge metrics
 (Avg merge 1d 2h) (1,000 merged PRs in 30d)

Description
Bugzilla Link 36066
Version unspecified
OS All

Extended Description

Create a check that looks for long integral constants and inserts the digits separator (') appropriately.

Suggested groupings:

  • decimal integral constants, groups of 3 digits, e.g. int x = 1'000;
  • binary integral constants, groups of 4 digits, e.g. int x = 0b0010'0011;
  • octal integral constants, groups of 3 digits, e.g. int x = 0377'777;
  • hexadecimal integral constants, groups of 4 digits, e.g. unsigned long x = 0xffff'0000;
  • floating-point constnats, group into 3 digits on either side of the decimal point, e.g. float x = 3'456.001'25f;

This check requires C++14.

Provision could be made for supplying a mapping of numeric literal type to number of digits to be grouped.

Contributor guide

Research direction
Study existing clang tidy checks for patterns, then implement a new check that inserts digit separators in long integral constants according to the specified groupings. Register the check and ensure it works in C++14 mode.
Tech stack
cpp
Domain
compilers
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++GitLLVM
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60