refactor(#2875): multi instance renderer

Author: alex-courtis

Diff for: lua/nvim-tree.lua

@@ -1,7 +1,6 @@
 local lib = require "nvim-tree.lib"
 local log = require "nvim-tree.log"
 local appearance = require "nvim-tree.appearance"
-local renderer = require "nvim-tree.renderer"
 local view = require "nvim-tree.view"
 local commands = require "nvim-tree.commands"
 local utils = require "nvim-tree.utils"
@@ -97,7 +96,11 @@ function M.tab_enter()
       end
     end
     view.open { focus_tree = false }
-    renderer.draw()
+
+    local explorer = core.get_explorer()
+    if explorer then
+      explorer.renderer:draw()
+    end
   end
 end
 
@@ -179,7 +182,11 @@ local function setup_autocommands(opts)
     callback = function()
       appearance.setup()
       view.reset_winhl()
-      renderer.draw()
+
+      local explorer = core.get_explorer()
+      if explorer then
+        explorer.renderer:draw()
+      end
     end,
   })
 
@@ -214,7 +221,7 @@ local function setup_autocommands(opts)
         return
       end
       if
-        (explorer.filters.config.filter_no_buffer or renderer.config.highlight_opened_files ~= "none") and vim.bo[data.buf].buftype == ""
+        (explorer.filters.config.filter_no_buffer or explorer.opts.highlight_opened_files ~= "none") and vim.bo[data.buf].buftype == ""
       then
         utils.debounce("Buf:filter_buffer", opts.view.debounce_delay, function()
           actions.reloaders.reload_explorer()
@@ -231,7 +238,7 @@ local function setup_autocommands(opts)
         return
       end
       if
-        (explorer.filters.config.filter_no_buffer or renderer.config.highlight_opened_files ~= "none") and vim.bo[data.buf].buftype == ""
+        (explorer.filters.config.filter_no_buffer or explorer.opts.highlight_opened_files ~= "none") and vim.bo[data.buf].buftype == ""
       then
         utils.debounce("Buf:filter_buffer", opts.view.debounce_delay, function()
           actions.reloaders.reload_explorer()

Diff for: lua/nvim-tree/actions/finders/find-file.lua

@@ -1,7 +1,6 @@
 local log = require "nvim-tree.log"
 local view = require "nvim-tree.view"
 local utils = require "nvim-tree.utils"
-local renderer = require "nvim-tree.renderer"
 local core = require "nvim-tree.core"
 local Iterator = require "nvim-tree.iterators.node-iterator"
 
@@ -76,7 +75,7 @@ function M.fn(path)
     :iterate()
 
   if found and view.is_visible() then
-    renderer.draw()
+    explorer.renderer:draw()
     view.set_cursor { line, 0 }
   end
 

Diff for: lua/nvim-tree/actions/fs/clipboard.lua

@@ -4,7 +4,6 @@ local utils = require "nvim-tree.utils"
 local core = require "nvim-tree.core"
 local events = require "nvim-tree.events"
 local notify = require "nvim-tree.notify"
-local renderer = require "nvim-tree.renderer"
 local reloaders = require "nvim-tree.actions.reloaders"
 
 local find_file = require("nvim-tree.actions.finders.find-file").fn
@@ -194,23 +193,23 @@ function Clipboard:clear_clipboard()
   self.data[ACTION.copy] = {}
   self.data[ACTION.cut] = {}
   notify.info "Clipboard has been emptied."
-  renderer.draw()
+  self.explorer.renderer:draw()
 end
 
 ---Copy one node
 ---@param node Node
 function Clipboard:copy(node)
   utils.array_remove(self.data[ACTION.cut], node)
   toggle(node, self.data[ACTION.copy])
-  renderer.draw()
+  self.explorer.renderer:draw()
 end
 
 ---Cut one node
 ---@param node Node
 function Clipboard:cut(node)
   utils.array_remove(self.data[ACTION.copy], node)
   toggle(node, self.data[ACTION.cut])
-  renderer.draw()
+  self.explorer.renderer:draw()
 end
 
 ---Paste cut or cop

Diff for: lua/nvim-tree/actions/moves/parent.lua

@@ -1,4 +1,3 @@
-local renderer = require "nvim-tree.renderer"
 local view = require "nvim-tree.view"
 local utils = require "nvim-tree.utils"
 local core = require "nvim-tree.core"
@@ -11,11 +10,16 @@ local M = {}
 function M.fn(should_close)
   should_close = should_close or false
 
+  local explorer = core.get_explorer()
+
   return function(node)
     node = lib.get_last_group_node(node)
     if should_close and node.open then
       node.open = false
-      return renderer.draw()
+      if explorer then
+        explorer.renderer:draw()
+      end
+      return
     end
 
     local parent = utils.get_parent_of_group(node).parent
@@ -31,7 +35,9 @@ function M.fn(should_close)
     view.set_cursor { line + 1, 0 }
     if should_close then
       parent.open = false
-      renderer.draw()
+      if explorer then
+        explorer.renderer:draw()
+      end
     end
   end
 end

Diff for: lua/nvim-tree/actions/reloaders.lua

@@ -1,6 +1,5 @@
 local git = require "nvim-tree.git"
 local view = require "nvim-tree.view"
-local renderer = require "nvim-tree.renderer"
 local core = require "nvim-tree.core"
 local explorer_node = require "nvim-tree.explorer.node"
 local Iterator = require "nvim-tree.iterators.node-iterator"
@@ -44,28 +43,30 @@ end
 
 local event_running = false
 function M.reload_explorer()
-  if event_running or not core.get_explorer() or vim.v.exiting ~= vim.NIL then
+  local explorer = core.get_explorer()
+  if event_running or not explorer or vim.v.exiting ~= vim.NIL then
     return
   end
   event_running = true
 
   local projects = git.reload()
-  refresh_nodes(core.get_explorer(), projects)
+  refresh_nodes(explorer, projects)
   if view.is_visible() then
-    renderer.draw()
+    explorer.renderer:draw()
   end
   event_running = false
 end
 
 function M.reload_git()
-  if not core.get_explorer() or not git.config.git.enable or event_running then
+  local explorer = core.get_explorer()
+  if not explorer or not git.config.git.enable or event_running then
     return
   end
   event_running = true
 
   local projects = git.reload()
-  M.reload_node_status(core.get_explorer(), projects)
-  renderer.draw()
+  M.reload_node_status(explorer, projects)
+  explorer.renderer:draw()
   event_running = false
 end
 

Diff for: lua/nvim-tree/actions/root/change-dir.lua

@@ -91,7 +91,10 @@ M.force_dirchange = add_profiling_to(function(foldername, should_open_view)
   if should_open_view then
     require("nvim-tree.lib").open()
   else
-    require("nvim-tree.renderer").draw()
+    local explorer = core.get_explorer()
+    if explorer then
+      explorer.renderer:draw()
+    end
   end
 end)
 

Diff for: lua/nvim-tree/actions/tree/modifiers/collapse-all.lua

@@ -1,4 +1,3 @@
-local renderer = require "nvim-tree.renderer"
 local utils = require "nvim-tree.utils"
 local core = require "nvim-tree.core"
 local lib = require "nvim-tree.lib"
@@ -46,7 +45,7 @@ function M.fn(keep_buffers)
     end)
     :iterate()
 
-  renderer.draw()
+  explorer.renderer:draw()
   utils.focus_node_or_parent(node)
 end
 

Diff for: lua/nvim-tree/actions/tree/modifiers/expand-all.lua

@@ -1,5 +1,4 @@
 local core = require "nvim-tree.core"
-local renderer = require "nvim-tree.renderer"
 local Iterator = require "nvim-tree.iterators.node-iterator"
 local notify = require "nvim-tree.notify"
 local lib = require "nvim-tree.lib"
@@ -65,11 +64,14 @@ end
 
 ---@param base_node table
 function M.fn(base_node)
-  local node = base_node.nodes and base_node or core.get_explorer()
+  local explorer = core.get_explorer()
+  local node = base_node.nodes and base_node or explorer
   if gen_iterator()(node) then
     notify.warn("expansion iteration was halted after " .. M.MAX_FOLDER_DISCOVERY .. " discovered folders")
   end
-  renderer.draw()
+  if explorer then
+    explorer.renderer:draw()
+  end
 end
 
 function M.setup(opts)

Diff for: lua/nvim-tree/diagnostics.lua

@@ -1,3 +1,4 @@
+local core = require "nvim-tree.core"
 local utils = require "nvim-tree.utils"
 local view = require "nvim-tree.view"
 local log = require "nvim-tree.log"
@@ -165,7 +166,10 @@ function M.update()
     end
     log.profile_end(profile)
     if view.is_buf_valid(view.get_bufnr()) then
-      require("nvim-tree.renderer").draw()
+      local explorer = core.get_explorer()
+      if explorer then
+        explorer.renderer:draw()
+      end
     end
   end)
 end

