Add initial support for vim key bindings

Many things work, but not everything, of course:

* :g subcommands
* q for recording macros into registers

And probably many other things I don't use
constantly and haven't noticed missing yet.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Author: ctrueden

pom.xml

@@ -10,7 +10,7 @@
 	</parent>
 
 	<artifactId>script-editor</artifactId>
-	<version>1.3.1-SNAPSHOT</version>
+	<version>1.4.0-SNAPSHOT</version>
 
 	<name>SciJava Script Editor</name>
 	<description>Script Editor and Interpreter for SciJava script languages.</description>

src/main/java/org/scijava/ui/swing/script/EditorPane.java

@@ -35,6 +35,7 @@
 import java.awt.Dimension;
 import java.awt.Font;
 import java.awt.event.ActionEvent;
+import java.awt.event.KeyEvent;
 import java.awt.event.MouseAdapter;
 import java.awt.event.MouseEvent;
 import java.io.BufferedReader;
@@ -92,6 +93,7 @@
 import org.scijava.script.ScriptHeaderService;
 import org.scijava.script.ScriptLanguage;
 import org.scijava.script.ScriptService;
+import org.scijava.ui.swing.script.vim.VimHandler;
 import org.scijava.util.FileUtils;
 
 /**
@@ -121,6 +123,7 @@ public class EditorPane extends RSyntaxTextArea implements DocumentListener {
 	private final ErrorParser errorHighlighter;
 	private final JMenu noneLangSyntaxMenu;
 	private final EditorPaneActions actions;
+	private final VimHandler vim = new VimHandler(this);
 
 
 	@Parameter
@@ -434,6 +437,24 @@ boolean isWordChar(final RTextArea textArea, final int pos) {
 		};
 	}
 
+	@Override
+	protected void processKeyEvent(final KeyEvent e) {
+		if (vim.processKeyEvent(e)) e.consume();
+		else super.processKeyEvent(e);
+	}
+
+	public VimHandler getVimHandler() {
+		return vim;
+	}
+
+	public boolean isVimEnabled() {
+		return vim.isEnabled();
+	}
+
+	public void setVimEnabled(final boolean enabled) {
+		vim.setEnabled(enabled);
+	}
+
 	@Override
 	public void undoLastAction() {
 		undoInProgress = true;
@@ -1046,6 +1067,7 @@ public void convertSpacesToTabs() {
 	public static final String AUTOCOMPLETE_KEYLESS_PREFS = "script.editor.ACNoKey";
 	public static final String AUTOCOMPLETE_FALLBACK_PREFS = "script.editor.ACFallback";
 	public static final String MARK_OCCURRENCES_PREFS = "script.editor.Occurrences";
+	public static final String VIM_PREFS = "script.editor.Vim";
 	public static final String FOLDERS_PREFS = "script.editor.folders";
 	public static final int DEFAULT_TAB_SIZE = 4;
 	public static final String DEFAULT_THEME = "default";
@@ -1076,6 +1098,7 @@ public void loadPreferences() {
 			setFallbackAutoCompletion(prefService.getBoolean(getClass(), AUTOCOMPLETE_FALLBACK_PREFS, false));
 			setMarkOccurrences(prefService.getBoolean(getClass(), MARK_OCCURRENCES_PREFS, false));
 			setMarginLineEnabled(prefService.getBoolean(getClass(), MARGIN_VISIBLE_PREFS, false));
+			setVimEnabled(prefService.getBoolean(getClass(), VIM_PREFS, false));
 			applyTheme(themeName());
 		}
 	}
@@ -1132,6 +1155,7 @@ public void savePreferences(final String top_folders, final String theme) {
 		prefService.put(getClass(), AUTOCOMPLETE_FALLBACK_PREFS, isAutoCompletionFallbackEnabled());
 		prefService.put(getClass(), MARGIN_VISIBLE_PREFS, isMarginLineEnabled());
 		prefService.put(getClass(), MARK_OCCURRENCES_PREFS, getMarkOccurrences());
+		prefService.put(getClass(), VIM_PREFS, isVimEnabled());
 		if (null != top_folders) prefService.put(getClass(), FOLDERS_PREFS, top_folders);
 		if (null != theme) prefService.put(getClass(), THEME_PREFS, theme);
 	}

src/main/java/org/scijava/ui/swing/script/TextEditor.java

@@ -230,7 +230,7 @@ public class TextEditor extends JFrame implements ActionListener,
 	private FindAndReplaceDialog findDialog;
 	private JCheckBoxMenuItem autoSave, wrapLines, tabsEmulated, autoImport,
 			autocompletion, fallbackAutocompletion, keylessAutocompletion,
-			markOccurences, paintTabs, whiteSpace, marginLine, lockPane;
+			markOccurences, paintTabs, whiteSpace, marginLine, lockPane, vimMode;
 	private ButtonGroup themeRadioGroup;
 	private JTextArea errorScreen = new ConsoleArea(ConsoleArea.Content.ERRORS);
 
@@ -648,6 +648,9 @@ public TextEditor(final Context context) {
 		options.add(keylessAutocompletion);
 		options.add(fallbackAutocompletion);
 
+		GuiUtils.addMenubarSeparator(options, "Key Bindings:");
+		options.add(vimMode);
+
 		options.addSeparator();
 		appendPreferences(options);
 		mbar.add(options);
@@ -1130,6 +1133,10 @@ private void initializeDynamicMenuComponents() {
 		fallbackAutocompletion.setToolTipText("<HTML>If selected, Java completions will be used when scripting<br>"
 				+ "a language for which auto-completions are not available");
 		fallbackAutocompletion.addItemListener(e -> setFallbackAutoCompletion(fallbackAutocompletion.getState()));
+		vimMode = new JCheckBoxMenuItem("Vim Mode", false);
+		vimMode.setToolTipText("<HTML>Edit with vim-style modal key bindings.<br>"
+				+ "Press Esc for normal mode; :w saves, :q closes the tab");
+		vimMode.addItemListener(e -> setVimMode(vimMode.getState()));
 		themeRadioGroup = new ButtonGroup();
 
 		// Help menu. These are 'dynamic' items
@@ -1647,15 +1654,7 @@ else if (source == previousError) {
 				getEditorPane().getErrorHighlighter().gotoPreviousError();
 		}
 		else if (source == kill) chooseTaskToKill();
-		else if (source == close) if (tabbed.getTabCount() < 2) processWindowEvent(new WindowEvent(
-			this, WindowEvent.WINDOW_CLOSING));
-		else {
-			if (!handleUnsavedChanges()) return;
-			int index = tabbed.getSelectedIndex();
-			removeTab(index);
-			if (index > 0) index--;
-			switchTo(index);
-		}
+		else if (source == close) closeTab(true);
 		else if (source == copy) getTextArea().copy();
 		else if (source == find) findOrReplace(true);
 		else if (source == findNext) {
@@ -1812,6 +1811,55 @@ private void setMarginLineEnabled(final boolean enabled) {
 		getEditorPane().requestFocusInWindow();
 	}
 
+	/**
+	 * Closes the current tab, or the window if it is the last tab.
+	 *
+	 * @param confirm Whether to ask about unsaved changes before closing a tab.
+	 */
+	private void closeTab(final boolean confirm) {
+		if (tabbed.getTabCount() < 2) {
+			processWindowEvent(new WindowEvent(this, WindowEvent.WINDOW_CLOSING));
+			return;
+		}
+		if (confirm && !handleUnsavedChanges()) return;
+		int index = tabbed.getSelectedIndex();
+		removeTab(index);
+		if (index > 0) index--;
+		switchTo(index);
+	}
+
+	/**
+	 * Handles a vim ex command (typed after ':') which the editor pane does not
+	 * handle itself.
+	 *
+	 * @return false if the command is unknown.
+	 */
+	boolean handleVimCommand(final String command) {
+		switch (command) {
+			case "w":
+				save();
+				return true;
+			case "q":
+				closeTab(true);
+				return true;
+			case "q!":
+				closeTab(false);
+				return true;
+			case "wq":
+			case "x":
+				if (save()) closeTab(true);
+				return true;
+			default:
+				return false;
+		}
+	}
+
+	private void setVimMode(final boolean enabled) {
+		for (int i = 0; i < tabbed.getTabCount(); i++)
+			getEditorPane(i).setVimEnabled(enabled);
+		getEditorPane().requestFocusInWindow();
+	}
+
 	private JMenu applyThemeMenu() {
 		final LinkedHashMap<String, String> map = new LinkedHashMap<>();
 		map.put("Default", "default");
@@ -2487,6 +2535,7 @@ else if (tabSize == Integer.parseInt(item.getText())) {
 			}
 		}
 		markOccurences.setState(pane.getMarkOccurrences());
