[clang-format] Respect Cpp11BraceListStyle when aligning array of structures

[hch12907]

Summary

When Cpp11BraceListStyle is set to false and AlignArrayOfStructures is
set, the first and last elements of a braced list should not be joined
to the brace.

Fixes #57611.

[hch12907]

Added unit tests

[MyDeveloperDay]

clang/unittests/Format/FormatTest.cpp

20273

any reason you didn't use verifyFormat here?

[hch12907]

clang/unittests/Format/FormatTest.cpp

20273

No particular reason - I simply copied other tests and modified them to suit the Cpp11BracedListStyle == false case, and one of those tests used EXPECT_EQ.

Should I change it to verifyFormat?

[MyDeveloperDay]

clang/unittests/Format/FormatTest.cpp

20273

yes please as this tests the code getting messup and putting it back to normal

20276

just because we go over the limit do you think its correct that it pushes this back?

clang/lib/Format/WhitespaceManager.cpp

if (Changes[CellIter->Index].Tok->is(tok::r_brace)) {
       // Unless the array is empty, we need the position of all the
       // immediately adjacent cells
       if (CellIter != Cells.begin()) {
         auto ThisNetWidth =
             getNetWidth(Cells.begin(), CellIter, CellDescs.InitialSpaces);
         auto MaxNetWidth = getMaximumNetWidth(
             Cells.begin(), CellIter, CellDescs.InitialSpaces,
             CellDescs.CellCounts[0], CellDescs.CellCounts.size());
+        // If Cpp11BraceListStyle is false, the braces need to be space-separated from
+        // the elements.
+        if (!Style.Cpp11BracedListStyle)
+          MaxNetWidth += 1;
         if (ThisNetWidth < MaxNetWidth)
           Changes[CellIter->Index].Spaces = (MaxNetWidth - ThisNetWidth);
         auto RowCount = 1U;
         auto Offset = std::distance(Cells.begin(), CellIter);
         for (const auto *Next = CellIter->NextColumnElement; Next;
              Next = Next->NextColumnElement) {
           auto *Start = (Cells.begin() + RowCount * CellDescs.CellCounts[0]);
           auto *End = Start + Offset;
           ThisNetWidth = getNetWidth(Start, End, CellDescs.InitialSpaces);
           if (ThisNetWidth < MaxNetWidth)
             Changes[Next->Index].Spaces = (MaxNetWidth - ThisNetWidth);
           ++RowCount;
         }
       }
     } else {
       auto ThisWidth =
           calculateCellWidth(CellIter->Index, CellIter->EndIndex, true) +
           NetWidth;
+      auto BeginSpace = (i > 0) ? 1 : (Style.Cpp11BracedListStyle ? 0 : 1);
       if (Changes[CellIter->Index].NewlinesBefore == 0) {
         Changes[CellIter->Index].Spaces = (CellWidth - (ThisWidth + NetWidth));
-        Changes[CellIter->Index].Spaces += (i > 0) ? 1 : 0;
+        Changes[CellIter->Index].Spaces += BeginSpace;
       }
       alignToStartOfCell(CellIter->Index, CellIter->EndIndex);
       for (const auto *Next = CellIter->NextColumnElement; Next;
            Next = Next->NextColumnElement) {
         ThisWidth =
             calculateCellWidth(Next->Index, Next->EndIndex, true) + NetWidth;
         if (Changes[Next->Index].NewlinesBefore == 0) {
           Changes[Next->Index].Spaces = (CellWidth - ThisWidth);
-          Changes[Next->Index].Spaces += (i > 0) ? 1 : 0;
+          Changes[Next->Index].Spaces += BeginSpace;
         }
         alignToStartOfCell(Next->Index, Next->EndIndex);
       }
     }
   }
 }
 
 void WhitespaceManager::alignArrayInitializersLeftJustified(
     CellDescriptions &&CellDescs) {
 
   if (!CellDescs.isRectangular())
     return;
 
   auto &Cells = CellDescs.Cells;
   // Now go through and fixup the spaces.
   auto *CellIter = Cells.begin();
-  // The first cell needs to be against the left brace.
+  // The first cell needs to be against the left brace, unless
+  // Cpp11BracedListStyle is enabled.
   if (Changes[CellIter->Index].NewlinesBefore == 0)
-    Changes[CellIter->Index].Spaces = 0;
+    Changes[CellIter->Index].Spaces = Style.Cpp11BracedListStyle ? 0 : 1;
   else
     Changes[CellIter->Index].Spaces = CellDescs.InitialSpaces;
   ++CellIter;
   for (auto i = 1U; i < CellDescs.CellCounts[0]; i++, ++CellIter) {
     auto MaxNetWidth = getMaximumNetWidth(
         Cells.begin(), CellIter, CellDescs.InitialSpaces,
         CellDescs.CellCounts[0], CellDescs.CellCounts.size());
     auto ThisNetWidth =
         getNetWidth(Cells.begin(), CellIter, CellDescs.InitialSpaces);
     if (Changes[CellIter->Index].NewlinesBefore == 0) {
       Changes[CellIter->Index].Spaces =
           MaxNetWidth - ThisNetWidth +
-          (Changes[CellIter->Index].Tok->isNot(tok::r_brace) ? 1 : 0);
+          (Changes[CellIter->Index].Tok->isNot(tok::r_brace)
+               ? 1
+               : (Style.Cpp11BracedListStyle ? 0 : 1));
     }
     auto RowCount = 1U;
     auto Offset = std::distance(Cells.begin(), CellIter);
     for (const auto *Next = CellIter->NextColumnElement; Next;
          Next = Next->NextColumnElement) {
       if (RowCount > CellDescs.CellCounts.size())
         break;
       auto *Start = (Cells.begin() + RowCount * CellDescs.CellCounts[0]);
       auto *End = Start + Offset;
       auto ThisNetWidth = getNetWidth(Start, End, CellDescs.InitialSpaces);
       if (Changes[Next->Index].NewlinesBefore == 0) {
         Changes[Next->Index].Spaces =
             MaxNetWidth - ThisNetWidth +
-            (Changes[Next->Index].Tok->isNot(tok::r_brace) ? 1 : 0);
+            (Changes[Next->Index].Tok->isNot(tok::r_brace)
+                 ? 1
+                 : (Style.Cpp11BracedListStyle ? 0 : 1));
       }
       ++RowCount;
     }
   }
 }
 
 bool WhitespaceManager::isSplitCell(const CellDescription &Cell) {
   if (Cell.HasSplit)

clang/unittests/Format/FormatTest.cpp

EXPECT_EQ(
       "     \"multiple lines\",    23},\n"
       "    {-1,      \"world\", 93463},\n"
       "    { 7,         \"!!\",     5},\n"
       "};",
       format("test demo[] = {{56, \"hello world i am a very long line "
              "that really, in any just world, ought to be split over multiple "
              "lines\", 23},{-1, \"world\", 93463},{7, \"!!\", 5},};",
              Style));
+
+  Style.Cpp11BracedListStyle = false;
+  Style.ColumnLimit = 20;
+  EXPECT_EQ(
+      "demo = std::array<\n"
+      "    struct test, 3>{\n"
+      "  test{\n"
+      "       56,    23,\n"
+      "       \"hello world \"\n"
+      "       \"i am a very \"\n"
+      "       \"long line \"\n"
+      "       \"that \"\n"
+      "       \"really, in \"\n"
+      "       \"any just \"\n"
+      "       \"world, \"\n"
+      "       \"ought to be \"\n"
+      "       \"split over \"\n"
+      "       \"multiple \"\n"
+      "       \"lines\" },\n"
+      "  test{ -1, 93463,\n"
+      "       \"world\" },\n"
+      "  test{  7,     5,\n"
+      "       \"!!\"    },\n"
+      "};",
+      format("demo = std::array<struct test, 3>{test{56, 23, \"hello world "
+             "i am a very long line that really, in any just world, ought "
+             "to be split over multiple lines\"},test{-1, 93463, \"world\"},"
+             "test{7, 5, \"!!\"},};",
+             Style));
+
+  Style.ColumnLimit = 100;
+  verifyFormat("struct test demo[] = {\n"
+      "  { 56,    23, \"hello\" },\n"
+      "  { -1, 93463, \"world\" },\n"
+      "  {  7,     5,    \"!!\" }\n"
+      "};\n"
+      "struct test demo[4] = {\n"
+      "  {  56,    23, 21,       \"oh\" }, // first line\n"
+      "  {  -1, 93463, 22,       \"my\" }, // second line\n"
+      "  {   7,     5,  1, \"goodness\" }  // third line\n"
+      "  { 234,     5,  1, \"gracious\" }  // fourth line\n"
+      "};\n",
+      Style);
+  EXPECT_EQ(
+      "test demo[] = {\n"
+      "  { 56,\n"
+      "   \"hello world i am a very long line that really, in any just world"
+      ", ought to be split over \"\n"
+      "   \"multiple lines\",    23 },\n"
+      "  { -1,     \"world\", 93463 },\n"
+      "  {  7,        \"!!\",     5 },\n"
+      "};",
+      format("test demo[] = {{56, \"hello world i am a very long line "
+             "that really, in any just world, ought to be split over multiple "
+             "lines\", 23},{-1, \"world\", 93463},{7, \"!!\", 5},};",
+             Style));
 }
 
 TEST_F(FormatTest, CatchAlignArrayOfStructuresLeftAlignment) {
   auto Style = getLLVMStyle();
   Style.AlignArrayOfStructures = FormatStyle::AIAS_Left;
   /* FIXME: This case gets misformatted.
   verifyFormat("auto foo = Items{\n"
                "    Section{0, bar(), },\n"
EXPECT_EQ(
       "     \"multiple lines\"  },\n"
       "    {-1, 93463, \"world\"},\n"
       "    {7,  5,     \"!!\"   },\n"
       "};",
       format("test demo[] = {{56, 23, \"hello world i am a very long line "
              "that really, in any just world, ought to be split over multiple "
              "lines\"},{-1, 93463, \"world\"},{7, 5, \"!!\"},};",
              Style));
+
+  Style.Cpp11BracedListStyle = false;
+  Style.ColumnLimit = 20;
+  EXPECT_EQ(
+      "demo = std::array<\n"
+      "    struct test, 3>{\n"
+      "  test{\n"
+      "       56,  23,\n"
+      "       \"hello world \"\n"
+      "       \"i am a very \"\n"
+      "       \"long line \"\n"
+      "       \"that \"\n"
+      "       \"really, in \"\n"
+      "       \"any just \"\n"
+      "       \"world, \"\n"
+      "       \"ought to be \"\n"
+      "       \"split over \"\n"
+      "       \"multiple \"\n"
+      "       \"lines\" },\n"
+      "  test{ -1, 93463,\n"
+      "       \"world\" },\n"
+      "  test{ 7,  5,\n"
+      "       \"!!\"    },\n"
+      "};",
+      format("demo = std::array<struct test, 3>{test{56, 23, \"hello world "
+             "i am a very long line that really, in any just world, ought "
+             "to be split over multiple lines\"},test{-1, 93463, \"world\"},"
+             "test{7, 5, \"!!\"},};",
+             Style));
+  Style.ColumnLimit = 100;
+  verifyFormat("test demo[] = {\n"
+               "  { 56, /* a comment */ 23, \"hello\" },\n"
+               "  { -1, 93463,              \"world\" },\n"
+               "  { 7,  5,                  \"!!\"    }\n"
+               "};\n",
+               Style);
+
+  EXPECT_EQ(
+      "test demo[] = {\n"
+      "  { 56, 23,\n"
+      "   \"hello world i am a very long line that really, in any just world"
+      ", ought to be split over \"\n"
+      "   \"multiple lines\"    },\n"
+      "  { -1, 93463, \"world\" },\n"
+      "  { 7,  5,     \"!!\"    },\n"
+      "};",
+      format("test demo[] = {{56, 23, \"hello world i am a very long line "
+             "that really, in any just world, ought to be split over multiple "
+             "lines\"},{-1, 93463, \"world\"},{7, 5, \"!!\"},};",
+             Style));
 }
 
 TEST_F(FormatTest, UnderstandsPragmas) {
   verifyFormat("#pragma omp reduction(| : var)");
   verifyFormat("#pragma omp reduction(+ : var)");
 
   EXPECT_EQ("#pragma mark Any non-hyphenated or hyphenated string "
             "(including parentheses).",