Skip to content

[clang-format] Handle __attribute/__declspec/AttributeMacro consistently #67518

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

Merged
merged 1 commit into from
Sep 29, 2023
Merged

[clang-format] Handle __attribute/__declspec/AttributeMacro consistently #67518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 16 additions & 20 deletions clang/lib/Format/FormatToken.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -618,6 +618,10 @@ struct FormatToken {

bool isStringLiteral() const { return tok::isStringLiteral(Tok.getKind()); }

bool isAttribute() const {
return isOneOf(tok::kw___attribute, tok::kw___declspec, TT_AttributeMacro);
}

bool isObjCAtKeyword(tok::ObjCKeywordKind Kind) const {
return Tok.isObjCAtKeyword(Kind);
}
Expand All @@ -633,9 +637,10 @@ struct FormatToken {

bool canBePointerOrReferenceQualifier() const {
return isOneOf(tok::kw_const, tok::kw_restrict, tok::kw_volatile,
tok::kw___attribute, tok::kw__Nonnull, tok::kw__Nullable,
tok::kw__Nonnull, tok::kw__Nullable,
tok::kw__Null_unspecified, tok::kw___ptr32, tok::kw___ptr64,
tok::kw___funcref, TT_AttributeMacro);
tok::kw___funcref) ||
isAttribute();
}