+		vimMode.setState(pane.isVimEnabled());
 		wrapLines.setState(pane.getLineWrap());
 		marginLine.setState(pane.isMarginLineEnabled());
 		tabsEmulated.setState(pane.getTabsEmulated());

src/main/java/org/scijava/ui/swing/script/TextEditorTab.java

@@ -32,6 +32,7 @@
 import java.awt.BorderLayout;
 import java.awt.Color;
 import java.awt.Dimension;
+import java.awt.Font;
 import java.awt.GridBagConstraints;
 import java.awt.GridBagLayout;
 import java.awt.datatransfer.DataFlavor;
@@ -47,6 +48,7 @@
 import java.io.File;
 import java.util.List;
 
+import javax.swing.BorderFactory;
 import javax.swing.JButton;
 import javax.swing.JCheckBox;
 import javax.swing.JComboBox;
@@ -98,6 +100,8 @@ public String toString() {
 	private final ConsoleArea combinedScreen = new ConsoleArea(ConsoleArea.Content.MIXED);
 	protected final JTextArea prompt = new JTextArea();
 	private final JLabel prompt_title = new JLabel();
+	/** Status line for vim mode: the mode, partial command or message. */
+	private final JLabel vimStatus = new JLabel(" ");
 	protected final JCheckBox updownarrows = new JCheckBox("Use arrow keys");
 	protected final JScrollPane scroll;
 	/** True iff the console is showing errors only. */
@@ -362,6 +366,16 @@ public void actionPerformed(final ActionEvent e) {
 		final JPanel holder = new JPanel(new BorderLayout());
 		holder.add(editorPane.wrappedInScrollbars());
 		holder.add(es, BorderLayout.LINE_END);
+		holder.add(vimStatus, BorderLayout.PAGE_END);
+		vimStatus.setFont(new Font(Font.MONOSPACED, Font.PLAIN, vimStatus.getFont().getSize()));
+		vimStatus.setBorder(BorderFactory.createEmptyBorder(2, 4, 2, 4));
+		vimStatus.setVisible(false);
+		editorPane.getVimHandler().setStatusListener(status -> {
+			vimStatus.setVisible(status != null);
+			// Note: a blank keeps the line from collapsing.
+			vimStatus.setText(status == null || status.isEmpty() ? " " : status);
+		});
+		editorPane.getVimHandler().setExHandler(textEditor::handleVimCommand);
 		super.setLeftComponent(holder);
 		super.setRightComponent(screenAndPromptSplit);
 		screenAndPromptSplit.setDividerLocation(1.0);