refactor(#2827): multi instance nvim-tree.live-filter (#2849)

* feat(#2827): Multi Instance: Refactor: nvim-tree.live-filter

* refactor: all usages going through the explorer

* fix: api and filtration

* fix: style

* Update lua/nvim-tree/api.lua

Co-authored-by: Alexander Courtis <alex@courtis.org>

* docs: add missing live filter luadocs

---------

Co-authored-by: Alexander Courtis <alex@courtis.org>

lua/nvim-tree/explorer/explore.lua

@@ -2,7 +2,6 @@ local utils = require "nvim-tree.utils"
 local builders = require "nvim-tree.explorer.node-builders"
 local explorer_node = require "nvim-tree.explorer.node"
 local git = require "nvim-tree.git"
-local live_filter = require "nvim-tree.live-filter"
 local log = require "nvim-tree.log"
 
 local FILTER_REASON = require("nvim-tree.enum").FILTER_REASON
@@ -99,7 +98,7 @@ function M.explore(node, status, parent)
   end
 
   parent.sorters:sort(node.nodes)
-  live_filter.apply_filter(node)
+  parent.live_filter:apply_filter(node)
 
   log.profile_end(profile)
   return node.nodes

lua/nvim-tree/explorer/init.lua

@@ -4,6 +4,7 @@ local watch = require "nvim-tree.explorer.watch"
 local explorer_node = require "nvim-tree.explorer.node"
 local Filters = require "nvim-tree.explorer.filters"
 local Marks = require "nvim-tree.marks"
+local LiveFilter = require "nvim-tree.explorer.live-filter"
 local Sorters = require "nvim-tree.explorer.sorters"
 
 local M = {}
@@ -15,6 +16,9 @@ M.reload = require("nvim-tree.explorer.reload").reload
 ---@field absolute_path string
 ---@field nodes Node[]
 ---@field open boolean
+---@field filters Filters
+---@field live_filter LiveFilter
+---@field sorters Sorter
 ---@field marks Marks
 
 local Explorer = {}
@@ -45,6 +49,7 @@ function Explorer.new(path)
   }, Explorer)
   explorer.watcher = watch.create_watcher(explorer)
   explorer.filters = Filters:new(M.config, explorer)
+  explorer.live_filter = LiveFilter:new(M.config, explorer)
   explorer:_load(explorer)
   return explorer
 end

lua/nvim-tree/explorer/live-filter.lua