/// Determine whether the token is a simple-type-specifier.
Expand Down Expand Up @@ -708,25 +713,16 @@ struct FormatToken {
/// Returns \c true if this is a keyword that can be used
/// like a function call (e.g. sizeof, typeid, ...).
bool isFunctionLikeKeyword() const {
switch (Tok.getKind()) {
case tok::kw_throw:
case tok::kw_typeid:
case tok::kw_return:
case tok::kw_sizeof:
case tok::kw_alignof:
case tok::kw_alignas:
case tok::kw_decltype:
case tok::kw_noexcept:
case tok::kw_static_assert:
case tok::kw__Atomic:
case tok::kw___attribute:
#define TRANSFORM_TYPE_TRAIT_DEF(_, Trait) case tok::kw___##Trait:
#include "clang/Basic/TransformTypeTraits.def"
case tok::kw_requires:
if (isAttribute())
return true;
default:
return false;
}

return isOneOf(tok::kw_throw, tok::kw_typeid, tok::kw_return,
tok::kw_sizeof, tok::kw_alignof, tok::kw_alignas,
tok::kw_decltype, tok::kw_noexcept, tok::kw_static_assert,
tok::kw__Atomic,
#define TRANSFORM_TYPE_TRAIT_DEF(_, Trait) tok::kw___##Trait,
#include "clang/Basic/TransformTypeTraits.def"
tok::kw_requires);
}

/// Returns \c true if this is a string literal that's like a label,
Expand Down
2 changes: 1 addition & 1 deletion clang/lib/Format/NamespaceEndCommentsFixer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ processTokens(const FormatToken *Tok, tok::TokenKind StartTok,
const FormatToken *skipAttribute(const FormatToken *Tok) {
if (!Tok)
return nullptr;
if (Tok->is(tok::kw___attribute)) {
if (Tok->isAttribute()) {
Tok = Tok->getNextNonComment();
Tok = processTokens(Tok, tok::l_paren, tok::r_paren, nullptr);
} else if (Tok->is(tok::l_square)) {
Expand Down
23 changes: 13 additions & 10 deletions clang/lib/Format/TokenAnnotator.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,7 @@ class AnnotatingParser {
// Infer the role of the l_paren based on the previous token if we haven't
// detected one yet.
if (PrevNonComment && OpeningParen.is(TT_Unknown)) {
if (PrevNonComment->is(tok::kw___attribute)) {
if (PrevNonComment->isAttribute()) {
OpeningParen.setType(TT_AttributeLParen);
} else if (PrevNonComment->isOneOf(TT_TypenameMacro, tok::kw_decltype,
tok::kw_typeof,
Expand Down Expand Up @@ -1207,11 +1207,13 @@ class AnnotatingParser {
return false;
if (Line.MustBeDeclaration && Contexts.size() == 1 &&
!Contexts.back().IsExpression && !Line.startsWith(TT_ObjCProperty) &&
!Tok->isOneOf(TT_TypeDeclarationParen, TT_RequiresExpressionLParen) &&
(!Tok->Previous ||
!Tok->Previous->isOneOf(tok::kw___attribute, TT_RequiresClause,
TT_LeadingJavaAnnotation))) {
Line.MightBeFunctionDecl = true;
!Tok->isOneOf(TT_TypeDeclarationParen, TT_RequiresExpressionLParen)) {
if (const auto *Previous = Tok->Previous;
!Previous ||
(!Previous->isAttribute() &&
!Previous->isOneOf(TT_RequiresClause, TT_LeadingJavaAnnotation))) {
Line.MightBeFunctionDecl = true;
}
}
break;
case tok::l_square:
Expand Down Expand Up @@ -2389,7 +2391,7 @@ class AnnotatingParser {
assert(T->MatchingParen->is(tok::l_paren));
assert(T->MatchingParen->is(TT_AttributeLParen));
if (const auto *Tok = T->MatchingParen->Previous;
Tok && Tok->is(tok::kw___attribute)) {
Tok && Tok->isAttribute()) {
T = Tok->Previous;
continue;
}
Expand Down Expand Up @@ -5607,10 +5609,11 @@ bool TokenAnnotator::canBreakBefore(const AnnotatedLine &Line,
tok::less, tok::coloncolon);
}

if (Right.is(tok::kw___attribute) ||
(Right.is(tok::l_square) && Right.is(TT_AttributeSquare))) {
if (Right.isAttribute())
return true;

if (Right.is(tok::l_square) && Right.is(TT_AttributeSquare))
return Left.isNot(TT_AttributeSquare);
}

if (Left.is(tok::identifier) && Right.is(tok::string_literal))
return true;
Expand Down
6 changes: 3 additions & 3 deletions clang/lib/Format/UnwrappedLineParser.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ bool UnwrappedLineParser::parseLevel(const FormatToken *OpeningBrace,
bool SwitchLabelEncountered = false;

do {
if (FormatTok->getType() == TT_AttributeMacro) {
if (FormatTok->isAttribute()) {
nextToken();
continue;
}
Expand Down Expand Up @@ -2658,7 +2658,7 @@ static void markOptionalBraces(FormatToken *LeftBrace) {

void UnwrappedLineParser::handleAttributes() {
// Handle AttributeMacro, e.g. `if (x) UNLIKELY`.
if (FormatTok->is(TT_AttributeMacro))
if (FormatTok->isAttribute())
nextToken();
else if (FormatTok->is(tok::l_square))
handleCppAttributes();
Expand Down Expand Up @@ -3832,8 +3832,8 @@ void UnwrappedLineParser::parseRecord(bool ParseAsExpr) {
// it is often token-pasted.
// An [[attribute]] can be before the identifier.
while (FormatTok->isOneOf(tok::identifier, tok::coloncolon, tok::hashhash,
tok::kw___attribute, tok::kw___declspec,
tok::kw_alignas, tok::l_square) ||
FormatTok->isAttribute() ||
((Style.Language == FormatStyle::LK_Java || Style.isJavaScript()) &&
FormatTok->isOneOf(tok::period, tok::comma))) {
if (Style.isJavaScript() &&
Expand Down
13 changes: 13 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 @@ -2079,6 +2079,19 @@ TEST_F(TokenAnnotatorTest, UnderstandsAttributes) {
EXPECT_TOKEN(Tokens[4], tok::l_paren, TT_Unknown);
EXPECT_TOKEN(Tokens[6], tok::r_paren, TT_Unknown);
EXPECT_TOKEN(Tokens[7], tok::r_paren, TT_AttributeRParen);

Tokens = annotate("bool foo __declspec(dllimport);");
ASSERT_EQ(Tokens.size(), 8u) << Tokens;
EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_AttributeRParen);

FormatStyle Style = getLLVMStyle();
Style.AttributeMacros.push_back("FOO");
Tokens = annotate("bool foo FOO(unused);", Style);
ASSERT_EQ(Tokens.size(), 8u) << Tokens;
EXPECT_TOKEN(Tokens[2], tok::identifier, TT_AttributeMacro);
EXPECT_TOKEN(Tokens[3], tok::l_paren, TT_AttributeLParen);
EXPECT_TOKEN(Tokens[5], tok::r_paren, TT_AttributeRParen);
}

} // namespace
Expand Down