add DecoratorOpened

Author: alex-courtis

doc/nvim-tree-lua.txt

@@ -2305,6 +2305,9 @@ Modified: >
     NvimTreeModifiedFileHL      NvimTreeModifiedIcon
     NvimTreeModifiedFolderHL    NvimTreeModifiedIcon
 <
+Opened: >
+    NvimTreeOpenedHL            Constant
+<
 Picker: >
     NvimTreeWindowPicker        guifg=#ededed guibg=#4493c8 gui=bold ctermfg=White ctermbg=Cyan
 <
@@ -2388,6 +2391,7 @@ Legacy highlight group are still obeyed when they are defined and the current
 highlight group is not, hard linking as follows: >
 
     NvimTreeModifiedIcon        NvimTreeModifiedFile
+    NvimTreeOpenedHL            NvimTreeOpenedFile
 
     NvimTreeGitDeletedIcon      NvimTreeGitDeleted
     NvimTreeGitDirtyIcon        NvimTreeGitDirty

lua/nvim-tree.lua

@@ -210,7 +210,7 @@ local function setup_autocommands(opts)
       -- update opened file buffers
       if (filters.config.filter_no_buffer or renderer.config.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(nil, data.buf)
+          actions.reloaders.reload_explorer()
         end)
       end
     end,
@@ -797,7 +797,7 @@ function M.setup(conf)
   require("nvim-tree.renderer").setup(opts)
   require("nvim-tree.live-filter").setup(opts)
   require("nvim-tree.marks").setup(opts)
-  require("nvim-tree.modified").setup(opts)
+  require("nvim-tree.buffers").setup(opts)
   require("nvim-tree.help").setup(opts)
   require("nvim-tree.watcher").setup(opts)
   if M.config.renderer.icons.show.file and pcall(require, "nvim-web-devicons") then

lua/nvim-tree/actions/reloaders.lua

@@ -10,13 +10,12 @@ local M = {}
 
 ---@param node Explorer|nil
 ---@param projects table