@@ -0,0 +1,227 @@
+local view = require "nvim-tree.view"
+local utils = require "nvim-tree.utils"
+local Iterator = require "nvim-tree.iterators.node-iterator"
+
+---@class LiveFilter
+---@field explorer Explorer
+---@field prefix string
+---@field always_show_folders boolean
+---@field filter string
+local LiveFilter = {}
+
+---@param opts table
+---@param explorer Explorer
+function LiveFilter:new(opts, explorer)
+  local o = {
+    explorer = explorer,
+    prefix = opts.live_filter.prefix,
+    always_show_folders = opts.live_filter.always_show_folders,
+    filter = nil,
+  }
+  setmetatable(o, self)
+  self.__index = self
+  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
+
+  if node_ == nil then
+    return
+  end
+
+  node_.hidden_stats = vim.tbl_deep_extend("force", node_.hidden_stats or {}, {
+    live_filter = 0,
+  })
+
+  Iterator.builder(node_.nodes)
+    :hidden()
+    :applier(function(node)
+      node.hidden = false
+      node.hidden_stats = vim.tbl_deep_extend("force", node.hidden_stats or {}, {
+        live_filter = 0,
+      })
+    end)
+    :iterate()
+end
+
+local overlay_bufnr = 0
+local overlay_winnr = 0
+
+local function remove_overlay(self)
+  if view.View.float.enable and view.View.float.quit_on_focus_loss then
+    -- return to normal nvim-tree float behaviour when filter window is closed
+    vim.api.nvim_create_autocmd("WinLeave", {
+      pattern = "NvimTree_*",
+      group = vim.api.nvim_create_augroup("NvimTree", { clear = false }),
+      callback = function()
+        if utils.is_nvim_tree_buf(0) then
+          view.close()
+        end
+      end,
+    })
+  end
+
+  vim.api.nvim_win_close(overlay_winnr, true)
+  vim.api.nvim_buf_delete(overlay_bufnr, { force = true })
+  overlay_bufnr = 0
+  overlay_winnr = 0
+
+  if self.filter == "" then
+    self:clear_filter()
+  end
+end
+
+---@param node Node
+---@return boolean
+local function matches(self, node)
+  if not self.explorer.filters.config.enable then
+    return true
+  end
+
+  local path = node.absolute_path
+  local name = vim.fn.fnamemodify(path, ":t")
+  return vim.regex(self.filter):match_str(name) ~= nil
+end
+
+---@param node_ Node|nil
+function LiveFilter:apply_filter(node_)
+  if not self.filter or self.filter == "" then
+    reset_filter(self, node_)
+    return
+  end
+
+  -- TODO(kiyan): this iterator cannot yet be refactored with the Iterator module
+  -- since the node mapper is based on its children
+  local function iterate(node)
+    local filtered_nodes = 0
+    local nodes = node.group_next and { node.group_next } or node.nodes
+
+    node.hidden_stats = vim.tbl_deep_extend("force", node.hidden_stats or {}, {
+      live_filter = 0,
+    })
+
+    if nodes then
+      for _, n in pairs(nodes) do
+        iterate(n)
+        if n.hidden then
+          filtered_nodes = filtered_nodes + 1
+        end
+      end
+    end
+
+    node.hidden_stats.live_filter = filtered_nodes
+
+    local has_nodes = nodes and (self.always_show_folders or #nodes > filtered_nodes)
+    local ok, is_match = pcall(matches, self, node)
+    node.hidden = not (has_nodes or (ok and is_match))
+  end
+
+  iterate(node_ or self.explorer)
+end
+
+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()
+  end)
+end
+
+local function configure_buffer_overlay(self)
+  overlay_bufnr = vim.api.nvim_create_buf(false, true)
+
+  vim.api.nvim_buf_attach(overlay_bufnr, true, {
+    on_lines = function()
+      return record_char(self)
+    end,
+  })
+
+  vim.api.nvim_create_autocmd("InsertLeave", {
+    callback = function()
+      return remove_overlay(self)
+    end,
+    once = true,
+  })
+
+  vim.api.nvim_buf_set_keymap(overlay_bufnr, "i", "<CR>", "<cmd>stopinsert<CR>", {})
+end
+
+---@return integer
+local function calculate_overlay_win_width(self)
+  local wininfo = vim.fn.getwininfo(view.get_winnr())[1]
+
+  if wininfo then
+    return wininfo.width - wininfo.textoff - #self.prefix
+  end
+
+  return 20
+end
+
+local function create_overlay(self)
+  if view.View.float.enable then
+    -- don't close nvim-tree float when focus is changed to filter window
+    vim.api.nvim_clear_autocmds {
+      event = "WinLeave",
+      pattern = "NvimTree_*",
+      group = vim.api.nvim_create_augroup("NvimTree", { clear = false }),
+    }
+  end
+
+  configure_buffer_overlay(self)
+  overlay_winnr = vim.api.nvim_open_win(overlay_bufnr, true, {
+    col = 1,
+    row = 0,
+    relative = "cursor",
+    width = calculate_overlay_win_width(self),
+    height = 1,
+    border = "none",
+    style = "minimal",
+  })
+
+  if vim.fn.has "nvim-0.10" == 1 then
+    vim.api.nvim_set_option_value("modifiable", true, { buf = overlay_bufnr })
+  else
+    vim.api.nvim_buf_set_option(overlay_bufnr, "modifiable", true) ---@diagnostic disable-line: deprecated
+  end
+
+  vim.api.nvim_buf_set_lines(overlay_bufnr, 0, -1, false, { self.filter })
+  vim.cmd "startinsert"
+  vim.api.nvim_win_set_cursor(overlay_winnr, { 1, #self.filter + 1 })
+end
+
+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()
+  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 }
+  -- needs scheduling to let the cursor move before initializing the window
+  vim.schedule(function()
+    return create_overlay(self)
+  end)
+end
+
+function LiveFilter:clear_filter()
+  local node = require("nvim-tree.lib").get_node_at_cursor()
+  local last_node = view.View.live_filter.prev_focused_node
+
+  self.filter = nil
+  reset_filter(self)
+  redraw()
+
+  if node then
+    utils.focus_file(node.absolute_path)
+  elseif last_node then
+    utils.focus_file(last_node.absolute_path)
+  end
+end
+
+return LiveFilter

lua/nvim-tree/explorer/reload.lua

@@ -1,7 +1,6 @@
 local utils = require "nvim-tree.utils"
 local builders = require "nvim-tree.explorer.node-builders"
 local explorer_node = require "nvim-tree.explorer.node"
-local live_filter = require "nvim-tree.live-filter"
 local git = require "nvim-tree.git"
 local log = require "nvim-tree.log"
 
@@ -183,7 +182,7 @@ function M.reload(node, git_status)
   end
 
   explorer.sorters:sort(node.nodes)
-  live_filter.apply_filter(node)
+  explorer.live_filter:apply_filter(node)
   log.profile_end(profile)
   return node.nodes
 end