add matrix enter shortcut to vim

give the option to redefine the `insert new line below` to also append a
\\ at end of the current line in a matrix environment. The enter is
handled by simulating a enter press call. The cursor is moved to the
current line and collum = line.length + 1. This may have unwanted
consequences, other option would be to handle the key with vim but that
relies on the vim keymap.

Author: superle3

DOCS.md

@@ -301,3 +301,6 @@ The shortcut should be a vim keybinding with no spaces. Some keybindings are not
 Keep in mind that the shortcut from visual -> select mode only works in visual mode, and the shortcut from select -> visual mode only works when something is selected and you are in insert mode.
 
 Macros are not yet supported for visual snippets.
+
+### Vim matrix shortcut \\\\
+Same key mapping rules apply. You can define or redefine `open a new line below` action, which also inserts \\\\ at the end of the current line if it's in a matrix environment.

src/features/editor_commands.ts

@@ -5,6 +5,9 @@ import LatexSuitePlugin from "src/main";
 import { Context } from "src/utils/context";
 import { CodeMirrorEditor, Vim } from "src/utils/vim_types";
 import { LatexSuitePluginSettings } from "src/settings/settings";
+import { runMatrixShortcuts } from "./matrix_shortcuts";
+import { insertNewlineAndIndent } from "@codemirror/commands";
+import { Transaction, Annotation, TransactionSpec } from "@codemirror/state";
 
 
 function boxCurrentEquation(view: EditorView) {
@@ -130,19 +133,20 @@ export const getEditorCommands = (plugin: LatexSuitePlugin) => {
 
 export interface vimCommand {
 	id: string;
-	defineType: "defineMotion"| "defineOperator" | "defineAction";
+	defineType: "defineMotion" | "defineOperator" | "defineAction";
 	type: "action" | "operator" | "motion";
 	action: (cm: CodeMirrorEditor) => void;
 	key: string;
 	context?: "normal" | "visual" | "replace" | "insert";
 }
+
 export function getVimSelectModeCommand(settings: LatexSuitePluginSettings): vimCommand {
 	return {
 		id: "latex-suite-vim-select-mode",
 		defineType: "defineAction",
 		type: "action",
 		// copies current selection and selects it again since changing vim modes deletes the selection
-		action: (cm: CodeMirrorEditor) =>  {
+		action: (cm: CodeMirrorEditor) => {
 			//@ts-ignore undocumented object
 			const vimObject: Vim | null = window?.CodeMirrorAdapter?.Vim;
 			if (!vimObject) return;
@@ -154,6 +158,7 @@ export function getVimSelectModeCommand(settings: LatexSuitePluginSettings): vim
 		context: "visual",
 	}
 }
+
 export function getVimVisualModeCommand(settings: LatexSuitePluginSettings): vimCommand {
 	return {
 		id: "latex-suite-vim-visual-mode",
@@ -173,9 +178,62 @@ export function getVimVisualModeCommand(settings: LatexSuitePluginSettings): vim
 		context: "insert",
 	}
 }
+
+export function getVimRunMatrixEnterCommand(settings: LatexSuitePluginSettings): vimCommand {
+	return {
+		id: "latex-suite-vim-special-enter",
+		defineType: "defineAction",
+		type: "action",
+		action: (cm: CodeMirrorEditor) => {
+			//@ts-ignore
+			const vimObj: Vim | null = window?.CodeMirrorAdapter?.Vim;
+			if (!vimObj) return;
+			const cursorLine: number = cm.getCursor().line;
+			const line: string = cm.getLine(cursorLine);
+			cm.setCursor({line: cursorLine, ch: line.length + 1})
+			const view = EditorView.findFromDOM(cm.getWrapperElement());
+			const ctx = Context.fromView(view);
+			if (runMatrixShortcuts(view, ctx, "Enter", false)) {
+				vimObj.enterInsertMode(cm);
+				return;
+			}
+			// code taken from vim plugin, documentation is not clear on what this does
+			const succes: boolean = insertNewlineAndIndent({
+				state: cm.cm6.state,
+				dispatch: (transaction: Transaction & TransactionSpec) => {
+					const view: EditorView = cm.cm6;
+					// should not fire by the design of insertNewlineAndIndent but its in the vim plugin so it is included
+					if (view.state.readOnly) return;
+					let type: string = "input.type.compose";
+					if (cm.curOp && !cm.curOp.lastChange) type = "input.type.compose.start";
+					if (Array.isArray(transaction.annotations)) {
+					try {
+						transaction.annotations.forEach((note: Annotation<string|number|boolean>) => {
+							//@ts-ignore its "supposed" to be readonly but it is not
+							if (note.value === "input") note.value = type;
+						});
+					} catch (e) {
+						console.error(e);
+					}
+					} else {
+						transaction.userEvent =  type;
+					}
+					view.dispatch(transaction);
+				}
+			});
+			if (!succes) console.error(`Failed to insert newline and indent latex-suite-insert-newline-and-indent`);
+			// go into insert mode after the newline is inserted, otherwise macros rerun for some reason
+			vimObj.enterInsertMode(cm);
+		},
+		key: settings.vimMatrixEnter,
+		context: "normal",
+	}
+}
+
 export function getVimEditorCommands(settings: LatexSuitePluginSettings): vimCommand[] {
 	return [
 		getVimSelectModeCommand(settings),
 		getVimVisualModeCommand(settings),
+		getVimRunMatrixEnterCommand(settings),
 	]
 }

src/settings/settings.ts

@@ -29,6 +29,7 @@ interface LatexSuiteBasicSettings {
 	vimEnabled: boolean;
 	vimSelectMode: string;
 	vimVisualMode: string;
+	vimMatrixEnter: string;
 
 }
 
@@ -92,6 +93,7 @@ export const DEFAULT_SETTINGS: LatexSuitePluginSettings = {
 	vimEnabled: false,
 	vimSelectMode: "<C-g>",
 	vimVisualMode: "<C-g>",
+	vimMatrixEnter: "o",
 }
 
 export function processLatexSuiteSettings(snippets: Snippet[], settings: LatexSuitePluginSettings):LatexSuiteCMSettings {

src/settings/settings_tab.ts

@@ -7,7 +7,7 @@ import LatexSuitePlugin from "../main";
 import { DEFAULT_SETTINGS } from "./settings";
 import { FileSuggest } from "./ui/file_suggest";
 import { basicSetup } from "./ui/snippets_editor/extensions";
-import { getVimSelectModeCommand, vimCommand, getVimVisualModeCommand, getVimEditorCommands } from "src/features/editor_commands";
+import { getVimSelectModeCommand, vimCommand, getVimVisualModeCommand, getVimEditorCommands, getVimRunMatrixEnterCommand } from "src/features/editor_commands";
 import { Vim } from "src/utils/vim_types";
 
 
@@ -503,7 +503,7 @@ export class LatexSuiteSettingTab extends PluginSettingTab {
 		const selectMode: Setting = new Setting(containerEl)
 			.setName("Vim: Switch from visual mode to select mode")
 			.setDesc(`maps the key to switch from visual mode to select mode.
-				 Keymap must be a vim keymap and can't contain any spaces.
+				 Keymap must be a vim keymap and can't contain any spaces. Use empty string to disable this feature.
 				  (select mode=insert keybindings)`)
 			.addText((text) =>
 				text.setPlaceholder(DEFAULT_SETTINGS.vimSelectMode)
@@ -527,7 +527,7 @@ export class LatexSuiteSettingTab extends PluginSettingTab {
 			.setName("Vim: Switch from select mode to visual mode")
 			.setDesc(`maps the key to switch from select mode to visual mode. 
 				 must be a vim keymap and can't contain any spaces. Example <C-g><C-A-i> = Ctrl-g + Ctrl-Alt-i.
-				 Please check the vim keybinding first on another command like w before reporting it. Some keybindings like shift don't work due to the original vim plugin.
+				 Please check the vim keybinding first on another command like w before reporting it. Some keybindings like shift don't work due to the original vim plugin. Use empty string to disable this feature.
 				  (select mode=insert keybindings)`)
 			.addText((text) =>{
 				text.setPlaceholder(DEFAULT_SETTINGS.vimVisualMode)
@@ -547,6 +547,28 @@ export class LatexSuiteSettingTab extends PluginSettingTab {
 				})
 			});
 		vimSettings.push(visualMode);
+		const matrixEnter: Setting = new Setting(containerEl)
+			.setName("Vim: run matrix enter")
+			.setDesc(`maps the key to the action of inserting a new line below while appending \\\\ to the current line in a matrix environment.
+				 Use empty string to disable this feature.`)
+			.addText((text) => {
+				text.setPlaceholder(DEFAULT_SETTINGS.vimMatrixEnter)
+				.setValue(this.plugin.settings.vimMatrixEnter)
+				.onChange(async (value) => {
+					const oldValue: string = this.plugin.settings.vimMatrixEnter;
+					this.plugin.settings.vimMatrixEnter = value;
+					await this.plugin.saveSettings();
+					//@ts-ignore
+					const vimObj: Vim | null = window?.CodeMirrorAdapter?.Vim;
+					if (!vimObj) return;
+					vimObj.unmap(oldValue, "normal");
+					const command: vimCommand = getVimRunMatrixEnterCommand(this.plugin.settings);
+					vimObj[command.defineType](command.id, command.action);
+					vimObj.mapCommand(command.key, command.type, command.id, {}, { context: command.context });
+					vimObj.unmap(oldValue, command.context)
+				})
+			});
+		vimSettings.push(matrixEnter);
 		// shows/hides the vim settings, since these settings are not needed if vim is not enabled.
 		vimEnabled.addToggle((toggle) => {
 			//@ts-ignore