Skip to content

[clang-format] Fix annotating attrs in class/struct #124634

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.

Sign up for GitHub

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

Closed
wants to merge 2 commits into from
Closed

[clang-format] Fix annotating attrs in class/struct #124634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5292f11
[clang-format] Fix annotating attrs in class/struct
gedare Jan 27, 2025
be98609
Replace format test with annotator test
gedare Jan 28, 2025
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
14 changes: 11 additions & 3 deletions clang/lib/Format/TokenAnnotator.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2633,12 +2633,20 @@ class AnnotatingParser {
PreviousNotConst->MatchingParen->Previous->isNot(tok::kw_template);
}

if ((PreviousNotConst->is(tok::r_paren) &&
PreviousNotConst->is(TT_TypeDeclarationParen)) ||
PreviousNotConst->is(TT_AttributeRParen)) {
if (PreviousNotConst->is(tok::r_paren) &&
PreviousNotConst->is(TT_TypeDeclarationParen)) {
return true;
}

auto InTypeDecl = [&]() {
for (auto Next = Tok.Next; Next; Next = Next->Next)
Copy link
Contributor

@owenca owenca Jan 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A more robust and efficient way would be to annotate the class name in UnwrappedLineParser as most of the work has already been done there. I'll submit a patch soon.

Copy link
Contributor

@owenca owenca Jan 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #124891.

if (Next->isOneOf(TT_ClassLBrace, TT_StructLBrace))
return true;
return false;
};
if (PreviousNotConst->is(TT_AttributeRParen) && (!IsCpp || !InTypeDecl()))
return true;

// If is a preprocess keyword like #define.
if (IsPPKeyword)
return false;
Expand Down
9 changes: 9 additions & 0 deletions clang/unittests/Format/TokenAnnotatorTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3123,6 +3123,15 @@ TEST_F(TokenAnnotatorTest, UnderstandsAttributes) {
EXPECT_TOKEN(Tokens[7], tok::identifier, TT_FunctionDeclarationName);
EXPECT_TOKEN(Tokens[8], tok::l_paren, TT_FunctionDeclarationLParen);

Tokens = annotate("struct __attribute__((x)) foo {};");
ASSERT_EQ(Tokens.size(), 12u) << Tokens;
EXPECT_TOKEN(Tokens[2], tok::l_paren, TT_AttributeLParen);
EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_Unknown);
EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_Unknown);
EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_AttributeRParen);
EXPECT_TOKEN(Tokens[7], tok::identifier, TT_Unknown);
EXPECT_TOKEN(Tokens[8], tok::l_brace, TT_StructLBrace);

FormatStyle Style = getLLVMStyle();
Style.AttributeMacros.push_back("FOO");
Tokens = annotate("bool foo FOO(unused);", Style);
Expand Down