Diff for: lua/nvim-tree/explorer/init.lua

@@ -10,19 +10,26 @@ local NodeIterator = require "nvim-tree.iterators.node-iterator"
 local Watcher = require "nvim-tree.watcher"
 
 local Filters = require "nvim-tree.explorer.filters"
-local Marks = {} -- circular dependencies
+---@type Marks
+local Marks -- circular dependencies
 local LiveFilter = require "nvim-tree.explorer.live-filter"
 local Sorters = require "nvim-tree.explorer.sorters"
-local Clipboard = {} -- circular dependencies
+---@type Clipboard
+local Clipboard -- circular dependencies
+---@type Renderer
+local Renderer -- circular dependencies
 
 local FILTER_REASON = require("nvim-tree.enum").FILTER_REASON
 
 local config
 
 ---@class Explorer
+---@field opts table user options
 ---@field absolute_path string
 ---@field nodes Node[]
 ---@field open boolean
+---@field watcher Watcher|nil
+---@field renderer Renderer
 ---@field filters Filters
 ---@field live_filter LiveFilter
 ---@field sorters Sorter
@@ -47,17 +54,18 @@ function Explorer:new(path)
     return
   end
 
-  ---@class Explorer
+  ---@type Explorer
   local o = setmetatable({
+    opts = config,
     absolute_path = path,
     nodes = {},
     open = true,
     sorters = Sorters:new(config),
   }, Explorer)
