feat: vi-mode indicator

Author: youssefadly237

api/registry.lua

@@ -366,4 +366,12 @@ return {
   getToolInfo = {
     { impl = wrapper.getToolInfo, deps = { 'getToolInfo' } },
   },
+
+  -- PLACEHOLDER
+  registerPlaceholder = {
+    { impl = wrapper.registerPlaceholder, deps = { 'registerPlaceholder' } },
+  },
+  setPlaceholderValue = {
+    { impl = wrapper.setPlaceholderValue, deps = { 'setPlaceholderValue' } },
+  },
 }

api/wrapper.lua

@@ -325,4 +325,13 @@ wrapper.getToolInfo = function(tool)
   return app.getToolInfo(tool)
 end
 
+-- PLACEHOLDER
+wrapper.registerPlaceholder = function(name, description)
+  app.registerPlaceholder(name, description)
+end
+
+wrapper.setPlaceholderValue = function(placeholder, val)
+  app.setPlaceholderValue(placeholder, val)
+end
+
 return wrapper

keybindings.lua

@@ -14,6 +14,18 @@ local ALL_MODES = {
   'resize',
 }
 
+local function changeMode(mode, stickyValue)
+  state.currentMode = mode
+  if stickyValue ~= nil then
+    state.sticky = stickyValue
+  end
+  local display = state.currentMode
+  if state.sticky then
+    display = display .. ' (sticky)'
+  end
+  api.setPlaceholderValue('vi-mode', display)
+end
+
 --------------------
 -- KEYBINDINGS:   --
 --------------------
@@ -88,135 +100,127 @@ local keybindings = {
     buttons = { 't' },
     modes = ALL_MODES,
     call = function()
-      state.currentMode = 'tool'
-      state.sticky = false
+      changeMode('tool', false)
     end,
   },
   color = {
     description = 'Color mode',
     buttons = { 'c' },
     modes = { 'tool' },
     call = function()
-      state.currentMode = 'color'
+      changeMode('color')
     end,
   },
   stickyColor = {
     description = 'Sticky color mode',
     buttons = { '<Shift>c' },
     modes = { 'tool' },
     call = function()
-      state.currentMode = 'color'
-      state.sticky = true
+      changeMode('color', true)
     end,
   },
   shape = {
     description = 'Shape mode',
     buttons = { 'a' },
     modes = { 'tool' },
     call = function()
-      state.currentMode = 'shape'
+      changeMode('shape')
     end,
   },
   stickyShape = {
     description = 'Sticky shape mode',
     buttons = { '<Shift>a' },
     modes = { 'tool' },
     call = function()
-      state.currentMode = 'shape'
-      state.sticky = true
+      changeMode('shape', true)
     end,
   },
   linestyle = {
     description = 'Linestyle mode',
     buttons = { 'q' },
     modes = { 'tool' },
     call = function()
-      state.currentMode = 'linestyle'
+      changeMode('linestyle')
     end,
   },
   stickyLinestyle = {
     description = 'Sticky linestyle mode',
     buttons = { '<Shift>q' },
     modes = { 'tool' },
     call = function()
-      state.currentMode = 'linestyle'
-      state.sticky = true
+      changeMode('linestyle', true)
     end,
   },
   page = {
     description = 'Page mode',
     buttons = { 'b', 'p' },
     modes = { 'tool' },
     call = function()
-      state.currentMode = 'page'
+      changeMode('page')
     end,
   },
   stickyPage = {
     description = 'Sticky page mode',
     buttons = { '<Shift>b', '<Shift>p' },
     modes = { 'tool' },
     call = function()
-      state.currentMode = 'page'
-      state.sticky = true
+      changeMode('page', true)
     end,
   },
   navigation = {
     description = 'Navigation mode',
     buttons = { 'g' },
     modes = { 'tool' },
     call = function()
-      state.currentMode = 'navigation'
+      changeMode('navigation')
     end,
   },
   stickyNavigation = {
     description = 'Sticky navigation mode',
     buttons = { '<Shift>g' },
     modes = { 'tool' },
     call = function()
-      state.currentMode = 'navigation'
-      state.sticky = true
+      changeMode('navigation', true)
     end,
   },
   file = {
     description = 'File mode',
     buttons = { 'y' },
     modes = { 'tool' },
     call = function()
-      state.currentMode = 'file'
+      changeMode('file')
     end,
   },
   stickyFile = {
     description = 'Sticky file mode',
     buttons = { '<Shift>y' },
     modes = { 'tool' },
     call = function()
-      state.currentMode = 'file'
-      state.sticky = true
+      changeMode('file', true)
     end,
   },
   visual = {
     description = 'Visual mode',
     buttons = { 'v' },
     modes = { 'tool' },
     call = function()
-      state.currentMode = 'visual'
+      changeMode('visual')
     end,
   },
   stickyVisual = {
     description = 'Sticky visual mode',
     buttons = { '<Shift>v' },
     modes = { 'tool' },
     call = function()
-      state.currentMode = 'visual'
-      state.sticky = true
+      changeMode('visual', true)
     end,
   },
   resize = {
     description = 'Resize mode',
     buttons = { '<Shift>F' },
     modes = { 'tool' },
     call = function()
-      state.currentMode = 'resize'
+      changeMode('resize')
     end,
   },
 
@@ -662,4 +666,5 @@ end
 return {
   bindings = keybindings,
   ALL_MODES = ALL_MODES,
+  changeMode = changeMode,
 }

main.lua

@@ -4,6 +4,7 @@ package.path = script_path .. '?.lua;' .. script_path .. '?/init.lua;' .. packag
 
 local utils = require('utils')
 local log = utils.log
+local api = require('api')
 
 local kb_module = require('keybindings')
 local keybindings = kb_module.bindings
@@ -62,6 +63,8 @@ end
 -- xournalpp require `initUi` as name
 ---@diagnostic disable-next-line: lowercase-global
 function initUi()
+  api.registerPlaceholder('vi-mode', 'Vi Mode Indicator')
+
   local index = 1
   local skipped = {}
 

modes.lua

@@ -4,12 +4,13 @@ local state = require('state')
 
 local kb_module = require('keybindings')
 local keybindings = kb_module.bindings
+local changeMode = kb_module.changeMode
 
 local function handle(key)
   for _, binding in pairs(keybindings) do
     if binding.button_set[key] and binding.mode_set[state.currentMode] then
       if state.currentMode ~= 'tool' and not state.sticky then
-        state.currentMode = 'tool'
+        changeMode('tool')
       end
 
       if binding.call then