[clang] [clang-format] Improve attribute (macro) handling for enums (PR #227461)
Björn Schäpers via cfe-commits
cfe-commits at lists.llvm.org
Mon Nov 9 12:06:13 PST 2026
https://github.com/HazardyKnusperkeks updated https://github.com/llvm/llvm-project/pull/227461
>From 89219367303414746c4bbfb332e0e648f08ff9cc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Sch=C3=A4pers?= <bjoern at hazardy.de>
Date: Tue, 29 Sep 2026 22:25:38 +0200
Subject: [PATCH 1/5] [clang-format] Improve attribute (macro) handling for
enums
Fixes #227244
---
clang/lib/Format/UnwrappedLineParser.cpp | 12 +++++++++---
clang/unittests/Format/TokenAnnotatorTest.cpp | 18 ++++++++++++++++++
2 files changed, 27 insertions(+), 3 deletions(-)
diff --git a/clang/lib/Format/UnwrappedLineParser.cpp b/clang/lib/Format/UnwrappedLineParser.cpp
index 2d2fe729fbc2f1..4439292af629dd 100644
--- a/clang/lib/Format/UnwrappedLineParser.cpp
+++ b/clang/lib/Format/UnwrappedLineParser.cpp
@@ -3922,9 +3922,15 @@ bool UnwrappedLineParser::parseEnum() {
// Eat up enum class ...
if (FormatTok->isOneOf(tok::kw_class, tok::kw_struct))
nextToken();
- while (FormatTok->is(tok::l_square))
- if (!handleCppAttributes())
- return false;
+ while (FormatTok->isOneOf(tok::l_square, TT_AttributeMacro)) {
+ if (FormatTok->is(tok::l_square)) {
+ if (!handleCppAttributes())
+ return false;
+ } else {
+ // TT_AttributeMacro
+ nextToken();
+ }
+ }
}
while (FormatTok->Tok.getIdentifierInfo() ||
diff --git a/clang/unittests/Format/TokenAnnotatorTest.cpp b/clang/unittests/Format/TokenAnnotatorTest.cpp
index f5ff5229f7232a..88f5e48a021fcd 100644
--- a/clang/unittests/Format/TokenAnnotatorTest.cpp
+++ b/clang/unittests/Format/TokenAnnotatorTest.cpp
@@ -692,6 +692,24 @@ TEST_F(TokenAnnotatorTest, UnderstandsEnums) {
ASSERT_EQ(Tokens.size(), 6u) << Tokens;
EXPECT_TOKEN(Tokens[2], tok::l_brace, TT_EnumLBrace);
EXPECT_TOKEN(Tokens[3], tok::r_brace, TT_EnumRBrace);
+
+ auto Style = getLLVMStyle();
+ Style.AttributeMacros = {"AttributeA", "AttributeB"};
+ Tokens = annotate("enum class AttributeA AttributeB Enum {}", Style);
+ ASSERT_EQ(Tokens.size(), 8u) << Tokens;
+ EXPECT_TOKEN(Tokens[2], tok::identifier, TT_AttributeMacro);
+ EXPECT_TOKEN(Tokens[3], tok::identifier, TT_AttributeMacro);
+ EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_EnumLBrace);
+ EXPECT_TOKEN(Tokens[6], tok::r_brace, TT_EnumRBrace);
+
+ Tokens =
+ annotate("enum class AttributeA [[nodiscard]] AttributeB Enum {}", Style);
+ ASSERT_EQ(Tokens.size(), 13u) << Tokens;
+ EXPECT_TOKEN(Tokens[2], tok::identifier, TT_AttributeMacro);
+ EXPECT_TOKEN(Tokens[3], tok::l_square, TT_AttributeLSquare);
+ EXPECT_TOKEN(Tokens[8], tok::identifier, TT_AttributeMacro);
+ EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_EnumLBrace);
+ EXPECT_TOKEN(Tokens[11], tok::r_brace, TT_EnumRBrace);
}
TEST_F(TokenAnnotatorTest, UnderstandsExportBlock) {
>From 854d75d042140b886cd7284905b630470a57d8dd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Sch=C3=A4pers?= <bjoern at hazardy.de>
Date: Thu, 8 Oct 2026 22:03:56 +0200
Subject: [PATCH 2/5] Address review comments
---
clang/lib/Format/UnwrappedLineParser.cpp | 24 +++++++++----------
clang/unittests/Format/TokenAnnotatorTest.cpp | 20 ++++++++++++----
2 files changed, 26 insertions(+), 18 deletions(-)
diff --git a/clang/lib/Format/UnwrappedLineParser.cpp b/clang/lib/Format/UnwrappedLineParser.cpp
index 4439292af629dd..ab2d15055a5aba 100644
--- a/clang/lib/Format/UnwrappedLineParser.cpp
+++ b/clang/lib/Format/UnwrappedLineParser.cpp
@@ -3918,25 +3918,23 @@ bool UnwrappedLineParser::parseEnum() {
if (Style.Language == FormatStyle::LK_Proto && FormatTok->is(tok::equal))
return false;
- if (IsCpp) {
- // Eat up enum class ...
- if (FormatTok->isOneOf(tok::kw_class, tok::kw_struct))
+ // Eat up enum class ...
+ if (IsCpp&&FormatTok->isOneOf(tok::kw_class, tok::kw_struct))
nextToken();
- while (FormatTok->isOneOf(tok::l_square, TT_AttributeMacro)) {
- if (FormatTok->is(tok::l_square)) {
- if (!handleCppAttributes())
- return false;
- } else {
- // TT_AttributeMacro
- nextToken();
- }
- }
- }
while (FormatTok->Tok.getIdentifierInfo() ||
FormatTok->isOneOf(tok::colon, tok::coloncolon, tok::less,
tok::greater, tok::comma, tok::question,
tok::l_square)) {
+ if (FormatTok->is(TT_AttributeMacro)) {
+ nextToken();
+ continue;
+ }
+ if (IsCpp && FormatTok->is(tok::l_square)) {
+ if (handleCppAttributes())
+ continue;
+ return false;
+ }
if (FormatTok->is(tok::colon))
FormatTok->setFinalizedType(TT_EnumUnderlyingTypeColon);
if (Style.isVerilog()) {
diff --git a/clang/unittests/Format/TokenAnnotatorTest.cpp b/clang/unittests/Format/TokenAnnotatorTest.cpp
index 88f5e48a021fcd..25198e81085728 100644
--- a/clang/unittests/Format/TokenAnnotatorTest.cpp
+++ b/clang/unittests/Format/TokenAnnotatorTest.cpp
@@ -695,21 +695,31 @@ TEST_F(TokenAnnotatorTest, UnderstandsEnums) {
auto Style = getLLVMStyle();
Style.AttributeMacros = {"AttributeA", "AttributeB"};
- Tokens = annotate("enum class AttributeA AttributeB Enum {}", Style);
- ASSERT_EQ(Tokens.size(), 8u) << Tokens;
+ Tokens = annotate("enum class AttributeA AttributeB Enum {};", Style);
+ ASSERT_EQ(Tokens.size(), 9u) << Tokens;
EXPECT_TOKEN(Tokens[2], tok::identifier, TT_AttributeMacro);
EXPECT_TOKEN(Tokens[3], tok::identifier, TT_AttributeMacro);
EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_EnumLBrace);
EXPECT_TOKEN(Tokens[6], tok::r_brace, TT_EnumRBrace);
- Tokens =
- annotate("enum class AttributeA [[nodiscard]] AttributeB Enum {}", Style);
- ASSERT_EQ(Tokens.size(), 13u) << Tokens;
+ Tokens = annotate("enum class AttributeA [[nodiscard]] AttributeB Enum {};",
+ Style);
+ ASSERT_EQ(Tokens.size(), 14u) << Tokens;
EXPECT_TOKEN(Tokens[2], tok::identifier, TT_AttributeMacro);
EXPECT_TOKEN(Tokens[3], tok::l_square, TT_AttributeLSquare);
EXPECT_TOKEN(Tokens[8], tok::identifier, TT_AttributeMacro);
EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_EnumLBrace);
EXPECT_TOKEN(Tokens[11], tok::r_brace, TT_EnumRBrace);
+
+ Tokens = annotate("enum __attribute__((deprecated)) Foo {};");
+ ASSERT_EQ(Tokens.size(), 12u) << Tokens;
+ EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_EnumLBrace);
+ EXPECT_TOKEN(Tokens[9], tok::r_brace, TT_EnumRBrace);
+
+ Tokens = annotate("enum __declspec(deprecated) Foo {};");
+ ASSERT_EQ(Tokens.size(), 10u) << Tokens;
+ EXPECT_TOKEN(Tokens[6], tok::l_brace, TT_EnumLBrace);
+ EXPECT_TOKEN(Tokens[7], tok::r_brace, TT_EnumRBrace);
}
TEST_F(TokenAnnotatorTest, UnderstandsExportBlock) {
>From 23d89e72bc1ab30e81b0cc0b0518c758755954da Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Sch=C3=A4pers?= <bjoern at hazardy.de>
Date: Thu, 8 Oct 2026 22:15:23 +0200
Subject: [PATCH 3/5] Format
---
clang/lib/Format/UnwrappedLineParser.cpp | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/clang/lib/Format/UnwrappedLineParser.cpp b/clang/lib/Format/UnwrappedLineParser.cpp
index ab2d15055a5aba..e5b48c3be630fa 100644
--- a/clang/lib/Format/UnwrappedLineParser.cpp
+++ b/clang/lib/Format/UnwrappedLineParser.cpp
@@ -3918,9 +3918,9 @@ bool UnwrappedLineParser::parseEnum() {
if (Style.Language == FormatStyle::LK_Proto && FormatTok->is(tok::equal))
return false;
- // Eat up enum class ...
- if (IsCpp&&FormatTok->isOneOf(tok::kw_class, tok::kw_struct))
- nextToken();
+ // Eat up enum class ...
+ if (IsCpp && FormatTok->isOneOf(tok::kw_class, tok::kw_struct))
+ nextToken();
while (FormatTok->Tok.getIdentifierInfo() ||
FormatTok->isOneOf(tok::colon, tok::coloncolon, tok::less,
>From 764ef0632cd31dfe8e1768a541c3d36594ed67da Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Sch=C3=A4pers?= <bjoern at hazardy.de>
Date: Mon, 19 Oct 2026 21:26:22 +0200
Subject: [PATCH 4/5] Address Review
---
clang/lib/Format/UnwrappedLineParser.cpp | 4 +++-
clang/unittests/Format/TokenAnnotatorTest.cpp | 12 ++++++++----
2 files changed, 11 insertions(+), 5 deletions(-)
diff --git a/clang/lib/Format/UnwrappedLineParser.cpp b/clang/lib/Format/UnwrappedLineParser.cpp
index e5b48c3be630fa..2a6c7f9957699c 100644
--- a/clang/lib/Format/UnwrappedLineParser.cpp
+++ b/clang/lib/Format/UnwrappedLineParser.cpp
@@ -3947,8 +3947,10 @@ bool UnwrappedLineParser::parseEnum() {
nextToken();
}
// We can have macros or attributes in between 'enum' and the enum name.
- if (FormatTok->is(tok::l_paren))
+ if (FormatTok->is(tok::l_paren)) {
parseParens();
+ continue;
+ }
if (FormatTok->is(tok::identifier)) {
nextToken();
// If there are two identifiers in a row, this is likely an elaborate
diff --git a/clang/unittests/Format/TokenAnnotatorTest.cpp b/clang/unittests/Format/TokenAnnotatorTest.cpp
index 25198e81085728..cc0aa985a4e79b 100644
--- a/clang/unittests/Format/TokenAnnotatorTest.cpp
+++ b/clang/unittests/Format/TokenAnnotatorTest.cpp
@@ -697,20 +697,24 @@ TEST_F(TokenAnnotatorTest, UnderstandsEnums) {
Style.AttributeMacros = {"AttributeA", "AttributeB"};
Tokens = annotate("enum class AttributeA AttributeB Enum {};", Style);
ASSERT_EQ(Tokens.size(), 9u) << Tokens;
- EXPECT_TOKEN(Tokens[2], tok::identifier, TT_AttributeMacro);
- EXPECT_TOKEN(Tokens[3], tok::identifier, TT_AttributeMacro);
EXPECT_TOKEN(Tokens[5], tok::l_brace, TT_EnumLBrace);
EXPECT_TOKEN(Tokens[6], tok::r_brace, TT_EnumRBrace);
Tokens = annotate("enum class AttributeA [[nodiscard]] AttributeB Enum {};",
Style);
ASSERT_EQ(Tokens.size(), 14u) << Tokens;
- EXPECT_TOKEN(Tokens[2], tok::identifier, TT_AttributeMacro);
EXPECT_TOKEN(Tokens[3], tok::l_square, TT_AttributeLSquare);
- EXPECT_TOKEN(Tokens[8], tok::identifier, TT_AttributeMacro);
EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_EnumLBrace);
EXPECT_TOKEN(Tokens[11], tok::r_brace, TT_EnumRBrace);
+ Tokens = annotate(
+ "enum class AttributeA __attribute__((nodiscard)) AttributeB Enum {};",
+ Style);
+ ASSERT_EQ(Tokens.size(), 15u) << Tokens;
+ EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_AttributeLParen);
+ EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_EnumLBrace);
+ EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_EnumRBrace);
+
Tokens = annotate("enum __attribute__((deprecated)) Foo {};");
ASSERT_EQ(Tokens.size(), 12u) << Tokens;
EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_EnumLBrace);
>From e87fe8d1a266f1474dbf667bab08fba0ce58fa68 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Sch=C3=A4pers?= <github at hazardy.de>
Date: Mon, 9 Nov 2026 21:05:59 +0100
Subject: [PATCH 5/5] Apply batched suggestions from code review
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Co-authored-by: Björn Schäpers <github at hazardy.de>
---
clang/unittests/Format/TokenAnnotatorTest.cpp | 2 --
1 file changed, 2 deletions(-)
diff --git a/clang/unittests/Format/TokenAnnotatorTest.cpp b/clang/unittests/Format/TokenAnnotatorTest.cpp
index cc0aa985a4e79b..ae8bb1104a575c 100644
--- a/clang/unittests/Format/TokenAnnotatorTest.cpp
+++ b/clang/unittests/Format/TokenAnnotatorTest.cpp
@@ -703,7 +703,6 @@ TEST_F(TokenAnnotatorTest, UnderstandsEnums) {
Tokens = annotate("enum class AttributeA [[nodiscard]] AttributeB Enum {};",
Style);
ASSERT_EQ(Tokens.size(), 14u) << Tokens;
- EXPECT_TOKEN(Tokens[3], tok::l_square, TT_AttributeLSquare);
EXPECT_TOKEN(Tokens[10], tok::l_brace, TT_EnumLBrace);
EXPECT_TOKEN(Tokens[11], tok::r_brace, TT_EnumRBrace);
@@ -711,7 +710,6 @@ TEST_F(TokenAnnotatorTest, UnderstandsEnums) {
"enum class AttributeA __attribute__((nodiscard)) AttributeB Enum {};",
Style);
ASSERT_EQ(Tokens.size(), 15u) << Tokens;
- EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_AttributeLParen);
EXPECT_TOKEN(Tokens[11], tok::l_brace, TT_EnumLBrace);
EXPECT_TOKEN(Tokens[12], tok::r_brace, TT_EnumRBrace);
More information about the cfe-commits
mailing list