Add 'src/jexer/' from commit 'cf01c92f5809a0732409e280fb0f32f27393618d'
[nikiroo-utils.git] / src / jexer / TEditorWidget.java
index cf4d887fd3cba5525637f406e4b776e517950d54..a694533bf6df0ed3ee4d6e694f0d1b507deab7a3 100644 (file)
@@ -3,7 +3,7 @@
  *
  * The MIT License (MIT)
  *
- * Copyright (C) 2017 Kevin Lamonte
+ * Copyright (C) 2019 Kevin Lamonte
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
  * copy of this software and associated documentation files (the "Software"),
@@ -43,7 +43,20 @@ import static jexer.TKeypress.*;
  * TEditorWidget displays an editable text document.  It is unaware of
  * scrolling behavior, but can respond to mouse and keyboard events.
  */
-public final class TEditorWidget extends TWidget {
+public class TEditorWidget extends TWidget {
+
+    // ------------------------------------------------------------------------
+    // Constants --------------------------------------------------------------
+    // ------------------------------------------------------------------------
+
+    /**
+     * The number of lines to scroll on mouse wheel up/down.
+     */
+    private static final int wheelScrollSize = 3;
+
+    // ------------------------------------------------------------------------
+    // Variables --------------------------------------------------------------
+    // ------------------------------------------------------------------------
 
     /**
      * The document being edited.
@@ -65,6 +78,10 @@ public final class TEditorWidget extends TWidget {
      */
     private int leftColumn = 0;
 
+    // ------------------------------------------------------------------------
+    // Constructors -----------------------------------------------------------
+    // ------------------------------------------------------------------------
+
     /**
      * Public constructor.
      *
@@ -87,6 +104,10 @@ public final class TEditorWidget extends TWidget {
         document = new Document(text, defaultColor);
     }
 
+    // ------------------------------------------------------------------------
+    // TWidget ----------------------------------------------------------------
+    // ------------------------------------------------------------------------
+
     /**
      * Draw the text box.
      */
@@ -112,7 +133,6 @@ public final class TEditorWidget extends TWidget {
                 }
             }
         }
