Skip to content

[clang-tidy] Teach readability-uppercase-literal-suffix about C++23 and C23 suffixes #148275

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,11 @@ struct IntegerLiteralCheck {
static constexpr llvm::StringLiteral Name = llvm::StringLiteral("integer");
// What should be skipped before looking for the Suffixes? (Nothing here.)
static constexpr llvm::StringLiteral SkipFirst = llvm::StringLiteral("");
// Suffix can only consist of 'u' and 'l' chars, and can be a complex number
// ('i', 'j'). In MS compatibility mode, suffixes like i32 are supported.
// Suffix can only consist of 'u', 'l', and 'z' chars, can be a bit-precise
// integer (wb), and can be a complex number ('i', 'j'). In MS compatibility
// mode, suffixes like i32 are supported.
static constexpr llvm::StringLiteral Suffixes =
llvm::StringLiteral("uUlLiIjJ");
llvm::StringLiteral("uUlLzZwWbBiIjJ");
};
constexpr llvm::StringLiteral IntegerLiteralCheck::Name;
constexpr llvm::StringLiteral IntegerLiteralCheck::SkipFirst;
Expand All @@ -45,10 +46,10 @@ struct FloatingLiteralCheck {
// Since the exponent ('p'/'P') is mandatory for hexadecimal floating-point
// literals, we first skip everything before the exponent.
static constexpr llvm::StringLiteral SkipFirst = llvm::StringLiteral("pP");
// Suffix can only consist of 'f', 'l', "f16", 'h', 'q' chars,
// and can be a complex number ('i', 'j').
// Suffix can only consist of 'f', 'l', "f16", "bf16", "df", "dd", "dl",
// 'h', 'q' chars, and can be a complex number ('i', 'j').
static constexpr llvm::StringLiteral Suffixes =
llvm::StringLiteral("fFlLhHqQiIjJ");
llvm::StringLiteral("fFlLbBdDhHqQiIjJ");
};
constexpr llvm::StringLiteral FloatingLiteralCheck::Name;
constexpr llvm::StringLiteral FloatingLiteralCheck::SkipFirst;
Expand Down
4 changes: 4 additions & 0 deletions clang-tools-extra/docs/ReleaseNotes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -354,6 +354,10 @@ Changes in existing checks
<clang-tidy/checks/readability/redundant-smartptr-get>` check by fixing
some false positives involving smart pointers to arrays.

- Improved :doc:`readability-uppercase-literal-suffix
<clang-tidy/checks/readability/uppercase-literal-suffix>` check to recognize
literal suffixes added in C++23 and C23.

Removed checks
^^^^^^^^^^^^^^

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
// TODO: When Clang adds support for decimal floating point types, enable these tests by:
// 1. Removing all the #if 0 + #endif guards.
// 2. Removing all occurrences of the string "DISABLED-" in this file.
// 3. Deleting this message.

// RUN: %check_clang_tidy %s readability-uppercase-literal-suffix %t -- -- -std=c23
// RUN: grep -Ev "// *[A-Z-]+:" %s > %t.c
// RUN: clang-tidy %t.c -checks='-*,readability-uppercase-literal-suffix' -fix -- -std=c23
// RUN: clang-tidy %t.c -checks='-*,readability-uppercase-literal-suffix' -warnings-as-errors='-*,readability-uppercase-literal-suffix' -- -std=c23

void bit_precise_literal_suffix() {
// _BitInt()

static constexpr auto v1 = 1wb;
// CHECK-MESSAGES: :[[@LINE-1]]:30: warning: integer literal has suffix 'wb', which is not uppercase
// CHECK-MESSAGES-NEXT: static constexpr auto v1 = 1wb;
// CHECK-MESSAGES-NEXT: ^~~
// CHECK-MESSAGES-NEXT: WB{{$}}
// CHECK-FIXES: static constexpr auto v1 = 1WB;
static_assert(v1 == 1WB);

static constexpr auto v2 = 1WB; // OK.
static_assert(v2 == 1WB);

// _BitInt() Unsigned

static constexpr auto v3 = 1wbu;
// CHECK-MESSAGES: :[[@LINE-1]]:30: warning: integer literal has suffix 'wbu', which is not uppercase
// CHECK-MESSAGES-NEXT: static constexpr auto v3 = 1wbu;
// CHECK-MESSAGES-NEXT: ^~~~
// CHECK-MESSAGES-NEXT: WBU{{$}}
// CHECK-FIXES: static constexpr auto v3 = 1WBU;
static_assert(v3 == 1WBU);

static constexpr auto v4 = 1WBu;
// CHECK-MESSAGES: :[[@LINE-1]]:30: warning: integer literal has suffix 'WBu', which is not uppercase
// CHECK-MESSAGES-NEXT: static constexpr auto v4 = 1WBu;
// CHECK-MESSAGES-NEXT: ^~~~
// CHECK-MESSAGES-NEXT: WBU{{$}}
// CHECK-FIXES: static constexpr auto v4 = 1WBU;
static_assert(v4 == 1WBU);

static constexpr auto v5 = 1wbU;
// CHECK-MESSAGES: :[[@LINE-1]]:30: warning: integer literal has suffix 'wbU', which is not uppercase
// CHECK-MESSAGES-NEXT: static constexpr auto v5 = 1wbU;
// CHECK-MESSAGES-NEXT: ^~~~
// CHECK-MESSAGES-NEXT: WBU{{$}}
// CHECK-FIXES: static constexpr auto v5 = 1WBU;
static_assert(v5 == 1WBU);

static constexpr auto v6 = 1WBU; // OK.
static_assert(v6 == 1WBU);

// Unsigned _BitInt()

static constexpr auto v7 = 1uwb;
// CHECK-MESSAGES: :[[@LINE-1]]:30: warning: integer literal has suffix 'uwb', which is not uppercase
// CHECK-MESSAGES-NEXT: static constexpr auto v7 = 1uwb;
// CHECK-MESSAGES-NEXT: ^~~~
// CHECK-MESSAGES-NEXT: UWB{{$}}
// CHECK-FIXES: static constexpr auto v7 = 1UWB;
static_assert(v7 == 1UWB);

static constexpr auto v8 = 1uWB;
// CHECK-MESSAGES: :[[@LINE-1]]:30: warning: integer literal has suffix 'uWB', which is not uppercase
// CHECK-MESSAGES-NEXT: static constexpr auto v8 = 1uWB;
// CHECK-MESSAGES-NEXT: ^~~~
// CHECK-MESSAGES-NEXT: UWB{{$}}
// CHECK-FIXES: static constexpr auto v8 = 1UWB;
static_assert(v8 == 1UWB);

static constexpr auto v9 = 1Uwb;
// CHECK-MESSAGES: :[[@LINE-1]]:30: warning: integer literal has suffix 'Uwb', which is not uppercase
// CHECK-MESSAGES-NEXT: static constexpr auto v9 = 1Uwb;
// CHECK-MESSAGES-NEXT: ^~~~
// CHECK-MESSAGES-NEXT: UWB{{$}}
// CHECK-FIXES: static constexpr auto v9 = 1UWB;
static_assert(v9 == 1UWB);

static constexpr auto v10 = 1UWB; // OK.
static_assert(v10 == 1UWB);
}

void decimal_floating_point_suffix() {
// _Decimal32

#if 0
static constexpr auto v1 = 1.df;
// DISABLED-CHECK-MESSAGES: :[[@LINE-1]]:30: warning: floating point literal has suffix 'df', which is not uppercase
// DISABLED-CHECK-MESSAGES-NEXT: static constexpr auto v1 = 1.df;
// DISABLED-CHECK-MESSAGES-NEXT: ^ ~
// DISABLED-CHECK-MESSAGES-NEXT: DF{{$}}
// DISABLED-CHECK-FIXES: static constexpr auto v1 = 1.DF;
static_assert(v1 == 1.DF);

static constexpr auto v2 = 1.e0df;
// DISABLED-CHECK-MESSAGES: :[[@LINE-1]]:30: warning: floating point literal has suffix 'df', which is not uppercase
// DISABLED-CHECK-MESSAGES-NEXT: static constexpr auto v2 = 1.e0df;
// DISABLED-CHECK-MESSAGES-NEXT: ^ ~
// DISABLED-CHECK-MESSAGES-NEXT: DF{{$}}
// DISABLED-CHECK-FIXES: static constexpr auto v2 = 1.e0DF;
static_assert(v2 == 1.DF);

static constexpr auto v3 = 1.DF; // OK.
static_assert(v3 == 1.DF);

static constexpr auto v4 = 1.e0DF; // OK.
static_assert(v4 == 1.DF);
#endif

// _Decimal64

#if 0
static constexpr auto v5 = 1.dd;
// DISABLED-CHECK-MESSAGES: :[[@LINE-1]]:30: warning: floating point literal has suffix 'dd', which is not uppercase
// DISABLED-CHECK-MESSAGES-NEXT: static constexpr auto v5 = 1.dd;
// DISABLED-CHECK-MESSAGES-NEXT: ^ ~
// DISABLED-CHECK-MESSAGES-NEXT: DD{{$}}
// DISABLED-CHECK-FIXES: static constexpr auto v5 = 1.DD;
static_assert(v5 == 1.DD);

static constexpr auto v6 = 1.e0dd;
// DISABLED-CHECK-MESSAGES: :[[@LINE-1]]:30: warning: floating point literal has suffix 'dd', which is not uppercase
// DISABLED-CHECK-MESSAGES-NEXT: static constexpr auto v6 = 1.e0dd;
// DISABLED-CHECK-MESSAGES-NEXT: ^ ~
// DISABLED-CHECK-MESSAGES-NEXT: DD{{$}}
// DISABLED-CHECK-FIXES: static constexpr auto v6 = 1.e0DD;
static_assert(v6 == 1.DD);

static constexpr auto v7 = 1.DD; // OK.
static_assert(v7 == 1.DD);

static constexpr auto v8 = 1.e0DD; // OK.
static_assert(v8 == 1.DD);
#endif

// _Decimal128

#if 0
static constexpr auto v9 = 1.dl;
// DISABLED-CHECK-MESSAGES: :[[@LINE-1]]:30: warning: floating point literal has suffix 'dl', which is not uppercase
// DISABLED-CHECK-MESSAGES-NEXT: static constexpr auto v9 = 1.dl;
// DISABLED-CHECK-MESSAGES-NEXT: ^ ~
// DISABLED-CHECK-MESSAGES-NEXT: DL{{$}}
// DISABLED-CHECK-FIXES: static constexpr auto v9 = 1.DL;
static_assert(v9 == 1.DL);

static constexpr auto v10 = 1.e0dl;
// DISABLED-CHECK-MESSAGES: :[[@LINE-1]]:31: warning: floating point literal has suffix 'dl', which is not uppercase
// DISABLED-CHECK-MESSAGES-NEXT: static constexpr auto v10 = 1.e0dl;
// DISABLED-CHECK-MESSAGES-NEXT: ^ ~
// DISABLED-CHECK-MESSAGES-NEXT: DL{{$}}
// DISABLED-CHECK-FIXES: static constexpr auto v10 = 1.e0DL;
static_assert(v10 == 1.DL);

static constexpr auto v11 = 1.DL; // OK.
static_assert(v11 == 1.DL);

static constexpr auto v12 = 1.e0DL; // OK.
static_assert(v12 == 1.DL);
#endif
}
Loading
Loading