[clang-format] Don't break block comments when sorting includes.

[curdeius]

Summary

Fixes https://github.com/llvm/llvm-project/issues/34626.

Before, the include sorter would break the code:

#include <stdio.h>
#include <stdint.h> /* long
                       comment */

and change it into:

#include <stdint.h> /* long
#include <stdio.h>
                       comment */

This commit handles only the most basic case of a single block comment on an include line, but does not try to handle all the possible edge cases with multiple comments.

[curdeius]

Remove commented code. NFC.

clang/lib/Format/Format.cpp

const bool EmptyLineSkipped =
         (Style.IncludeStyle.IncludeBlocks == tooling::IncludeStyle::IBS_Merge ||
          Style.IncludeStyle.IncludeBlocks ==
              tooling::IncludeStyle::IBS_Regroup);
 
     bool MergeWithNextLine = Trimmed.endswith("\\");
     if (!FormattingOff && !MergeWithNextLine) {
       if (IncludeRegex.match(Line, &Matches)) {
         StringRef IncludeName = Matches[2];
+        if (Line.contains("/*") && !Line.contains("*/")) {
+          // #include with a start of a block comment, but without the end.
+          // Need to keep all the lines until the end of the comment together.
+          // FIXME: This is somehow simplified check that probably does not work
+          // correctly if there are multiple comments on a line.
+          Pos = Code.find("*/", SearchFrom);
+          Line = Code.substr(
+              Prev, (Pos != StringRef::npos ? Pos + 2 : Code.size()) - Prev);
+        }
         int Category = Categories.getIncludePriority(
             IncludeName,
             /*CheckMainHeader=*/!MainIncludeFound && FirstIncludeBlock);
         int Priority = Categories.getSortIncludePriority(
             IncludeName, !MainIncludeFound && FirstIncludeBlock);
         if (Category == 0)
           MainIncludeFound = true;
         IncludesInBlock.push_back(

clang/unittests/Format/SortIncludesTest.cpp

EXPECT_EQ("// comment\n"
             "#include <a>\n"
             "#include <b>\n",
             sort("// comment\n"
                  "#include <b>\n"
                  "#include <a>\n",
                  {tooling::Range(25, 1)}));
 }
 
+TEST_F(SortIncludesTest, TrailingComments) {
+  EXPECT_EQ("#include \"a.h\"\n"
+            "#include \"b.h\" /* long\n"
+            "                  * long\n"
+            "                  * comment*/\n"
+            "#include \"c.h\"\n"
+            "#include \"d.h\"\n",
+            sort("#include \"a.h\"\n"
+                 "#include \"c.h\"\n"
+                 "#include \"b.h\" /* long\n"
+                 "                  * long\n"
+                 "                  * comment*/\n"
+                 "#include \"d.h\"\n"));
+}
+
 TEST_F(SortIncludesTest, SortedIncludesUsingSortPriorityAttribute) {
   FmtStyle.IncludeStyle.IncludeBlocks = tooling::IncludeStyle::IBS_Regroup;
   FmtStyle.IncludeStyle.IncludeCategories = {
       {"^<sys/param\\.h>", 1, 0, false},
       {"^<sys/types\\.h>", 1, 1, false},
       {"^<sys.*/", 1, 2, false},
       {"^<uvm/", 2, 3, false},
       {"^<machine/", 3, 4, false},