-
     }
 
     /**
@@ -123,16 +143,20 @@ public final class TEditorWidget extends TWidget {
     @Override
     public void onMouseDown(final TMouseEvent mouse) {
         if (mouse.isMouseWheelUp()) {
-            if (topLine > 0) {
-                topLine--;
-                alignDocument(false);
+            for (int i = 0; i < wheelScrollSize; i++) {
+                if (topLine > 0) {
+                    topLine--;
+                    alignDocument(false);
+                }
             }
             return;
         }
         if (mouse.isMouseWheelDown()) {
-            if (topLine < document.getLineCount() - 1) {
-                topLine++;
-                alignDocument(true);
+            for (int i = 0; i < wheelScrollSize; i++) {
+                if (topLine < document.getLineCount() - 1) {
+                    topLine++;
+                    alignDocument(true);
+                }
             }
             return;
         }
@@ -141,14 +165,14 @@ public final class TEditorWidget extends TWidget {
             // Set the row and column
             int newLine = topLine + mouse.getY();
             int newX = leftColumn + mouse.getX();
-            if (newLine > document.getLineCount()) {
+            if (newLine > document.getLineCount() - 1) {
                 // Go to the end
                 document.setLineNumber(document.getLineCount() - 1);
                 document.end();
-                if (document.getLineCount() > getHeight()) {
-                    setCursorY(getHeight() - 1);
+                if (newLine > document.getLineCount() - 1) {
+                    setCursorY(document.getLineCount() - 1 - topLine);
                 } else {
-                    setCursorY(document.getLineCount() - 1);
+                    setCursorY(mouse.getY());
                 }
                 alignCursor();
                 return;
@@ -156,10 +180,11 @@ public final class TEditorWidget extends TWidget {
 
             document.setLineNumber(newLine);
             setCursorY(mouse.getY());
-            if (newX > document.getCurrentLine().getDisplayLength()) {
+            if (newX >= document.getCurrentLine().getDisplayLength()) {
                 document.end();
                 alignCursor();
             } else {
+                document.setCursor(newX);
                 setCursorX(mouse.getX());
             }
             return;
@@ -169,86 +194,6 @@ public final class TEditorWidget extends TWidget {
         super.onMouseDown(mouse);
     }
 
-    /**
-     * Align visible area with document current line.
-     *
-     * @param topLineIsTop if true, make the top visible line the document
-     * current line if it was off-screen.  If false, make the bottom visible
-     * line the document current line.
-     */
-    private void alignTopLine(final boolean topLineIsTop) {
-        int line = document.getLineNumber();
-
-        if ((line < topLine) || (line > topLine + getHeight() - 1)) {
-            // Need to move topLine to bring document back into view.
-            if (topLineIsTop) {
-                topLine = line - (getHeight() - 1);
-            } else {
-                topLine = line;
-            }
-        }
-
-        /*
-        System.err.println("line " + line + " topLine " + topLine);
-        */
-
-        // Document is in view, let's set cursorY
-        setCursorY(line - topLine);
-        alignCursor();
-    }
-
-    /**
-     * Align document current line with visible area.
-     *
-     * @param topLineIsTop if true, make the top visible line the document
-     * current line if it was off-screen.  If false, make the bottom visible
-     * line the document current line.
-     */
-    private void alignDocument(final boolean topLineIsTop) {
-        int line = document.getLineNumber();
-
-        if ((line < topLine) || (line > topLine + getHeight() - 1)) {
-            // Need to move document to ensure it fits view.
-            if (topLineIsTop) {
-                document.setLineNumber(topLine);
-            } else {
-                document.setLineNumber(topLine + (getHeight() - 1));
-            }
-        }
-
-        /*
-        System.err.println("getLineNumber() " + document.getLineNumber() +
-            " topLine " + topLine);
-        */
-
-        // Document is in view, let's set cursorY
-        setCursorY(document.getLineNumber() - topLine);
-        alignCursor();
-    }
-
-    /**
-     * Align visible cursor with document cursor.
-     */
-    private void alignCursor() {
-        int width = getWidth();
-
-        int desiredX = document.getCursor() - leftColumn;
-        if (desiredX < 0) {
-            // We need to push the screen to the left.
-            leftColumn = document.getCursor();
-        } else if (desiredX > width - 1) {
-            // We need to push the screen to the right.
-            leftColumn = document.getCursor() - (width - 1);
-        }
-
-        /*
-        System.err.println("document cursor " + document.getCursor() +
-            " leftColumn " + leftColumn);
-         */
-
-        setCursorX(document.getCursor() - leftColumn);
-    }
-
     /**
      * Handle keystrokes.
      *
@@ -257,13 +202,21 @@ public final class TEditorWidget extends TWidget {
     @Override
     public void onKeypress(final TKeypressEvent keypress) {
         if (keypress.equals(kbLeft)) {
-            if (document.left()) {
-                alignCursor();
-            }
+            document.left();
+            alignTopLine(false);
         } else if (keypress.equals(kbRight)) {
-            if (document.right()) {
-                alignCursor();
-            }
+            document.right();
+            alignTopLine(true);
+        } else if (keypress.equals(kbAltLeft)
+            || keypress.equals(kbCtrlLeft)
+        ) {
+            document.backwardsWord();
+            alignTopLine(false);
+        } else if (keypress.equals(kbAltRight)
+            || keypress.equals(kbCtrlRight)
+        ) {
+            document.forwardsWord();
+            alignTopLine(true);
         } else if (keypress.equals(kbUp)) {
             document.up();
             alignTopLine(false);
@@ -302,14 +255,23 @@ public final class TEditorWidget extends TWidget {
         } else if (keypress.equals(kbIns)) {
             document.setOverwrite(!document.getOverwrite());
         } else if (keypress.equals(kbDel)) {
-            // TODO: join lines
             document.del();
             alignCursor();
-        } else if (keypress.equals(kbBackspace)) {
+        } else if (keypress.equals(kbBackspace)
+            || keypress.equals(kbBackspaceDel)
+        ) {
             document.backspace();
+            alignTopLine(false);
+        } else if (keypress.equals(kbTab)) {
+            // TODO: tab character.  For now just add spaces until we hit
+            // modulo 8.
+            for (int i = document.getCursor(); (i + 1) % 8 != 0; i++) {
+                document.addChar(' ');
+            }
             alignCursor();
         } else if (keypress.equals(kbEnter)) {
-            // TODO: split lines
+            document.enter();
+            alignTopLine(true);
         } else if (!keypress.getKey().isFnKey()
             && !keypress.getKey().isAlt()
             && !keypress.getKey().isCtrl()
@@ -351,6 +313,101 @@ public final class TEditorWidget extends TWidget {
         }
     }
 
+    // ------------------------------------------------------------------------
+    // TEditorWidget ----------------------------------------------------------
+    // ------------------------------------------------------------------------
+
+    /**
+     * Align visible area with document current line.
+     *
+     * @param topLineIsTop if true, make the top visible line the document
+     * current line if it was off-screen.  If false, make the bottom visible
+     * line the document current line.
+     */
+    private void alignTopLine(final boolean topLineIsTop) {
+        int line = document.getLineNumber();
+
+        if ((line < topLine) || (line > topLine + getHeight() - 1)) {
+            // Need to move topLine to bring document back into view.
+            if (topLineIsTop) {
+                topLine = line - (getHeight() - 1);
+                if (topLine < 0) {
+                    topLine = 0;
+                }
+                assert (topLine >= 0);
+            } else {
+                topLine = line;
+                assert (topLine >= 0);
+            }
+        }
+
+        /*
+        System.err.println("line " + line + " topLine " + topLine);
+        */
+
+        // Document is in view, let's set cursorY
+        assert (line >= topLine);
+        setCursorY(line - topLine);
+        alignCursor();
+    }
+
+    /**
+     * Align document current line with visible area.
+     *
+     * @param topLineIsTop if true, make the top visible line the document
+     * current line if it was off-screen.  If false, make the bottom visible
+     * line the document current line.
+     */
+    private void alignDocument(final boolean topLineIsTop) {
+        int line = document.getLineNumber();
+        int cursor = document.getCursor();
+
+        if ((line < topLine) || (line > topLine + getHeight() - 1)) {
+            // Need to move document to ensure it fits view.
+            if (topLineIsTop) {
+                document.setLineNumber(topLine);
+            } else {
+                document.setLineNumber(topLine + (getHeight() - 1));
+            }
+            if (cursor < document.getCurrentLine().getDisplayLength()) {
+                document.setCursor(cursor);
+            }
+        }
+
+        /*
+        System.err.println("getLineNumber() " + document.getLineNumber() +
+            " topLine " + topLine);
+        */
+
+        // Document is in view, let's set cursorY
+        setCursorY(document.getLineNumber() - topLine);
+        alignCursor();
+    }
+
+    /**
+     * Align visible cursor with document cursor.
+     */
+    private void alignCursor() {
+        int width = getWidth();
+
+        int desiredX = document.getCursor() - leftColumn;
+        if (desiredX < 0) {
+            // We need to push the screen to the left.
+            leftColumn = document.getCursor();
+        } else if (desiredX > width - 1) {
+            // We need to push the screen to the right.
+            leftColumn = document.getCursor() - (width - 1);
+        }
+
+        /*
+        System.err.println("document cursor " + document.getCursor() +
+            " leftColumn " + leftColumn);
+        */
+
+
+        setCursorX(document.getCursor() - leftColumn);
+    }
+
     /**
      * Get the number of lines in the underlying Document.
      *
@@ -360,6 +417,28 @@ public final class TEditorWidget extends TWidget {
         return document.getLineCount();
     }
 
+    /**
+     * Get the current visible top row number.  1-based.
+     *
+     * @return the visible top row number.  Row 1 is the first row.
+     */
+    public int getVisibleRowNumber() {
+        return topLine + 1;
+    }
+
+    /**
+     * Set the current visible row number.  1-based.
+     *
+     * @param row the new visible row number.  Row 1 is the first row.
+     */
+    public void setVisibleRowNumber(final int row) {
+        assert (row > 0);
+        if ((row > 0) && (row < document.getLineCount())) {
+            topLine = row - 1;
+            alignDocument(true);
+        }
+    }
+
     /**
      * Get the current editing row number.  1-based.
      *
@@ -375,7 +454,34 @@ public final class TEditorWidget extends TWidget {
      * @param row the new editing row number.  Row 1 is the first row.
      */
     public void setEditingRowNumber(final int row) {
-        document.setLineNumber(row - 1);
+        assert (row > 0);
+        if ((row > 0) && (row < document.getLineCount())) {
+            document.setLineNumber(row - 1);
+            alignTopLine(true);
+        }
+    }
+
+    /**
+     * Set the current visible column number.  1-based.
+     *
+     * @return the visible column number.  Column 1 is the first column.
+     */
+    public int getVisibleColumnNumber() {
+        return leftColumn + 1;
+    }
+
+    /**
+     * Set the current visible column number.  1-based.
+     *
+     * @param column the new visible column number.  Column 1 is the first
+     * column.
+     */
+    public void setVisibleColumnNumber(final int column) {
+        assert (column > 0);
+        if ((column > 0) && (column < document.getLineLengthMax())) {
+            leftColumn = column - 1;
+            alignDocument(true);
+        }
     }
 
     /**
@@ -394,7 +500,10 @@ public final class TEditorWidget extends TWidget {
      * column.
      */
     public void setEditingColumnNumber(final int column) {
-        document.setCursor(column - 1);
+        if ((column > 0) && (column < document.getLineLength())) {
+            document.setCursor(column - 1);
+            alignCursor();
+        }
     }
 
     /**