fix(mappings): Map capture mappings to an instance

Author: kristijanhusak

ftplugin/org.lua

@@ -7,16 +7,17 @@ vim.b.did_ftplugin = true
 local config = require('orgmode.config')
 local utils = require('orgmode.utils')
 
-config:setup_mappings('org')
-config:setup_mappings('text_objects')
+vim.b.org_bufnr = vim.api.nvim_get_current_buf()
+
+config:setup_mappings('org', vim.b.org_bufnr)
+config:setup_mappings('text_objects', vim.b.org_bufnr)
 config:setup_foldlevel()
 
 if config.org_startup_indented then
   vim.b.org_indent_mode = true
 end
 require('orgmode.org.indent').setup_virtual_indent()
 
-vim.b.org_bufnr = vim.api.nvim_get_current_buf()
 vim.bo.modeline = false
 vim.opt_local.fillchars:append('fold: ')
 vim.opt_local.foldmethod = 'expr'
@@ -62,5 +63,5 @@ vim.b.undo_ftplugin = table.concat({
   'foldexpr<',
   'formatexpr<',
   'omnifunc<',
-  '| unlet! b:org_bufnr'
+  '| unlet! b:org_bufnr',
 }, ' ')

lua/orgmode/agenda/init.lua

@@ -87,7 +87,7 @@ function Agenda:open_window()
   vim.cmd([[setf orgagenda]])
   vim.cmd([[setlocal buftype=nofile bufhidden=wipe nobuflisted nolist noswapfile nowrap nospell]])
   vim.w.org_window_pos = vim.fn.win_screenpos(0)
-  config:setup_mappings('agenda')
+  config:setup_mappings('agenda', vim.api.nvim_get_current_buf())
   return vim.fn.bufnr()
 end
 

lua/orgmode/capture/init.lua

@@ -33,13 +33,41 @@ function Capture:prompt()
   self:_create_prompt(self.templates:get_list())
 end
 
+---@private
+function Capture:setup_mappings()
+  local maps = config:get_mappings('capture', vim.api.nvim_get_current_buf())
+  if not maps then
+    return
+  end
+  local capture_map = maps.org_capture_finalize
+  capture_map.map_entry
+    :with_handler(function()
+      return self:refile()
+    end)
+    :attach(capture_map.default_map, capture_map.user_map, capture_map.opts)
+
+  local refile_map = maps.org_capture_refile
+  refile_map.map_entry
+    :with_handler(function()
+      return self:refile_to_destination()
+    end)
+    :attach(refile_map.default_map, refile_map.user_map, refile_map.opts)
+
+  local kill_map = maps.org_capture_kill
+  kill_map.map_entry
+    :with_handler(function()
+      return self:kill()
+    end)
+    :attach(kill_map.default_map, kill_map.user_map, kill_map.opts)
+end
+
 ---@param template OrgCaptureTemplate
 ---@return OrgPromise<OrgCaptureWindow>
 function Capture:open_template(template)
   self._window = CaptureWindow:new({
     template = template,
     on_open = function()
-      return config:setup_mappings('capture')
+      return self:setup_mappings()
     end,
     on_close = function()
       return self:on_refile_close()
@@ -484,7 +512,7 @@ function Capture:_setup_closing_note()
       return content
     end,
     on_open = function()
-      config:setup_mappings('note')
+      config:setup_mappings('note', vim.api.nvim_get_current_buf())
     end,
   })
 end

lua/orgmode/config/init.lua

@@ -205,6 +205,17 @@ function Config:setup_mappings(category, buffer)
       buffer = buffer or vim.api.nvim_get_current_buf(),
     })
   end
+  local maps = self:get_mappings(category, buffer)
+  if not maps then
+    return
+  end
+
+  for _, map in pairs(maps) do
+    map.map_entry:attach(map.default_map, map.user_map, map.opts)
+  end
+end
+
+function Config:get_mappings(category, buffer)
   if self.opts.mappings.disable_all then
     return
   end
@@ -221,9 +232,16 @@ function Config:setup_mappings(category, buffer)
     opts.prefix = self.opts.mappings.prefix
   end
 
+  local result = {}
   for name, map_entry in pairs(map_entries) do
-    map_entry:attach(default_mappings[name], user_mappings[name], opts)
+    result[name] = {
+      map_entry = map_entry,
+      default_map = default_mappings[name],
+      user_map = user_mappings[name],
+      opts = opts,
+    }
   end
+  return result
 end
 
 --- Setup the foldlevel for a given org file

lua/orgmode/config/mappings/map_entry.lua

@@ -1,4 +1,5 @@
 ---@class OrgMapEntry
+---@field provided_opts table
 ---@field handler string
 ---@field handler_cmd string
 ---@field args table[]
@@ -39,6 +40,12 @@ function MapEntry.custom(handler, opts)
   return MapEntry:new(handler, opts)
 end
 
+function MapEntry:with_handler(handler)
+  local map_entry = MapEntry:new(self.handler, self.provided_opts)
+  map_entry.handler = handler
+  return map_entry
+end
+
 ---@param handler string|function
 ---@param opts? table<string, any>
 function MapEntry:new(handler, opts)
@@ -51,6 +58,7 @@ function MapEntry:new(handler, opts)
     type = { opts.type, 'string', true },
   })
   local data = {}
+  data.provided_opts = opts
   data.handler = handler
   data.opts = vim.tbl_extend('keep', opts.opts or {}, {
     nowait = true,
@@ -85,7 +93,9 @@ function MapEntry:attach(default_mapping, user_mapping, opts)
   end
 
   if type(mapping) ~= 'table' then
-    error('Invalid mapping provided for ' .. self.handler .. '. Only string and array of strings can be provided')
+    error(
+      'Invalid mapping provided for ' .. tostring(self.handler) .. '. Only string and array of strings can be provided'
+    )
   end
 
   local map_opts = vim.tbl_extend('force', self.opts, opts or {})