Add Vim mode setting to Preferences and fix editor reinit

Author: vkbo

novelwriter/dialogs/preferences.py

@@ -566,6 +566,13 @@ def buildForm(self) -> None:
             self.tr("Highlight current line"), self.lineHighlight
         )
 
+        # Enable Vim Mode
+        self.vimMode = NSwitch(self)
+        self.vimMode.setChecked(CONFIG.vimMode)
+        self.mainForm.addRow(
+            self.tr("Enable Vim mode"), self.vimMode,
+        )
+
         # Show Tabs and Spaces
         self.showTabsNSpaces = NSwitch(self)
         self.showTabsNSpaces.setChecked(CONFIG.showTabsNSpaces)
@@ -1075,6 +1082,7 @@ def _doSave(self) -> None:
         CONFIG.lineHighlight   = lineHighlight
         CONFIG.showTabsNSpaces = self.showTabsNSpaces.isChecked()
         CONFIG.showLineEndings = self.showLineEndings.isChecked()
+        CONFIG.vimMode         = self.vimMode.isChecked()
 
         # Editor Scrolling
         CONFIG.autoScroll    = self.autoScroll.isChecked()

novelwriter/enum.py

@@ -255,7 +255,7 @@ class nwVimMode(Enum):
     NORMAL = 0
     INSERT = 1
     VISUAL = 2
-    VLINE  = 3
+    V_LINE = 3
 
 
 class nwStandardButton(Enum):

novelwriter/gui/doceditor.py

@@ -236,7 +236,6 @@ def __init__(self, parent: QWidget) -> None:
 
         # Vim State for vimMode
         self._vim = VimState()
-        self.setVimMode(nwVimMode.NORMAL)
 
         # Finalise
         self.updateSyntaxColors()
@@ -395,6 +394,9 @@ def initEditor(self) -> None:
         else:
             self.clearEditor()
 
+        # Refresh Vim Mode
+        self.setVimMode(nwVimMode.NORMAL)
+
     def loadText(self, tHandle: str, tLine: int | None = None) -> bool:
         """Load text from a document into the editor. If we have an I/O
         error, we must handle this and clear the editor so that we don't
@@ -622,6 +624,8 @@ def setVimMode(self, mode: nwVimMode) -> None:
                 self.setTextCursor(cursor)
             self._vim.setMode(mode)
             self.docFooter.updateVimModeStatusBar(mode)
+        else:
+            self.docFooter.updateVimModeStatusBar(None)
 
     def setDocumentChanged(self, state: bool) -> None:
         """Keep track of the document changed variable, and emit the
@@ -956,7 +960,7 @@ def keyPressEvent(self, event: QKeyEvent) -> None:
             if self._handleVimNormalModeModeSwitching(event):
                 return
 
-            if self._vim.mode in (nwVimMode.VISUAL, nwVimMode.VLINE):
+            if self._vim.mode in (nwVimMode.VISUAL, nwVimMode.V_LINE):
                 self._handleVimVisualMode(event)
             else:
                 self._handleVimNormalMode(event)
@@ -1940,7 +1944,7 @@ def _handleVimNormalModeModeSwitching(self, event: QKeyEvent) -> bool:
             self.setTextCursor(cursor)
             return True
         elif text == "V":
-            self.setVimMode(nwVimMode.VLINE)
+            self.setVimMode(nwVimMode.V_LINE)
             cursor = self.textCursor()
             cursor.select(QtSelectLine)
             self.setTextCursor(cursor)
@@ -3554,7 +3558,7 @@ def updateTheme(self) -> None:
             nwVimMode.NORMAL: (self.tr("NORMAL"), SHARED.theme.getBaseColor("green")),
             nwVimMode.INSERT: (self.tr("INSERT"), SHARED.theme.getBaseColor("blue")),
             nwVimMode.VISUAL: (self.tr("VISUAL"), SHARED.theme.getBaseColor("orange")),
-            nwVimMode.VLINE:  (self.tr("V-LINE"), SHARED.theme.getBaseColor("orange")),
+            nwVimMode.V_LINE: (self.tr("V-LINE"), SHARED.theme.getBaseColor("orange")),
         }
 
     def matchColors(self) -> None:
@@ -3621,16 +3625,21 @@ def updateMainCount(self, count: int, selection: bool) -> None:
             text = self._trMainCount.format("0", "+0")
         self.wordsText.setText(text)
 
-    def updateVimModeStatusBar(self, vimMode: nwVimMode) -> None:
+    def updateVimModeStatusBar(self, mode: nwVimMode | None) -> None:
         """Update the vim Mode status information."""
-        if vimMode != self._vimMode:
-            text, color = self._vimModes.get(vimMode, ("", QtBlack))
+        if mode is None:
+            self.vimStatus.setText("")
+            self.vimStatus.setVisible(False)
+            self._vimMode = None
+        elif mode != self._vimMode:
+            text, color = self._vimModes.get(mode, ("", QtBlack))
             palette = self.vimStatus.palette()
             palette.setColor(QPalette.ColorRole.WindowText, self._vimColor)
             palette.setColor(QPalette.ColorRole.Window, color)
-            self.vimStatus.setText(f" {text} ")
+            self.vimStatus.setText(f"  {text}  ")
             self.vimStatus.setPalette(palette)
-            self._vimMode = vimMode
+            self.vimStatus.setVisible(True)
+            self._vimMode = mode
 
 
 class VimState:
@@ -3657,16 +3666,17 @@ def mode(self) -> nwVimMode:
     @property
     def command(self) -> str:
         """Return the current vim command."""
-        if self._mode in (nwVimMode.VISUAL, nwVimMode.VLINE):
+        if self._mode in (nwVimMode.VISUAL, nwVimMode.V_LINE):
             return self._visualCommand
         else:
             return self._normalCommand
 
-    def setMode(self, newMode: nwVimMode) -> None:
+    def setMode(self, mode: nwVimMode) -> None:
         """Switch vim mode."""
-        logger.debug("Vim Mode changed to %s", newMode.name)
-        self._mode = newMode
-        self.resetCommand()
+        if mode != self._mode:
+            logger.debug("Vim Mode changed to %s", mode.name)
+            self._mode = mode
+            self.resetCommand()
 
     def resetCommand(self) -> None:
         """Reset internal vim command."""
@@ -3677,14 +3687,14 @@ def pushCommandKey(self, key: str) -> None:
         """Push key to the current command building stack."""
         if self._mode is nwVimMode.NORMAL:
             self._normalCommand += key
-        elif self._mode in (nwVimMode.VISUAL, nwVimMode.VLINE):
+        elif self._mode in (nwVimMode.VISUAL, nwVimMode.V_LINE):
             self._visualCommand += key
 
     def setCommand(self, key: str) -> None:
         """Set the state of the current vim command."""
         if self._mode is nwVimMode.NORMAL:
             self._normalCommand = key
-        elif self._mode in (nwVimMode.VISUAL, nwVimMode.VLINE):
+        elif self._mode in (nwVimMode.VISUAL, nwVimMode.V_LINE):
             self._visualCommand = key
 
     def yankToInternal(self, text: str) -> None: