[clang-tools-extra] [clang-tidy] Do not emit file path for anonymous enums in `readability-enum-initial-value` check (PR #112496)
via cfe-commits
cfe-commits at lists.llvm.org
Mon Oct 28 03:24:17 PDT 2024
https://github.com/Discookie updated https://github.com/llvm/llvm-project/pull/112496
>From 93c933be9f0c21fd8d78b22915da68da80e27575 Mon Sep 17 00:00:00 2001
From: Viktor <viktor.cseh at ericsson.com>
Date: Wed, 16 Oct 2024 08:21:13 +0000
Subject: [PATCH 1/2] [clang-tidy] Do not emit file path for anonymous enums in
`readability-enum-initial-value` check
---
.../readability/EnumInitialValueCheck.cpp | 27 +++++++++++++------
clang-tools-extra/docs/ReleaseNotes.rst | 3 ++-
.../checkers/readability/enum-initial-value.c | 12 ++++++++-
3 files changed, 32 insertions(+), 10 deletions(-)
diff --git a/clang-tools-extra/clang-tidy/readability/EnumInitialValueCheck.cpp b/clang-tools-extra/clang-tidy/readability/EnumInitialValueCheck.cpp
index 1cb95c2b2347b7..9c000df132c5cc 100644
--- a/clang-tools-extra/clang-tidy/readability/EnumInitialValueCheck.cpp
+++ b/clang-tools-extra/clang-tidy/readability/EnumInitialValueCheck.cpp
@@ -123,6 +123,13 @@ AST_MATCHER(EnumDecl, hasSequentialInitialValues) {
return !AllEnumeratorsArePowersOfTwo;
}
+std::string getName(const EnumDecl *Decl) {
+ if (!Decl->getDeclName())
+ return "<unnamed>";
+
+ return Decl->getQualifiedNameAsString();
+}
+
} // namespace
EnumInitialValueCheck::EnumInitialValueCheck(StringRef Name,
@@ -158,12 +165,16 @@ void EnumInitialValueCheck::registerMatchers(MatchFinder *Finder) {
}
void EnumInitialValueCheck::check(const MatchFinder::MatchResult &Result) {
+ PrintingPolicy PP = Result.Context->getPrintingPolicy();
+ PP.AnonymousTagLocations = false;
+
if (const auto *Enum = Result.Nodes.getNodeAs<EnumDecl>("inconsistent")) {
DiagnosticBuilder Diag =
- diag(Enum->getBeginLoc(),
- "initial values in enum %0 are not consistent, consider explicit "
- "initialization of all, none or only the first enumerator")
- << Enum;
+ diag(
+ Enum->getBeginLoc(),
+ "initial values in enum '%0' are not consistent, consider explicit "
+ "initialization of all, none or only the first enumerator")
+ << getName(Enum);
for (const EnumConstantDecl *ECD : Enum->enumerators())
if (ECD->getInitExpr() == nullptr) {
const SourceLocation EndLoc = Lexer::getLocForEndOfToken(
@@ -183,16 +194,16 @@ void EnumInitialValueCheck::check(const MatchFinder::MatchResult &Result) {
if (Loc.isInvalid() || Loc.isMacroID())
return;
DiagnosticBuilder Diag = diag(Loc, "zero initial value for the first "
- "enumerator in %0 can be disregarded")
- << Enum;
+ "enumerator in '%0' can be disregarded")
+ << getName(Enum);
cleanInitialValue(Diag, ECD, *Result.SourceManager, getLangOpts());
return;
}
if (const auto *Enum = Result.Nodes.getNodeAs<EnumDecl>("sequential")) {
DiagnosticBuilder Diag =
diag(Enum->getBeginLoc(),
- "sequential initial value in %0 can be ignored")
- << Enum;
+ "sequential initial value in '%0' can be ignored")
+ << getName(Enum);
for (const EnumConstantDecl *ECD : llvm::drop_begin(Enum->enumerators()))
cleanInitialValue(Diag, ECD, *Result.SourceManager, getLangOpts());
return;
diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst
index 95be0a89cd6c93..a4427ac222b475 100644
--- a/clang-tools-extra/docs/ReleaseNotes.rst
+++ b/clang-tools-extra/docs/ReleaseNotes.rst
@@ -232,7 +232,8 @@ Changes in existing checks
- Improved :doc:`readability-enum-initial-value
<clang-tidy/checks/readability/enum-initial-value>` check by only issuing
- diagnostics for the definition of an ``enum``, and by fixing a typo in the
+ diagnostics for the definition of an ``enum``, by not emitting a redundant
+ file path for anonymous enums in the diagnostic, and by fixing a typo in the
diagnostic.
- Improved :doc:`readability-implicit-bool-conversion
diff --git a/clang-tools-extra/test/clang-tidy/checkers/readability/enum-initial-value.c b/clang-tools-extra/test/clang-tidy/checkers/readability/enum-initial-value.c
index b9a34d0683d7f3..54108585f030f8 100644
--- a/clang-tools-extra/test/clang-tidy/checkers/readability/enum-initial-value.c
+++ b/clang-tools-extra/test/clang-tidy/checkers/readability/enum-initial-value.c
@@ -53,6 +53,17 @@ enum EMacro2 {
// CHECK-FIXES: EMacro2_c = 3,
};
+
+enum {
+ // CHECK-MESSAGES: :[[@LINE-1]]:1: warning: initial values in enum '<unnamed>' are not consistent
+ // CHECK-MESSAGES-ENABLE: :[[@LINE-2]]:1: warning: initial values in enum '<unnamed>' are not consistent
+ EAnonymous_a = 1,
+ EAnonymous_b,
+ // CHECK-FIXES: EAnonymous_b = 2,
+ EAnonymous_c = 3,
+};
+
+
enum EnumZeroFirstInitialValue {
EnumZeroFirstInitialValue_0 = 0,
// CHECK-MESSAGES-ENABLE: :[[@LINE-1]]:3: warning: zero initial value for the first enumerator in 'EnumZeroFirstInitialValue' can be disregarded
@@ -114,4 +125,3 @@ enum WithFwdDeclSequential : int {
EFS2 = 4,
// CHECK-FIXES-ENABLE: EFS2 ,
};
-
>From 46ef53175eac0cf26fa0a47929481f6a61ce6f40 Mon Sep 17 00:00:00 2001
From: Viktor <viktor.cseh at ericsson.com>
Date: Mon, 28 Oct 2024 10:23:57 +0000
Subject: [PATCH 2/2] Remove leftover PrintingPolicy call
---
.../clang-tidy/readability/EnumInitialValueCheck.cpp | 3 ---
1 file changed, 3 deletions(-)
diff --git a/clang-tools-extra/clang-tidy/readability/EnumInitialValueCheck.cpp b/clang-tools-extra/clang-tidy/readability/EnumInitialValueCheck.cpp
index 9c000df132c5cc..e0b9939681794f 100644
--- a/clang-tools-extra/clang-tidy/readability/EnumInitialValueCheck.cpp
+++ b/clang-tools-extra/clang-tidy/readability/EnumInitialValueCheck.cpp
@@ -165,9 +165,6 @@ void EnumInitialValueCheck::registerMatchers(MatchFinder *Finder) {
}
void EnumInitialValueCheck::check(const MatchFinder::MatchResult &Result) {
- PrintingPolicy PP = Result.Context->getPrintingPolicy();
- PP.AnonymousTagLocations = false;
-
if (const auto *Enum = Result.Nodes.getNodeAs<EnumDecl>("inconsistent")) {
DiagnosticBuilder Diag =
diag(
More information about the cfe-commits
mailing list