Skip to content

Commit d7f7fb6

Browse files
HazardyKnusperkeksHazardyKnusperkeks
committed
[clang-format] Remove special handling of comments after brace/paren
Fixes http://llvm.org/PR55487 (#55487) The code did not match the documentation about Cpp11BracedListStyle. Changed handling of comments after opening braces, which are supposedly function call like to behave exactly like their parenthesis counter part.
1 parent 349e25f commit d7f7fb6

File tree

4 files changed

+94
-27
lines changed

4 files changed

+94
-27
lines changed

‎clang/lib/Format/ContinuationIndenter.cpp‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -925,7 +925,10 @@ void ContinuationIndenter::addTokenOnCurrentLine(LineState &State, bool DryRun,
925925
TT_TableGenDAGArgOpenerToBreak) &&
926926
!(Current.MacroParent && Previous.MacroParent) &&
927927
(Current.isNot(TT_LineComment) ||
928-
Previous.isOneOf(BK_BracedInit, TT_VerilogMultiLineListLParen)) &&
928+
(Previous.is(BK_BracedInit) &&
929+
(!Style.Cpp11BracedListStyle || !Previous.Previous ||
930+
Previous.Previous->isNotOneOf(tok::identifier, tok::l_paren))) ||
931+
Previous.is(TT_VerilogMultiLineListLParen)) &&
929932
!IsInTemplateString(Current)) {
930933
CurrentState.Indent = State.Column + Spaces;
931934
CurrentState.IsAligned = true;

‎clang/lib/Format/TokenAnnotator.cpp‎

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4102,16 +4102,9 @@ void TokenAnnotator::calculateFormattingInformation(AnnotatedLine &Line) const {
41024102
for (auto *Current = First->Next; Current; Current = Current->Next) {
41034103
const FormatToken *Prev = Current->Previous;
41044104
if (Current->is(TT_LineComment)) {
4105-
if (Prev->is(BK_BracedInit) && Prev->opensScope()) {
4106-
Current->SpacesRequiredBefore =
4107-
(Style.Cpp11BracedListStyle && !Style.SpacesInParensOptions.Other)
4108-
? 0
4109-
: 1;
4110-
} else if (Prev->is(TT_VerilogMultiLineListLParen)) {
4111-
Current->SpacesRequiredBefore = 0;
4112-
} else {
4113-
Current->SpacesRequiredBefore = Style.SpacesBeforeTrailingComments;
4114-
}
4105+
Current->SpacesRequiredBefore = Prev->is(TT_VerilogMultiLineListLParen)
4106+
? 0
4107+
: Style.SpacesBeforeTrailingComments;
41154108

41164109
// If we find a trailing comment, iterate backwards to determine whether
41174110
// it seems to relate to a specific parameter. If so, break before that

‎clang/unittests/Format/FormatTest.cpp‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14291,20 +14291,18 @@ TEST_F(FormatTest, LayoutCxx11BraceInitializers) {
1429114291
" CDDDP83848_RBR_REGISTER};",
1429214292
NoBinPacking);
1429314293

14294-
// FIXME: The alignment of these trailing comments might be bad. Then again,
14295-
// this might be utterly useless in real code.
1429614294
verifyFormat("Constructor::Constructor()\n"
14297-
" : some_value{ //\n"
14298-
" aaaaaaa, //\n"
14299-
" bbbbbbb} {}");
14295+
" : some_value{ //\n"
14296+
" aaaaaaa, //\n"
14297+
" bbbbbbb} {}");
1430014298

1430114299
// In braced lists, the first comment is always assumed to belong to the
1430214300
// first element. Thus, it can be moved to the next or previous line as
1430314301
// appropriate.
14304-
verifyFormat("function({// First element:\n"
14305-
" 1,\n"
14306-
" // Second element:\n"
14307-
" 2});",
14302+
verifyFormat("function({ // First element:\n"
14303+
" 1,\n"
14304+
" // Second element:\n"
14305+
" 2});",
1430814306
"function({\n"
1430914307
" // First element:\n"
1431014308
" 1,\n"
@@ -14426,7 +14424,7 @@ TEST_F(FormatTest, LayoutCxx11BraceInitializers) {
1442614424
verifyFormat("vector< int > x{ 1, 2, 3, 4 };", SpaceBetweenBraces);
1442714425
verifyFormat("f( {}, { {}, {} }, MyMap[ { k, v } ] );", SpaceBetweenBraces);
1442814426
verifyFormat("vector< int > x{ // comment 1\n"
14429-
" 1, 2, 3, 4 };",
14427+
" 1, 2, 3, 4 };",
1443014428
SpaceBetweenBraces);
1443114429
SpaceBetweenBraces.ColumnLimit = 20;
1443214430
verifyFormat("vector< int > x{\n"

‎clang/unittests/Format/FormatTestComments.cpp‎

Lines changed: 79 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1474,12 +1474,12 @@ TEST_F(FormatTestComments, CommentsInStaticInitializers) {
14741474
verifyFormat("S s = {{a, b, c}, // Group #1\n"
14751475
" {d, e, f}, // Group #2\n"
14761476
" {g, h, i}}; // Group #3");
1477-
verifyFormat("S s = {{// Group #1\n"
1478-
" a, b, c},\n"
1479-
" {// Group #2\n"
1480-
" d, e, f},\n"
1481-
" {// Group #3\n"
1482-
" g, h, i}};");
1477+
verifyFormat("S s = {{ // Group #1\n"
1478+
" a, b, c},\n"
1479+
" { // Group #2\n"
1480+
" d, e, f},\n"
1481+
" { // Group #3\n"
1482+
" g, h, i}};");
14831483

14841484
EXPECT_EQ("S s = {\n"
14851485
" // Some comment\n"
@@ -4699,6 +4699,79 @@ TEST_F(FormatTestComments, SplitCommentIntroducers) {
46994699
getLLVMStyleWithColumns(10)));
47004700
}
47014701

4702+
TEST_F(FormatTestComments, LineCommentsOnStartOfFunctionCall) {
4703+
auto Style = getLLVMStyle();
4704+
4705+
EXPECT_TRUE(Style.Cpp11BracedListStyle);
4706+
4707+
verifyFormat("T foo( // Comment\n"
4708+
" arg);",
4709+
Style);
4710+
4711+
verifyFormat("T bar{ // Comment\n"
4712+
" arg};",
4713+
Style);
4714+
4715+
verifyFormat("T baz({ // Comment\n"
4716+
" arg});",
4717+
Style);
4718+
4719+
verifyFormat("T baz{{ // Comment\n"
4720+
" arg}};",
4721+
Style);
4722+
4723+
verifyFormat("T b0z(f( // Comment\n"
4724+
" arg));",
4725+
Style);
4726+
4727+
verifyFormat("T b0z(F{ // Comment\n"
4728+
" arg});",
4729+
Style);
4730+
4731+
verifyFormat("func( // Comment\n"
4732+
" arg);",
4733+
Style);
4734+
4735+
verifyFormat("func({ // Comment\n"
4736+
" arg});",
4737+
Style);
4738+
4739+
Style.Cpp11BracedListStyle = false;
4740+
4741+
verifyFormat("T foo( // Comment\n"
4742+
" arg);",
4743+
Style);
4744+
4745+
verifyFormat("T bar{ // Comment\n"
4746+
" arg\n"
4747+
"};",
4748+
Style);
4749+
4750+
verifyFormat("T baz({ // Comment\n"
4751+
" arg });",
4752+
Style);
4753+
4754+
verifyFormat("T baz{ { // Comment\n"
4755+
" arg } };",
4756+
Style);
4757+
4758+
verifyFormat("T b0z(f( // Comment\n"
4759+
" arg));",
4760+
Style);
4761+
4762+
verifyFormat("T b0z(F{ // Comment\n"
4763+
" arg });",
4764+
Style);
4765+
4766+
verifyFormat("func( // Comment\n"
4767+
" arg);",
4768+
Style);
4769+
4770+
verifyFormat("func({ // Comment\n"
4771+
" arg });",
4772+
Style);
4773+
}
4774+
47024775
} // end namespace
47034776
} // namespace test
47044777
} // end namespace format

0 commit comments

Comments
 (0)