Autoformat keeps cursor position after Undo

cmaglie · cmaglie · commit 09c662651380 · 2021-05-21T14:08:20.000+02:00
diff --git a/app/src/cc/arduino/packages/formatter/clangformat/ClangFormat.java b/app/src/cc/arduino/packages/formatter/clangformat/ClangFormat.java
@@ -46,7 +46,7 @@
 import processing.app.Base;
 import processing.app.BaseNoGui;
 import processing.app.Editor;
-import processing.app.EditorTab;
+import processing.app.syntax.SketchTextArea;
 
 public class ClangFormat implements Runnable {
 
@@ -60,17 +60,27 @@ public ClangFormat(Editor editor) {
 
   @Override
   public void run() {
-    EditorTab tab = editor.getCurrentTab();
+    SketchTextArea tab = editor.getCurrentTab().getTextArea();
     String originalText = tab.getText();
-    int cursorOffset = tab.getTextArea().getCaretPosition();
+    int cursorOffset = tab.getCaretPosition();
     try {
       FormatResult result = runClangFormatOn(originalText, cursorOffset);
       if (result.FormattedText.equals(originalText)) {
         editor.statusNotice(tr("No changes necessary for Auto Format."));
         return;
       }
+
+      // To keep cursor position after UNDO we produce a bogus edit (insertion
+      // and removal of a " " at cursor position) and we compound this change
+      // with the full auto-format update.
+      tab.beginAtomicEdit();
+      tab.insert(" ", cursorOffset);
+      tab.replaceRange("", cursorOffset, cursorOffset + 1);
       tab.setText(result.FormattedText);
-      tab.getTextArea().setCaretPosition(result.Cursor);
+      tab.endAtomicEdit();
+
+      tab.setCaretPosition(result.Cursor);
+
       editor.statusNotice(tr("Auto Format finished."));
     } catch (IOException | InterruptedException e) {
       editor.statusError("Auto format error: " + e.getMessage());
diff --git a/app/test/processing/app/AutoformatProducesOneUndoActionTest.java b/app/test/processing/app/AutoformatProducesOneUndoActionTest.java
@@ -74,7 +74,8 @@ public void shouldSaveCaretPositionAfterAutoformat() {
     String formattedText = editor.getText();
     assertEquals(SOURCE_AFTER, formattedText);
 
-    assertEquals(29, editor.getCaretPosition());
+    // Autoformat with clang-format keeps cursor relative to source code
+    assertEquals(17, editor.getCaretPosition());
 
     menuEditUndo.requireEnabled();
     menuEditUndo.click();
diff --git a/app/test/processing/app/AutoformatSavesCaretPositionTest.java b/app/test/processing/app/AutoformatSavesCaretPositionTest.java
@@ -68,7 +68,8 @@ public void shouldSaveCaretPositionAfterAutoformat() {
             "\n" +
             "}", formattedText);
 
-    assertEquals(29, editor.getCaretPosition());
+    // Autoformat with clang-format keeps cursor relative to source code
+    assertEquals(17, editor.getCaretPosition());
 
   }
 

Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,8 @@ public void shouldSaveCaretPositionAfterAutoformat() {`
`68`	`68`	`"\n" +`
`69`	`69`	`"}", formattedText);`
`70`	`70`
`71`		`- assertEquals(29, editor.getCaretPosition());`
	`71`	`+ // Autoformat with clang-format keeps cursor relative to source code`
	`72`	`+ assertEquals(17, editor.getCaretPosition());`
`72`	`73`
`73`	`74`	`}`
`74`	`75`