Skip to content

[clang-forma] Support PointerAlignment for pointers to members #86253

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 2 commits into from
Mar 23, 2024
Merged

[clang-forma] Support PointerAlignment for pointers to members #86253

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
d1a3b74
[clang-forma] Support `PointerAlignment: Left` for pointer to member
owenca Mar 22, 2024
1cccb10
Added support for `Middle` and `Right` alignments.
owenca Mar 22, 2024
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
37 changes: 23 additions & 14 deletions clang/lib/Format/TokenAnnotator.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4351,9 +4351,11 @@ bool TokenAnnotator::spaceRequiredBetween(const AnnotatedLine &Line,
if (Left.is(tok::kw_auto) && Right.isOneOf(tok::l_paren, tok::l_brace))
return false;

const auto *BeforeLeft = Left.Previous;

// operator co_await(x)
if (Right.is(tok::l_paren) && Left.is(tok::kw_co_await) && Left.Previous &&
Left.Previous->is(tok::kw_operator)) {
if (Right.is(tok::l_paren) && Left.is(tok::kw_co_await) && BeforeLeft &&
BeforeLeft->is(tok::kw_operator)) {
return false;
}
// co_await (x), co_yield (x), co_return (x)
Expand Down Expand Up @@ -4388,8 +4390,10 @@ bool TokenAnnotator::spaceRequiredBetween(const AnnotatedLine &Line,
}
if (Left.is(tok::colon))
return Left.isNot(TT_ObjCMethodExpr);
if (Left.is(tok::coloncolon))
return false;
if (Left.is(tok::coloncolon)) {
return Right.is(tok::star) && Right.is(TT_PointerOrReference) &&
Style.PointerAlignment != FormatStyle::PAS_Left;
}
if (Left.is(tok::less) || Right.isOneOf(tok::greater, tok::less)) {
if (Style.Language == FormatStyle::LK_TextProto ||
(Style.Language == FormatStyle::LK_Proto &&
Expand All @@ -4404,8 +4408,8 @@ bool TokenAnnotator::spaceRequiredBetween(const AnnotatedLine &Line,
return false;
}
if (Right.is(tok::ellipsis)) {
return Left.Tok.isLiteral() || (Left.is(tok::identifier) && Left.Previous &&
Left.Previous->is(tok::kw_case));
return Left.Tok.isLiteral() || (Left.is(tok::identifier) && BeforeLeft &&
BeforeLeft->is(tok::kw_case));
}
if (Left.is(tok::l_square) && Right.is(tok::amp))
return Style.SpacesInSquareBrackets;
Expand Down Expand Up @@ -4473,8 +4477,8 @@ bool TokenAnnotator::spaceRequiredBetween(const AnnotatedLine &Line,
if (Right.is(tok::l_brace) && Right.is(BK_Block))
return true;
// for (auto a = 0, b = 0; const auto& c : {1, 2, 3})
if (Left.Previous && Left.Previous->isTypeOrIdentifier(IsCpp) &&
Right.Next && Right.Next->is(TT_RangeBasedForLoopColon)) {
if (BeforeLeft && BeforeLeft->isTypeOrIdentifier(IsCpp) && Right.Next &&
Right.Next->is(TT_RangeBasedForLoopColon)) {
return getTokenPointerOrReferenceAlignment(Left) !=
FormatStyle::PAS_Right;
}
Expand All @@ -4496,12 +4500,17 @@ bool TokenAnnotator::spaceRequiredBetween(const AnnotatedLine &Line,
startsWithInitStatement(Line)))) {
return false;
}
return Left.Previous && !Left.Previous->isOneOf(
tok::l_paren, tok::coloncolon, tok::l_square);
if (!BeforeLeft)
return false;
if (BeforeLeft->is(tok::coloncolon)) {
return Left.is(tok::star) &&
Style.PointerAlignment != FormatStyle::PAS_Right;
}
return !BeforeLeft->isOneOf(tok::l_paren, tok::l_square);
}
// Ensure right pointer alignment with ellipsis e.g. int *...P
if (Left.is(tok::ellipsis) && Left.Previous &&
Left.Previous->isPointerOrReference()) {
if (Left.is(tok::ellipsis) && BeforeLeft &&
BeforeLeft->isPointerOrReference()) {
return Style.PointerAlignment != FormatStyle::PAS_Right;
}

Expand Down Expand Up @@ -4663,13 +4672,13 @@ bool TokenAnnotator::spaceRequiredBetween(const AnnotatedLine &Line,
return Style.SpaceBeforeParensOptions.AfterFunctionDefinitionName ||
spaceRequiredBeforeParens(Right);
}
if (!Left.Previous || !Left.Previous->isOneOf(tok::period, tok::arrow)) {
if (!BeforeLeft || !BeforeLeft->isOneOf(tok::period, tok::arrow)) {
if (Left.isOneOf(tok::kw_try, Keywords.kw___except, tok::kw_catch)) {
return Style.SpaceBeforeParensOptions.AfterControlStatements ||
spaceRequiredBeforeParens(Right);
}
if (Left.isOneOf(tok::kw_new, tok::kw_delete)) {
return ((!Line.MightBeFunctionDecl || !Left.Previous) &&
return ((!Line.MightBeFunctionDecl || !BeforeLeft) &&
Style.SpaceBeforeParens != FormatStyle::SBPO_Never) ||
spaceRequiredBeforeParens(Right);
}
Expand Down
38 changes: 24 additions & 14 deletions clang/unittests/Format/FormatTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3621,8 +3621,8 @@ TEST_F(FormatTest, FormatsClasses) {
" : public aaaaaaaaaaaaaaaaaaa<aaaaaaaaaaaaaaaaaaaaa,\n"
" aaaaaaaaaaaaaaaaaaaaaa> {};");
verifyFormat("template <class R, class C>\n"
"struct Aaaaaaaaaaaaaaaaa<R (C::*)(int) const>\n"
" : Aaaaaaaaaaaaaaaaa<R (C::*)(int)> {};");
"struct Aaaaaaaaaaaaaaaaa<R (C:: *)(int) const>\n"
" : Aaaaaaaaaaaaaaaaa<R (C:: *)(int)> {};");
verifyFormat("class ::A::B {};");
}

Expand Down Expand Up @@ -11034,10 +11034,10 @@ TEST_F(FormatTest, UnderstandsBinaryOperators) {
}

TEST_F(FormatTest, UnderstandsPointersToMembers) {
verifyFormat("int A::*x;");
verifyFormat("int (S::*func)(void *);");
verifyFormat("void f() { int (S::*func)(void *); }");
verifyFormat("typedef bool *(Class::*Member)() const;");
verifyFormat("int A:: *x;");
verifyFormat("int (S:: *func)(void *);");
verifyFormat("void f() { int (S:: *func)(void *); }");
verifyFormat("typedef bool *(Class:: *Member)() const;");
verifyFormat("void f() {\n"
" (a->*f)();\n"
" a->*x;\n"
Expand All @@ -11052,9 +11052,19 @@ TEST_F(FormatTest, UnderstandsPointersToMembers) {
verifyFormat(
"(aaaaaaaaaa->*bbbbbbb)(\n"
" aaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaa));");

FormatStyle Style = getLLVMStyle();
EXPECT_EQ(Style.PointerAlignment, FormatStyle::PAS_Right);
verifyFormat("typedef bool *(Class:: *Member)() const;", Style);
verifyFormat("void f(int A:: *p) { int A:: *v = &A::B; }", Style);

Style.PointerAlignment = FormatStyle::PAS_Left;
verifyFormat("typedef bool* (Class::*Member)() const;", Style);
verifyFormat("typedef bool* (Class::* Member)() const;", Style);
verifyFormat("void f(int A::* p) { int A::* v = &A::B; }", Style);

Style.PointerAlignment = FormatStyle::PAS_Middle;
verifyFormat("typedef bool * (Class:: * Member)() const;", Style);
verifyFormat("void f(int A:: * p) { int A:: * v = &A::B; }", Style);
}

TEST_F(FormatTest, UnderstandsUnaryOperators) {
Expand Down Expand Up @@ -12386,7 +12396,7 @@ TEST_F(FormatTest, FormatsFunctionTypes) {
verifyFormat("int (*func)(void *);");
verifyFormat("void f() { int (*func)(void *); }");
verifyFormat("template <class CallbackClass>\n"
"using MyCallback = void (CallbackClass::*)(SomeObject *Data);");
"using Callback = void (CallbackClass:: *)(SomeObject *Data);");

verifyGoogleFormat("A<void*(int*, SomeType*)>;");
verifyGoogleFormat("void* (*a)(int);");
Expand Down Expand Up @@ -19149,13 +19159,13 @@ TEST_F(FormatTest, AlignConsecutiveDeclarations) {
"int bbbbbbb = 0;",
Alignment);
// http://llvm.org/PR68079
verifyFormat("using Fn = int (A::*)();\n"
"using RFn = int (A::*)() &;\n"
"using RRFn = int (A::*)() &&;",
verifyFormat("using Fn = int (A:: *)();\n"
"using RFn = int (A:: *)() &;\n"
"using RRFn = int (A:: *)() &&;",
Alignment);
verifyFormat("using Fn = int (A::*)();\n"
"using RFn = int *(A::*)() &;\n"
"using RRFn = double (A::*)() &&;",
verifyFormat("using Fn = int (A:: *)();\n"
"using RFn = int *(A:: *)() &;\n"
"using RRFn = double (A:: *)() &&;",
Alignment);

// PAS_Right
Expand Down
36 changes: 19 additions & 17 deletions clang/unittests/Format/QualifierFixerTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ TEST_F(QualifierFixerTest, RightQualifier) {
verifyFormat("Foo inline static const;", "Foo inline const static;", Style);
verifyFormat("Foo inline static const;", Style);

verifyFormat("Foo<T volatile>::Bar<Type const, 5> const volatile A::*;",
verifyFormat("Foo<T volatile>::Bar<Type const, 5> const volatile A:: *;",
"volatile const Foo<volatile T>::Bar<const Type, 5> A::*;",
Style);

Expand Down Expand Up @@ -523,14 +523,15 @@ TEST_F(QualifierFixerTest, RightQualifier) {
verifyFormat("const INTPTR a;", Style);

// Pointers to members
verifyFormat("int S::*a;", Style);
verifyFormat("int const S::*a;", "const int S:: *a;", Style);
verifyFormat("int const S::*const a;", "const int S::* const a;", Style);
verifyFormat("int A::*const A::*p1;", Style);
verifyFormat("float (C::*p)(int);", Style);
verifyFormat("float (C::*const p)(int);", Style);
verifyFormat("float (C::*p)(int) const;", Style);
verifyFormat("float const (C::*p)(int);", "const float (C::*p)(int);", Style);
verifyFormat("int S:: *a;", Style);
verifyFormat("int const S:: *a;", "const int S:: *a;", Style);
verifyFormat("int const S:: *const a;", "const int S::* const a;", Style);
verifyFormat("int A:: *const A:: *p1;", Style);
verifyFormat("float (C:: *p)(int);", Style);
verifyFormat("float (C:: *const p)(int);", Style);
verifyFormat("float (C:: *p)(int) const;", Style);
verifyFormat("float const (C:: *p)(int);", "const float (C::*p)(int);",
Style);
}

TEST_F(QualifierFixerTest, LeftQualifier) {
Expand Down Expand Up @@ -830,14 +831,15 @@ TEST_F(QualifierFixerTest, LeftQualifier) {
verifyFormat("INTPTR const a;", Style);

// Pointers to members
verifyFormat("int S::*a;", Style);
verifyFormat("const int S::*a;", "int const S:: *a;", Style);
verifyFormat("const int S::*const a;", "int const S::* const a;", Style);
verifyFormat("int A::*const A::*p1;", Style);
verifyFormat("float (C::*p)(int);", Style);
verifyFormat("float (C::*const p)(int);", Style);
verifyFormat("float (C::*p)(int) const;", Style);
verifyFormat("const float (C::*p)(int);", "float const (C::*p)(int);", Style);
verifyFormat("int S:: *a;", Style);
verifyFormat("const int S:: *a;", "int const S:: *a;", Style);
verifyFormat("const int S:: *const a;", "int const S::* const a;", Style);
verifyFormat("int A:: *const A:: *p1;", Style);
verifyFormat("float (C:: *p)(int);", Style);
verifyFormat("float (C:: *const p)(int);", Style);
verifyFormat("float (C:: *p)(int) const;", Style);
verifyFormat("const float (C:: *p)(int);", "float const (C::*p)(int);",
Style);
}

TEST_F(QualifierFixerTest, ConstVolatileQualifiersOrder) {
Expand Down