update

Author: pynappo

lua/neo-tree/clipboard/init.lua

@@ -1,6 +1,7 @@
 local events = require("neo-tree.events")
 local manager = require("neo-tree.sources.manager")
 local log = require("neo-tree.log")
+local renderer = require("neo-tree.ui.renderer")
 
 local M = {}
 
@@ -38,17 +39,15 @@ M.setup = function(opts)
     log.error("invalid clipboard sync method, disabling sync")
     selected_backend = builtins.none
   end
-  M.current_backend = assert(selected_backend:new())
+  M.current_backend = log.assert(selected_backend:new())
 
   events.subscribe({
     event = events.STATE_CREATED,
     ---@param new_state neotree.State
     handler = function(new_state)
       local clipboard, err = M.current_backend:load(new_state)
       if not clipboard then
-        if err then
-          log.error(err)
-        end
+        log.assert(not err, err)
         return
       end
       new_state.clipboard = clipboard
@@ -73,7 +72,7 @@ function M.sync_to_clipboards(exclude_state)
   -- try loading the changed clipboard into all other states
   vim.schedule(function()
     manager._for_each_state(nil, function(state)
-      if exclude_state == state then
+      if state == exclude_state then
         return
       end
       local modified_clipboard, err = M.current_backend:load(state)
@@ -84,6 +83,7 @@ function M.sync_to_clipboards(exclude_state)
         return
       end
       state.clipboard = modified_clipboard
+      renderer.redraw(state)
     end)
   end)
 end

lua/neo-tree/clipboard/sync/base.lua

@@ -7,6 +7,7 @@ local Backend = {}
 
 ---@alias neotree.clipboard.Contents table<string, neotree.clipboard.Node?>
 
+---A backend has the responsibility of storing a single instance of a clipboard for other clipboards to save.
 ---@return neotree.clipboard.Backend?
 function Backend:new()
   local o = {}
@@ -15,15 +16,15 @@ function Backend:new()
   return o
 end
 
----Loads the clipboard from the backend
----Return a nil clipboard to not make any changes.
+---Given a particular state, determines whether the backend should load its saved clipboard into the state.
+---Return nil if no clipboard change should be made
 ---@param state neotree.State
----@return neotree.clipboard.Contents|false? clipboard
+---@return neotree.clipboard.Contents? clipboard_or_nil
 ---@return string? err
 function Backend:load(state) end
 
----Writes the clipboard to the backend
----Returns nil when nothing was saved
+---Saves a state's clipboard to the backend.
+---Returns nil when the save is not applicable.
 ---@param state neotree.State
 ---@return boolean? success_or_noop
 function Backend:save(state)

lua/neo-tree/clipboard/sync/universal.lua

@@ -1,7 +1,7 @@
 ---A backend for the clipboard that uses a file in stdpath('state')/neo-tree.nvim/clipboards/ .. self.filename
 ---to sync the clipboard between everything.
 local BaseBackend = require("neo-tree.clipboard.sync.base")
-local log = require("neo-tree.log")
+local log = require("neo-tree.log").new("clipboard.sync.universal")
 local uv = vim.uv or vim.loop
 
 ---@class neotree.clipboard.FileBackend.Opts
@@ -14,7 +14,6 @@ local pid = uv.os_getpid()
 
 ---@class (exact) neotree.clipboard.FileBackend.FileFormat
 ---@field pid integer
----@field time integer
 ---@field state_name string
 ---@field contents neotree.clipboard.Contents
 
@@ -26,7 +25,7 @@ local pid = uv.os_getpid()
 ---@field cached_contents neotree.clipboard.Contents
 ---@field last_time_saved integer
 ---@field saving boolean
-local FileBackend = BaseBackend:new()
+local UniversalBackend = BaseBackend:new()
 
 ---@param filename string
 ---@return boolean created
@@ -57,7 +56,7 @@ end
 
 ---@param opts neotree.clipboard.FileBackend.Opts?
 ---@return neotree.clipboard.FileBackend?
-function FileBackend:new(opts)
+function UniversalBackend:new(opts)
   local backend = {} -- create object if user does not provide one
   setmetatable(backend, self)
   self.__index = self
@@ -85,28 +84,26 @@ function FileBackend:new(opts)
 end
 
 ---@return boolean started true if working
-function FileBackend:_start()
+function UniversalBackend:_start()
   if self.handle then
     return true
   end
   local event_handle = uv.new_fs_event()
   if event_handle then
     self.handle = event_handle
-    local start_success = event_handle:start(self.filename, {}, function(err, _, fs_events)
-      local write_time = uv.fs_stat(self.filename).mtime.nsec
-      if self.last_time_saved == write_time then
-      end
+    local start_success = event_handle:start(self.filename, {}, function(err)
       if err then
+        log.error("universal clipboard file handle error:", err)
         event_handle:close()
         return
       end
       require("neo-tree.clipboard").sync_to_clipboards()
       -- we should check whether we just wrote or not
     end)
-    log.info("Watching " .. self.filename)
+    log.info("Watching", self.filename)
     return start_success == 0
   else
-    log.warn("could not watch shared clipboard on file events")
+    log.warn("Could not watch shared clipboard on file events")
     --todo: implement polling?
   end
   return false
@@ -120,12 +117,11 @@ local validate_clipboard_from_file = function(wrapped_clipboard)
   return validate("clipboard_from_file", wrapped_clipboard, function(c)
     validate("contents", c.contents, "table")
     validate("pid", c.pid, "number")
-    validate("time", c.time, "number")
     validate("state_name", c.state_name, "string")
   end, false, "Clipboard from file could not be validated")
 end
 
-function FileBackend:load(state)
+function UniversalBackend:load(state)
   if state.name ~= "filesystem" then
     return nil, nil
   end
@@ -163,49 +159,50 @@ function FileBackend:load(state)
 
       -- try creating a new file without content
       state.clipboard = {}
-      self:save(state)
+      local ok, save_err = self:save(state)
+      if ok == false then
+        log.error(save_err)
+      end
       -- clear the current clipboard
       return {}
     end
-    return nil, "could not parse a valid clipboard from clipboard file"
+    return nil, "Could not parse a valid clipboard from clipboard file"
   end
 
   return clipboard_file.contents
 end
 
-function FileBackend:save(state)
+function UniversalBackend:save(state)
   if state.name ~= "filesystem" then
     return nil
   end
 
-  local c = state.clipboard
   ---@type neotree.clipboard.FileBackend.FileFormat
   local wrapped = {
     pid = pid,
-    time = os.time(),
     state_name = assert(state.name),
-    contents = c,
+    contents = state.clipboard,
   }
   if not file_touch(self.filename) then
-    return false, "couldn't write to  " .. self.filename .. self.filename
+    return false, "Couldn't write to  " .. self.filename .. self.filename
   end
   local encode_ok, str = pcall(vim.json.encode, wrapped)
   if not encode_ok then
     local encode_err = str
-    return false, "couldn't encode clipboard into json: " .. encode_err
+    return false, "Couldn't encode clipboard into json: " .. encode_err
   end
   local file, err = io.open(self.filename, "w")
   if not file or err then
-    return false, "couldn't open " .. self.filename
+    return false, "Couldn't open " .. self.filename
   end
   local _, write_err = file:write(str)
   if write_err then
-    return false, "couldn't write to " .. self.filename
+    return false, "Couldn't write to " .. self.filename
   end
   file:flush()
-  file:close()
   self.last_time_saved = uv.fs_stat(self.filename).mtime.nsec
+  self.last_clipboard_saved = state.clipboard
   return true
 end
 
-return FileBackend
+return UniversalBackend

lua/neo-tree/log.lua

@@ -95,6 +95,7 @@ log_maker.new = function(config)
   local log = {}
   ---@diagnostic disable-next-line: cast-local-type
   config = vim.tbl_deep_extend("force", default_config, config)
+  local prefix = table.concat(config.context, ".")
 
   local title_opts = { title = config.plugin_short }
   ---@param message string
@@ -116,17 +117,9 @@ log_maker.new = function(config)
 
   local initial_filepath = string.format("%s/%s.log", vim.fn.stdpath("data"), config.plugin)
 
-  ---@type file*?
-  log.file = nil
-  if config.use_file then
-    log.use_file(initial_filepath)
-  end
-
   local last_logfile_check_time = 0
-  local current_logfile_inode = -1
   local logfile_check_interval = 20 -- TODO: probably use filesystem events rather than this
   local inspect_opts = { depth = 2, newline = " " }
-  local prefix = table.concat(config.context, ".")
   ---@param log_type string
   ---@param msg string
   local log_to_file = function(log_type, msg)
@@ -188,7 +181,6 @@ log_maker.new = function(config)
   local logfunc = function(log_level, message_maker)
     local can_log_to_file = log_level >= log.minimum_level.file
     local can_log_to_console = log_level >= log.minimum_level.console
-    local log_verbose = vim.env.NEOTREE_TESTING == "true"
     if not can_log_to_file and not can_log_to_console then
       return function() end
     end
@@ -211,12 +203,7 @@ log_maker.new = function(config)
 
       -- Output to console
       if config.use_console and can_log_to_console then
-        local info = debug.getinfo(2, "Sl")
         vim.schedule(function()
-          if log_verbose then
-            local lineinfo = info.short_src .. ":" .. info.currentline
-            msg = lineinfo .. msg
-          end
           notify(msg, log_level)
         end)
       end
@@ -309,6 +296,7 @@ log_maker.new = function(config)
 
   log.set_level(config.level)
 
+  local current_logfile_inode = -1
   ---@param file string|boolean
   ---@param quiet boolean?
   ---@return boolean using_file
@@ -357,6 +345,12 @@ log_maker.new = function(config)
     return config.use_file
   end
 
+  ---@type file*?
+  log.file = nil
+  if config.use_file then
+    log.use_file(initial_filepath, true)
+  end
+
   ---Quick wrapper around assert that also supports subsequent args being the same as string.format (to reduce work done on happy paths)
   ---@see string.format
   ---@generic T
@@ -385,13 +379,9 @@ log_maker.new = function(config)
   ---@param context string
   log.new = function(context)
     local new_context = vim.deepcopy(config.context)
-    return log_maker.new(
-      vim.tbl_deep_extend(
-        "force",
-        config,
-        { context = vim.list_extend({ new_context }, { context }) }
-      )
-    )
+    local new_config =
+      vim.tbl_deep_extend("force", config, { context = vim.list_extend(new_context, { context }) })
+    return log_maker.new(new_config)
   end
 
   return log