----@param unloaded_bufnr number|nil
-local function refresh_nodes(node, projects, unloaded_bufnr)
+local function refresh_nodes(node, projects)
   Iterator.builder({ node })
     :applier(function(n)
       if n.nodes then
         local toplevel = git.get_toplevel(n.cwd or n.link_to or n.absolute_path)
-        explorer_module.reload(n, projects[toplevel] or {}, unloaded_bufnr)
+        explorer_module.reload(n, projects[toplevel] or {})
       end
     end)
     :recursor(function(n)
@@ -43,18 +42,16 @@ function M.reload_node_status(parent_node, projects)
 end
 
 local event_running = false
----@param _ table|nil unused node passed by action
----@param unloaded_bufnr number|nil optional bufnr recently unloaded via BufUnload event
-function M.reload_explorer(_, unloaded_bufnr)
+function M.reload_explorer()
   if event_running or not core.get_explorer() or vim.v.exiting ~= vim.NIL then
     return
   end
   event_running = true
 
   local projects = git.reload()
-  refresh_nodes(core.get_explorer(), projects, unloaded_bufnr)
+  refresh_nodes(core.get_explorer(), projects)
   if view.is_visible() then
-    renderer.draw(unloaded_bufnr)
+    renderer.draw()
   end
   event_running = false
 end

lua/nvim-tree/buffers.lua

@@ -0,0 +1,64 @@
+local M = {}
+
+---@type table<string, boolean> record of which file is modified
+M._modified = {}
+
+---@type number unloaded_bufnr for the duration of BufUnload
+M._unloaded_bufnr = nil
+
+---refresh M._modified
+function M.reload_modified()
+  M._modified = {}
+  local bufs = vim.fn.getbufinfo { bufmodified = true, buflisted = true }
+  for _, buf in pairs(bufs) do
+    local path = buf.name
+    if path ~= "" then -- not a [No Name] buffer
+      -- mark all the parent as modified as well
+      while
+        M._modified[path] ~= true
+        -- no need to keep going if already recorded
+        -- This also prevents an infinite loop
+      do
+        M._modified[path] = true
+        path = vim.fn.fnamemodify(path, ":h")
+      end
+    end
+  end
+end
+
+---@param node table
+---@return boolean
+function M.is_modified(node)
+  return node
+    and M.config.modified.enable
+    and M._modified[node.absolute_path]
+    and (not node.nodes or M.config.modified.show_on_dirs)
+    and (not node.open or M.config.modified.show_on_open_dirs)
+end
+
+---A buffer exists for the node's absolute path and it's not in the middle of a BufUnload handler.
+---@param node table
+---@return boolean
+function M.is_opened(node)
+  return node and vim.fn.bufloaded(node.absolute_path) > 0 and vim.fn.bufnr(node.absolute_path) ~= M._unloaded_bufnr
+end
+
+---Set the unloaded bufnr - at the start of the BufUnload handler.
+---@param bufnr number
+function M.set_unloaded_bufnr(bufnr)
+  M._unloaded_bufnr = bufnr
+end
+
+---Reset the unloaded bufnr - at the end of the BufUnload handler.
+function M.reset_unloaded_bufnr()
+  M._unloaded_bufnr = nil
+end
+
+---@param opts table
+function M.setup(opts)
+  M.config = {
+    modified = opts.modified,
+  }
+end
+
+return M

lua/nvim-tree/colors.lua

@@ -69,6 +69,9 @@ local DEFAULT_LINKS = {
   NvimTreeModifiedFileHL = "NvimTreeModifiedIcon",
   NvimTreeModifiedFolderHL = "NvimTreeModifiedFileHL",
 
+  -- Opened
+  NvimTreeOpenedHL = "Constant",
+
   -- LiveFilter
   NvimTreeLiveFilterPrefix = "PreProc",
   NvimTreeLiveFilterValue = "ModeMsg",
@@ -123,6 +126,8 @@ local DEFAULT_LINKS = {
 local LEGACY_LINKS = {
   NvimTreeModifiedIcon = "NvimTreeModifiedFile",
 
+  NvimTreeOpenedHL = "NvimTreeOpenedFile",
+
   NvimTreeGitDeletedIcon = "NvimTreeGitDeleted",
   NvimTreeGitDirtyIcon = "NvimTreeGitDirty",
   NvimTreeGitIgnoredIcon = "NvimTreeGitIgnored",

lua/nvim-tree/renderer/builder.lua

@@ -54,11 +54,6 @@ function Builder:configure_filter(filter, prefix)
   return self
 end
 
-function Builder:configure_opened_file_highlighting(highlight_opened_files)
-  self.highlight_opened_files = highlight_opened_files
-  return self
-end
-
 function Builder:configure_icon_padding(padding)
   self.icon_padding = padding or " "
   return self
@@ -260,41 +255,6 @@ function Builder:_get_bookmark_icon(node)
   return bookmark_icon
 end
 
----@param node table
----@return string|nil icon_hl
----@return string|nil name_hl
-function Builder:_get_highlight_override(node, unloaded_bufnr)
-  local name_hl, icon_hl
-
-  -- opened file
-  if self.highlight_opened_files and vim.fn.bufloaded(node.absolute_path) > 0 and vim.fn.bufnr(node.absolute_path) ~= unloaded_bufnr then
-    if self.highlight_opened_files == "all" or self.highlight_opened_files == "name" then
-      name_hl = "NvimTreeOpenedFile"
-    end
-    if self.highlight_opened_files == "all" or self.highlight_opened_files == "icon" then
-      icon_hl = "NvimTreeOpenedFileIcon"
-    end
-  end
-  return icon_hl, name_hl
-end
-
----Append optional highlighting to icon or name.
----@param node table
----@param get_hl fun(node: table): HL_POSITION, string
----@param icon_hl string[] icons to append to
----@param name_hl string[] names to append to
-function Builder:_append_highlight(node, get_hl, icon_hl, name_hl)
-  local pos, hl = get_hl(node)
-  if pos ~= HL_POSITION.none and hl then
-    if pos == HL_POSITION.all or pos == HL_POSITION.icon then
-      table.insert(icon_hl, hl)
-    end
-    if pos == HL_POSITION.all or pos == HL_POSITION.name then
-      table.insert(name_hl, hl)
-    end
-  end
-end
-
 ---Append optional highlighting to icon or name.
 ---@param node table
 ---@param decorator Decorator
@@ -372,7 +332,7 @@ function Builder:_format_line(indent_markers, arrows, icon, name, git_icons, dia
   return line
 end
 
-function Builder:_build_line(node, idx, num_children, unloaded_bufnr)
+function Builder:_build_line(node, idx, num_children)
   -- various components
   local indent_markers = pad.get_indent_markers(self.depth, idx, num_children, node, self.markers)
   local arrows = pad.get_arrows(node)
@@ -395,17 +355,9 @@ function Builder:_build_line(node, idx, num_children, unloaded_bufnr)
     icon, name = self:_build_file(node)
   end
 
-  -- highlight override
-  local icon_hl_override, name_hl_override = self:_get_highlight_override(node, unloaded_bufnr)
-  if icon_hl_override then
-    icon.hl = { icon_hl_override }
-  end
-  if name_hl_override then
-    name.hl = { name_hl_override }
-  end
-
   -- extra highighting
   self:_append_dec_highlight(node, self.decorators.git, icon.hl, name.hl)
+  self:_append_dec_highlight(node, self.decorators.opened, icon.hl, name.hl)
   self:_append_dec_highlight(node, self.decorators.modified, icon.hl, name.hl)
   self:_append_dec_highlight(node, self.decorators.bookmarks, icon.hl, name.hl)
   self:_append_dec_highlight(node, self.decorators.diagnostics, icon.hl, name.hl)
@@ -421,7 +373,7 @@ function Builder:_build_line(node, idx, num_children, unloaded_bufnr)
 
   if node.open then
     self.depth = self.depth + 1
-    self:build(node, unloaded_bufnr)
+    self:build(node)
     self.depth = self.depth - 1
   end
 end
@@ -440,12 +392,12 @@ function Builder:_get_nodes_number(nodes)
   return i
 end
 
-function Builder:build(tree, unloaded_bufnr)
+function Builder:build(tree)
   local num_children = self:_get_nodes_number(tree.nodes)
   local idx = 1
   for _, node in ipairs(tree.nodes) do
     if not node.hidden then
-      self:_build_line(node, idx, num_children, unloaded_bufnr)
+      self:_build_line(node, idx, num_children)
       idx = idx + 1
     end
   end

lua/nvim-tree/renderer/decorator/init.lua

@@ -16,14 +16,14 @@ end
 ---@diagnostic disable: unused-local
 
 --- Node icon
---- @param node table
+--- @param _ table node
 --- @return HighlightedString|nil modified icon
-function Decorator:get_icon(node) end
+function Decorator:get_icon(_) end
 
 --- Node highlight group
---- @param node table
+--- @param _ table node
 --- @return string|nil group
-function Decorator:get_highlight(node) end
+function Decorator:get_highlight(_) end
 
 ---@diagnostic enable: unused-local
 
@@ -32,7 +32,13 @@ function Decorator:get_highlight(node) end
 --- @param icon HighlightedString|nil
 function Decorator:define_sign(icon)
   if icon and #icon.hl > 0 then
-    vim.fn.sign_define(icon.hl[1], {
+    local name = icon.hl[1]
+
+    if not vim.tbl_isempty(vim.fn.sign_getdefined(name)) then
+      vim.fn.sign_undefine(name)
+    end
+
+    vim.fn.sign_define(name, {
       text = icon.str,
       texthl = icon.hl[1],
     })

lua/nvim-tree/renderer/decorator/modified.lua

@@ -1,4 +1,4 @@
-local modified = require "nvim-tree.modified"
+local buffers = require "nvim-tree.buffers"
 
 local HL_POSITION = require("nvim-tree.enum").HL_POSITION
 local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
@@ -37,14 +37,14 @@ end
 
 --- Modified icon: modified.enable, renderer.icons.show.modified and node is modified
 function DecoratorModified:get_icon(node)
-  if self.enabled and modified.is_modified(node) then
+  if self.enabled and buffers.is_modified(node) then
     return self.icon
   end
 end
 
 --- Modified highlight: modified.enable, renderer.highlight_modified and node is modified
 function DecoratorModified:get_highlight(node)
-  if not self.enabled or self.hl_pos == HL_POSITION.none or not modified.is_modified(node) then
+  if not self.enabled or self.hl_pos == HL_POSITION.none or not buffers.is_modified(node) then
     return nil
   end
 

lua/nvim-tree/renderer/decorator/opened.lua

@@ -0,0 +1,33 @@
+local buffers = require "nvim-tree.buffers"
+
+local HL_POSITION = require("nvim-tree.enum").HL_POSITION
+local ICON_PLACEMENT = require("nvim-tree.enum").ICON_PLACEMENT
+
+local Decorator = require "nvim-tree.renderer.decorator"
+
+--- @class DecoratorOpened: Decorator
+--- @field enabled boolean
+--- @field icon HighlightedString|nil
+local DecoratorOpened = Decorator:new()
+
+--- @param opts table
+--- @return DecoratorOpened
+function DecoratorOpened:new(opts)
+  local o = Decorator.new(self, {
+    hl_pos = HL_POSITION[opts.renderer.highlight_opened_files] or HL_POSITION.none,
+    icon_placement = ICON_PLACEMENT.none,
+  })
+  ---@cast o DecoratorOpened
+
+  return o
+end
+
+--- Opened highlight: renderer.highlight_opened_files and node has an open buffer
+--- @param node table
+function DecoratorOpened:get_highlight(node)
+  if self.hl_pos ~= HL_POSITION.none and buffers.is_opened(node) then
+    return "NvimTreeOpenedHL"
+  end
+end
+
+return DecoratorOpened