From: Daniel Jasper <djasper@google.com>
Date: Tue, 22 Sep 2015 09:32:00 +0000 (+0000)
Subject: clang-format: Fix alignConsecutiveAssignments.
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=21b3f468fc871980e422404f35fcac7de83cfa9c;p=clang

clang-format: Fix alignConsecutiveAssignments.

It wasn't correctly handling this case:

  int oneTwoThree = 123;
  int oneTwo      = 12;
  method();

Review: http://reviews.llvm.org/D12369
Patch by Beren Minor. Thank you!

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@248254 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/lib/Format/WhitespaceManager.cpp b/lib/Format/WhitespaceManager.cpp
index 65395277f8..3d6040e90c 100644
--- a/lib/Format/WhitespaceManager.cpp
+++ b/lib/Format/WhitespaceManager.cpp
@@ -156,41 +156,53 @@ void WhitespaceManager::alignConsecutiveAssignments() {
   unsigned EndOfSequence = 0;
   bool FoundAssignmentOnLine = false;
   bool FoundLeftParenOnLine = false;
-  unsigned CurrentLine = 0;
 
+  // Aligns a sequence of assignment tokens, on the MinColumn column.
+  //
+  // Sequences start from the first assignment token to align, and end at the
+  // first token of the first line that doesn't need to be aligned.
+  //
+  // We need to adjust the StartOfTokenColumn of each Change that is on a line
+  // containing any assignment to be aligned and located after such assignment
   auto AlignSequence = [&] {
-    alignConsecutiveAssignments(StartOfSequence, EndOfSequence, MinColumn);
+    if (StartOfSequence > 0 && StartOfSequence < EndOfSequence)
+      alignConsecutiveAssignments(StartOfSequence, EndOfSequence, MinColumn);
     MinColumn = 0;
     StartOfSequence = 0;
     EndOfSequence = 0;
   };
 
   for (unsigned i = 0, e = Changes.size(); i != e; ++i) {
-    if (Changes[i].NewlinesBefore != 0) {
-      CurrentLine += Changes[i].NewlinesBefore;
-      if (StartOfSequence > 0 &&
-          (Changes[i].NewlinesBefore > 1 || !FoundAssignmentOnLine)) {
-        EndOfSequence = i;
+    if (Changes[i].NewlinesBefore > 0) {
+      EndOfSequence = i;
+      // If there is a blank line or if the last line didn't contain any
+      // assignment, the sequence ends here.
+      if (Changes[i].NewlinesBefore > 1 || !FoundAssignmentOnLine) {
+        // NB: In the latter case, the sequence should end at the beggining of
+        // the previous line, but it doesn't really matter as there is no
+        // assignment on it
         AlignSequence();
       }
+
       FoundAssignmentOnLine = false;
       FoundLeftParenOnLine = false;
     }
 
-    if ((Changes[i].Kind == tok::equal &&
-         (FoundAssignmentOnLine || ((Changes[i].NewlinesBefore > 0 ||
-                                     Changes[i + 1].NewlinesBefore > 0)))) ||
-        (!FoundLeftParenOnLine && Changes[i].Kind == tok::r_paren)) {
-      if (StartOfSequence > 0)
-        AlignSequence();
+    // If there is more than one "=" per line, or if the "=" appears first on
+    // the line of if it appears last, end the sequence
+    if (Changes[i].Kind == tok::equal &&
+        (FoundAssignmentOnLine || Changes[i].NewlinesBefore > 0 ||
+         Changes[i + 1].NewlinesBefore > 0)) {
+      AlignSequence();
+    } else if (!FoundLeftParenOnLine && Changes[i].Kind == tok::r_paren) {
+      AlignSequence();
     } else if (Changes[i].Kind == tok::l_paren) {
       FoundLeftParenOnLine = true;
-      if (!FoundAssignmentOnLine && StartOfSequence > 0)
+      if (!FoundAssignmentOnLine)
         AlignSequence();
     } else if (!FoundAssignmentOnLine && !FoundLeftParenOnLine &&
                Changes[i].Kind == tok::equal) {
       FoundAssignmentOnLine = true;
-      EndOfSequence = i;
       if (StartOfSequence == 0)
         StartOfSequence = i;
 
@@ -199,36 +211,34 @@ void WhitespaceManager::alignConsecutiveAssignments() {
     }
   }
 
-  if (StartOfSequence > 0) {
-    EndOfSequence = Changes.size();
-    AlignSequence();
-  }
+  EndOfSequence = Changes.size();
+  AlignSequence();
 }
 
 void WhitespaceManager::alignConsecutiveAssignments(unsigned Start,
                                                     unsigned End,
                                                     unsigned Column) {
-  bool AlignedAssignment = false;
-  int PreviousShift = 0;
+  bool FoundAssignmentOnLine = false;
+  int Shift = 0;
   for (unsigned i = Start; i != End; ++i) {
-    int Shift = 0;
-    if (Changes[i].NewlinesBefore > 0)
-      AlignedAssignment = false;
-    if (!AlignedAssignment && Changes[i].Kind == tok::equal) {
+    if (Changes[i].NewlinesBefore > 0) {
+      FoundAssignmentOnLine = false;
+      Shift = 0;
+    }
+
+    // If this is the first assignment to be aligned, remember by how many
+    // spaces it has to be shifted, so the rest of the changes on the line are
+    // shifted by the same amount
+    if (!FoundAssignmentOnLine && Changes[i].Kind == tok::equal) {
+      FoundAssignmentOnLine = true;
       Shift = Column - Changes[i].StartOfTokenColumn;
-      AlignedAssignment = true;
-      PreviousShift = Shift;
+      Changes[i].Spaces += Shift;
     }
+
     assert(Shift >= 0);
-    Changes[i].Spaces += Shift;
+    Changes[i].StartOfTokenColumn += Shift;
     if (i + 1 != Changes.size())
       Changes[i + 1].PreviousEndOfTokenColumn += Shift;
-    Changes[i].StartOfTokenColumn += Shift;
-    if (AlignedAssignment) {
-      Changes[i].StartOfTokenColumn += PreviousShift;
-      if (i + 1 != Changes.size())
-        Changes[i + 1].PreviousEndOfTokenColumn += PreviousShift;
-    }
   }
 }
 
diff --git a/unittests/Format/FormatTest.cpp b/unittests/Format/FormatTest.cpp
index e392cf880c..8549ec6ef4 100644
--- a/unittests/Format/FormatTest.cpp
+++ b/unittests/Format/FormatTest.cpp
@@ -8540,6 +8540,10 @@ TEST_F(FormatTest, AlignConsecutiveAssignments) {
                "int oneTwoThree = 123;\n"
                "int oneTwo      = 12;",
                Alignment);
+  verifyFormat("int oneTwoThree = 123;\n"
+               "int oneTwo      = 12;\n"
+               "method();\n",
+               Alignment);
   verifyFormat("int oneTwoThree = 123; // comment\n"
                "int oneTwo      = 12;  // comment",
                Alignment);