feat(attach): add attachment events

Author: broken-pen

lua/orgmode/attach/core.lua

@@ -1,4 +1,5 @@
 local AttachNode = require('orgmode.attach.node')
+local EventManager = require('orgmode.events')
 local methods = require('orgmode.attach.methods')
 local Promise = require('orgmode.utils.promise')
 local config = require('orgmode.config')
@@ -394,6 +395,7 @@ function AttachCore:attach(node, file, opts)
       if not success then
         return nil
       end
+      EventManager.dispatch(EventManager.event.AttachChanged:new(node, attach_dir))
       node:toggle_auto_tag(true)
       local link = self.links:store_link_to_attachment({ attach_dir = attach_dir, original = file })
       vim.fn.setreg(vim.v.register, link)
@@ -421,6 +423,7 @@ function AttachCore:attach_url(node, url, opts)
       if not success then
         return nil
       end
+      EventManager.dispatch(EventManager.event.AttachChanged:new(node, attach_dir))
       node:toggle_auto_tag(true)
       local link = self.links:store_link_to_attachment({ attach_dir = attach_dir, original = url })
       vim.fn.setreg(vim.v.register, link)
@@ -448,6 +451,7 @@ function AttachCore:attach_buffer(node, bufnr, opts)
       if not success then
         return nil
       end
+      EventManager.dispatch(EventManager.event.AttachChanged:new(node, attach_dir))
       node:toggle_auto_tag(true)
       -- Ignore all errors here, this is just to determine whether we can store
       -- a link to `bufname`.
@@ -491,6 +495,7 @@ function AttachCore:attach_many(node, files, opts)
       end, files)
       ---@param successes boolean[]
       :next(function(successes)
+        EventManager.dispatch(EventManager.event.AttachChanged:new(node, attach_dir))
         node:toggle_auto_tag(true)
         ---@param tally orgmode.attach.core.attach_many.result
         ---@param success boolean
@@ -531,6 +536,7 @@ function AttachCore:attach_new(node, name, opts)
   return self:get_dir_or_create(node, opts.set_dir_method, opts.new_dir):next(function(attach_dir)
     local path = vim.fs.joinpath(attach_dir, name)
     --TODO: the emacs version doesn't run the hook here. Is this correct?
+    EventManager.dispatch(EventManager.event.AttachChanged:new(node, attach_dir))
     node:toggle_auto_tag(true)
     ---@type vim.api.keyset.cmd
     return Promise.new(function(resolve, reject)
@@ -576,6 +582,7 @@ end
 function AttachCore:open(name, node)
   local attach_dir = self:get_dir(node)
   local path = vim.fs.joinpath(attach_dir, name)
+  EventManager.dispatch(EventManager.event.AttachOpened:new(node, path))
   return assert(vim.ui.open(path))
 end
 
@@ -587,6 +594,7 @@ end
 function AttachCore:open_in_vim(name, node)
   local attach_dir = self:get_dir(node)
   local path = vim.fs.joinpath(attach_dir, name)
+  EventManager.dispatch(EventManager.event.AttachOpened:new(node, path))
   vim.cmd.edit(path)
 end
 
@@ -603,6 +611,7 @@ function AttachCore:delete_one(node, name)
   local attach_dir = self:get_dir(node)
   local path = vim.fs.joinpath(attach_dir, name)
   return fileops.unlink(path):next(function()
+    EventManager.dispatch(EventManager.event.AttachChanged:new(node, attach_dir))
     return nil
   end)
 end
@@ -637,6 +646,7 @@ function AttachCore:delete_all(node, recursive)
       return Promise.reject(errmsg)
     end
     return fileops.remove_directory(attach_dir, { recursive = true }):next(function()
+      EventManager.dispatch(EventManager.event.AttachChanged:new(node, attach_dir))
       node:toggle_auto_tag(false)
       return attach_dir
     end)
@@ -671,6 +681,7 @@ function AttachCore:sync(node, delete_empty_dir)
     self:untag(node)
     return Promise.resolve()
   end
+  EventManager.dispatch(EventManager.event.AttachChanged:new(node, attach_dir))
   local non_empty = has_any_non_litter_files(attach_dir)
   node:toggle_auto_tag(non_empty)
   if non_empty then

lua/orgmode/events/types/attach_changed_event.lua

@@ -0,0 +1,20 @@
+---@class OrgAttachChangedEvent: OrgEvent
+---@field type string
+---@field node OrgAttachNode
+---@field attach_dir string
+local AttachChangedEvent = {
+  type = 'orgmode.attach_changed',
+}
+
+---@param node OrgAttachNode
+---@param attach_dir string
+---@return OrgAttachChangedEvent
+function AttachChangedEvent:new(node, attach_dir)
+  local obj = setmetatable({}, self)
+  self.__index = self
+  obj.node = node
+  obj.attach_dir = attach_dir
+  return obj
+end
+
+return AttachChangedEvent

lua/orgmode/events/types/attach_opened_event.lua

@@ -0,0 +1,20 @@
+---@class OrgAttachOpenedEvent: OrgEvent
+---@field type string
+---@field node OrgAttachNode
+---@field path string
+local AttachOpenedEvent = {
+  type = 'orgmode.attach_opened',
+}
+
+---@param node OrgAttachNode
+---@param path string
+---@return OrgAttachOpenedEvent
+function AttachOpenedEvent:new(node, path)
+  local obj = setmetatable({}, self)
+  self.__index = self
+  obj.node = node
+  obj.path = path
+  return obj
+end
+
+return AttachOpenedEvent

lua/orgmode/events/types/init.lua

@@ -6,4 +6,6 @@ return {
   HeadlinePromoted = require('orgmode.events.types.headline_promoted_event'),
   HeadlineDemoted = require('orgmode.events.types.headline_demoted_event'),
   HeadingToggled = require('orgmode.events.types.heading_toggled'),
+  AttachChanged = require('orgmode.events.types.attach_changed_event'),
+  AttachOpened = require('orgmode.events.types.attach_opened_event'),
 }