-  setmetatable(o, self)
-  self.__index = self
+  setmetatable(o, { __index = self })
 
   o.watcher = watch.create_watcher(o)
+  o.renderer = Renderer:new(o.opts, o)
   o.filters = Filters:new(config, o)
   o.live_filter = LiveFilter:new(config, o)
   o.marks = Marks:new(config, o)
@@ -275,6 +283,7 @@ function Explorer.setup(opts)
 
   Marks = require "nvim-tree.marks"
   Clipboard = require "nvim-tree.actions.fs.clipboard"
+  Renderer = require "nvim-tree.renderer"
 end
 
 ---@private

Diff for: lua/nvim-tree/explorer/live-filter.lua

@@ -23,10 +23,6 @@ function LiveFilter:new(opts, explorer)
   return o
 end
 
-local function redraw()
-  require("nvim-tree.renderer").draw()
-end
-
 ---@param node_ Node|nil
 local function reset_filter(self, node_)
   node_ = node_ or self.explorer
@@ -129,7 +125,7 @@ local function record_char(self)
   vim.schedule(function()
     self.filter = vim.api.nvim_buf_get_lines(overlay_bufnr, 0, -1, false)[1]
     self:apply_filter()
-    redraw()
+    self.explorer.renderer:draw()
   end)
 end
 
@@ -199,7 +195,7 @@ function LiveFilter:start_filtering()
   view.View.live_filter.prev_focused_node = require("nvim-tree.lib").get_node_at_cursor()
   self.filter = self.filter or ""
 
-  redraw()
+  self.explorer.renderer:draw()
   local row = require("nvim-tree.core").get_nodes_starting_line() - 1
   local col = #self.prefix > 0 and #self.prefix - 1 or 1
   view.set_cursor { row, col }
@@ -215,7 +211,7 @@ function LiveFilter:clear_filter()
 
   self.filter = nil
   reset_filter(self)
-  redraw()
+  self.explorer.renderer:draw()
 
   if node then
     utils.focus_file(node.absolute_path)

Diff for: lua/nvim-tree/explorer/watch.lua

@@ -79,7 +79,7 @@ function M.create_watcher(node)
       local explorer = require("nvim-tree.core").get_explorer()
       if explorer then
         explorer:refresh_node(node, function()
-          require("nvim-tree.renderer").draw()
+          explorer.renderer:draw()
         end)
       end
     end)

Diff for: lua/nvim-tree/git/init.lua

@@ -216,7 +216,10 @@ local function reload_tree_at(toplevel)
       end)
       :iterate()
 
-    require("nvim-tree.renderer").draw()
+    local explorer = require("nvim-tree.core").get_explorer()
+    if explorer then
+      explorer.renderer:draw()
+    end
   end)
 end