[clang-format] Emit absolute splits before lines for comments

[krasimir]

Summary

This patch makes the splits emitted for the beginning of comment lines during
reformatting absolute. Previously, they were relative to the start of the
non-whitespace content of the line, which messes up further TailOffset
calculations in breakProtrudingToken. This fixes an assertion failure reported
in bug 34236: https://bugs.llvm.org/show_bug.cgi?id=34236.

[djasper]

lib/Format/BreakableToken.cpp

553–559

I think a split cannot be "Trimmed". Maybe "Result" or "NewSplit"?

557

Why do you create a new split instead of:

TrimmedSplit += Content[LineIndex].size() - TrimmedContent.size();

?

unittests/Format/FormatTestComments.cpp

2785

s/crusher/crasher/

:-D

Also, I'd just remove " bug 34236", seems redundant.

[krasimir]

• Address review comments

[djasper]

Looks good.

lib/Format/BreakableToken.cpp

void BreakableBlockComment::insertBreak(unsigned LineIndex, unsigned TailOffset,
   assert(LocalIndentAtLineBreak >= Prefix.size());
   Whitespaces.replaceWhitespaceInToken(
       tokenAt(LineIndex), BreakOffsetInToken, CharsToRemove, "", Prefix,
       InPPDirective, /*Newlines=*/1,
       /*Spaces=*/LocalIndentAtLineBreak - Prefix.size());
 }
 
 BreakableToken::Split BreakableBlockComment::getSplitBefore(
-    unsigned LineIndex,
-    unsigned PreviousEndColumn,
-    unsigned ColumnLimit,
+    unsigned LineIndex, unsigned PreviousEndColumn, unsigned ColumnLimit,
     llvm::Regex &CommentPragmasRegex) const {
   if (!mayReflow(LineIndex, CommentPragmasRegex))
     return Split(StringRef::npos, 0);
   StringRef TrimmedContent = Content[LineIndex].ltrim(Blanks);
-  return getReflowSplit(TrimmedContent, ReflowPrefix, PreviousEndColumn,
+  Split Result = getReflowSplit(TrimmedContent, ReflowPrefix, PreviousEndColumn,
                                 ColumnLimit);
+  // Result is relative to TrimmedContent. Adapt it relative to
+  // Content[LineIndex].
+  if (Result.first != StringRef::npos)
+    Result.first += Content[LineIndex].size() - TrimmedContent.size();
+  return Result;
 }
 
 unsigned BreakableBlockComment::getReflownColumn(
     StringRef Content,
     unsigned LineIndex,
     unsigned PreviousEndColumn) const {
     unsigned StartColumn = PreviousEndColumn + ReflowPrefix.size();
     // If this is the last line, it will carry around its '*/' postfix.
unsigned WhitespaceLength = TrimmedContent.data() -
         tokenAt(LineIndex).TokenText.data() -
         WhitespaceOffsetInToken;
     Whitespaces.replaceWhitespaceInToken(
         tokenAt(LineIndex), WhitespaceOffsetInToken,
         /*ReplaceChars=*/WhitespaceLength, /*PreviousPostfix=*/"",
         /*CurrentPrefix=*/ReflowPrefix, InPPDirective, /*Newlines=*/0,
         /*Spaces=*/0);
     // Check if we need to also insert a break at the whitespace range.
-    // For this we first adapt the reflow split relative to the beginning of the
-    // content.
     // Note that we don't need a penalty for this break, since it doesn't change
     // the total number of lines.
-    Split BreakSplit = SplitBefore;
-    BreakSplit.first += TrimmedContent.data() - Content[LineIndex].data();
     unsigned ReflownColumn =
         getReflownColumn(TrimmedContent, LineIndex, PreviousEndColumn);
-    if (ReflownColumn > ColumnLimit) {
-      insertBreak(LineIndex, 0, BreakSplit, Whitespaces);
-    }
+    if (ReflownColumn > ColumnLimit)
+      insertBreak(LineIndex, 0, SplitBefore, Whitespaces);
     return;
   }
 
   // Here no reflow with the previous line will happen.
   // Fix the decoration of the line at LineIndex.
   StringRef Prefix = Decoration;
   if (Content[LineIndex].empty()) {
     if (LineIndex + 1 == Lines.size()) {

unittests/Format/FormatTestComments.cpp

EXPECT_EQ("/*\n"
             " * long */",
             format("/*\n"
                    " * long long long long\n"
                    " * long\n"
                    "  *\n"
                    "* long */",
                    getLLVMStyleWithColumns(20)));
 }
+
+TEST_F(FormatTestComments, NoCrush_Bug34236) {
+  // This is a test case from a crasher reported in:
+  // https://bugs.llvm.org/show_bug.cgi?id=34236
+  EXPECT_EQ(
+      R"(
+/*                                                                */ /*
+                                                                      *       a
+                                                                      * b c
+                                                                      * d*/)",
+      format(
+          R"(
+/*                                                                */ /*
+ *       a b
+ *       c     d*/)",
+          getLLVMStyleWithColumns(80)));
+}
 } // end namespace
 } // end namespace format
 } // end namespace clang