node classes and constructors

Author: alex-courtis

lua/nvim-tree/actions/fs/create-file.lua

@@ -30,14 +30,16 @@ local function get_num_nodes(iter)
   return i
 end
 
----@param node Node
+---@param has_children boolean
+---@param absolute_path string
+---@param name string
 ---@return string
-local function get_containing_folder(node)
-  if node.nodes ~= nil then
-    return utils.path_add_trailing(node.absolute_path)
+local function get_containing_folder(has_children, absolute_path, name)
+  if has_children then
+    return utils.path_add_trailing(absolute_path)
   end
-  local node_name_size = #(node.name or "")
-  return node.absolute_path:sub(0, -node_name_size - 1)
+  local node_name_size = #(name or "")
+  return absolute_path:sub(0, -node_name_size - 1)
 end
 
 ---@param node Node|nil
@@ -48,17 +50,14 @@ function M.fn(node)
   end
 
   node = node and lib.get_last_group_node(node)
+
+  local containing_folder
   if not node or node.name == ".." then
-    node = {
-      absolute_path = cwd,
-      name = "",
-      nodes = core.get_explorer().nodes,
-      open = true,
-    }
+    containing_folder = get_containing_folder(core.get_explorer().nodes ~= nil, cwd, "")
+  else
+    containing_folder = get_containing_folder(node.nodes ~= nil, node.absolute_path, node.name)
   end
 
-  local containing_folder = get_containing_folder(node)
-
   local input_opts = {
     prompt = "Create file ",
     default = containing_folder,

lua/nvim-tree/enum.lua

@@ -1,5 +1,13 @@
 local M = {}
 
+---Roughly synced with uv.fs_stat.result
+---@enum (key) NODE_TYPE
+M.NODE_TYPE = {
+  directory = 1,
+  file = 2,
+  link = 4,
+}
+
 ---Setup options for "highlight_*"
 ---@enum HL_POSITION
 M.HL_POSITION = {

lua/nvim-tree/explorer/init.lua

@@ -1,4 +1,3 @@
-local builders = require("nvim-tree.explorer.node-builders")
 local git = require("nvim-tree.git")
 local log = require("nvim-tree.log")
 local notify = require("nvim-tree.notify")
@@ -7,9 +6,13 @@ local view = require("nvim-tree.view")
 local watch = require("nvim-tree.explorer.watch")
 local explorer_node = require("nvim-tree.explorer.node")
 
+local DirectoryNode = require("nvim-tree.node.directory")
+local FileNode = require("nvim-tree.node.file")
+local LinkNode = require("nvim-tree.node.link")
+local Watcher = require("nvim-tree.watcher")
+
 local Iterator = require("nvim-tree.iterators.node-iterator")
 local NodeIterator = require("nvim-tree.iterators.node-iterator")
-local Watcher = require("nvim-tree.watcher")
 
 local Filters = require("nvim-tree.explorer.filters")
 local Marks = require("nvim-tree.marks")
@@ -155,11 +158,11 @@ function Explorer:reload(node, git_status)
       if not nodes_by_path[abs] then
         local new_child = nil
         if t == "directory" and vim.loop.fs_access(abs, "R") and Watcher.is_fs_event_capable(abs) then
-          new_child = builders.folder(node, abs, name, stat)
+          new_child = DirectoryNode:new(self, node, abs, name, stat)
         elseif t == "file" then
-          new_child = builders.file(node, abs, name, stat)
+          new_child = FileNode:new(self, node, abs, name, stat)
         elseif t == "link" then
-          local link = builders.link(node, abs, name, stat)
+          local link = LinkNode:new(self, node, abs, name, stat)
           if link.link_to ~= nil then
             new_child = link
           end
@@ -171,7 +174,7 @@ function Explorer:reload(node, git_status)
       else
         local n = nodes_by_path[abs]
         if n then
-          n.executable = builders.is_executable(abs) or false
+          n.executable = utils.is_executable(abs) or false
           n.fs_stat = stat
         end
       end
@@ -372,11 +375,11 @@ function Explorer:populate_children(handle, cwd, node, git_status, parent)
         local t = stat and stat.type or nil
         local child = nil
         if t == "directory" and vim.loop.fs_access(abs, "R") then
-          child = builders.folder(node, abs, name, stat)
+          child = DirectoryNode:new(self, node, abs, name, stat)
         elseif t == "file" then
-          child = builders.file(node, abs, name, stat)
+          child = FileNode:new(self, node, abs, name, stat)
         elseif t == "link" then
-          local link = builders.link(node, abs, name, stat)
+          local link = LinkNode:new(self, node, abs, name, stat)
           if link.link_to ~= nil then
             child = link
           end

lua/nvim-tree/node.lua

@@ -0,0 +1,46 @@
+local watch = require("nvim-tree.explorer.watch")
+
+local BaseNode = require("nvim-tree.node.init")
+
+---@class (exact) DirectoryNode: BaseNode
+---@field has_children boolean
+---@field group_next Node|nil
+---@field nodes Node[]
+---@field open boolean
+---@field hidden_stats table -- Each field of this table is a key for source and value for count
+local DirectoryNode = BaseNode:new()
+
+---@param explorer Explorer
+-----@param parent DirectoryNode    -- TODO
+---@param absolute_path string
+---@param name string
+---@param fs_stat uv.fs_stat.result|nil
+---@return DirectoryNode
+function DirectoryNode:new(explorer, parent, absolute_path, name, fs_stat)
+  local handle = vim.loop.fs_scandir(absolute_path)
+  local has_children = handle and vim.loop.fs_scandir_next(handle) ~= nil
+
+  local o = BaseNode.new(self, {
+    type = "directory",
+    explorer = explorer,
+    absolute_path = absolute_path,
+    executable = false,
+    fs_stat = fs_stat,
+    hidden = false,
+    is_dot = false,
+    name = name,
+    parent = parent,
+
+    has_children = has_children,
+    group_next = nil, -- If node is grouped, this points to the next child dir/link node
+    nodes = {},
+    open = false,
+  })
+  ---@cast o DirectoryNode
+
+  o.watcher = watch.create_watcher(o)
+
+  return o
+end
+
+return DirectoryNode

lua/nvim-tree/node/directory.lua

@@ -0,0 +1,34 @@
+local utils = require("nvim-tree.utils")
+
+local BaseNode = require("nvim-tree.node.init")
+
+---@class (exact) FileNode: BaseNode
+---@field extension string
+local FileNode = BaseNode:new()
+
+---@param explorer Explorer
+-----@param parent DirectoryNode    -- TODO
+---@param absolute_path string
+---@param name string
+---@param fs_stat uv.fs_stat.result|nil
+---@return FileNode
+function FileNode:new(explorer, parent, absolute_path, name, fs_stat)
+  local o = BaseNode.new(self, {
+    type = "file",
+    explorer = explorer,
+    absolute_path = absolute_path,
+    executable = utils.is_executable(absolute_path),
+    fs_stat = fs_stat,
+    name = name,
+    parent = parent,
+    hidden = false,
+    is_dot = false,
+
+    extension = string.match(name, ".?[^.]+%.(.*)") or "",
+  })
+  ---@cast o FileNode
+
+  return o
+end
+
+return FileNode

lua/nvim-tree/node/file.lua

@@ -0,0 +1,31 @@
+---@class ParentNode
+---@field name string
+
+---@class (exact) BaseNode
+---@field type NODE_TYPE
+---@field explorer Explorer
+---@field absolute_path string
+---@field executable boolean
+---@field fs_stat uv.fs_stat.result|nil
+---@field git_status GitStatus|nil
+---@field hidden boolean
+---@field is_dot boolean
+---@field name string
+---@field parent DirectoryNode
+---@field watcher Watcher|nil
+---@field diag_status DiagStatus|nil
+local BaseNode = {}
+
+---@alias Node DirectoryNode|FileNode|LinkNode|Explorer
+
+---@param o BaseNode|nil
+---@return BaseNode
+function BaseNode:new(o)
+  o = o or {}
+
+  setmetatable(o, { __index = self })
+
+  return o
+end
+
+return BaseNode

lua/nvim-tree/node/init.lua

@@ -0,0 +1,60 @@
+local watch = require("nvim-tree.explorer.watch")
+
+local BaseNode = require("nvim-tree.node.init")
+
+---@class (exact) LinkNode: BaseNode
+---@field link_to string absolute path
+local LinkNode = BaseNode:new()
+
+---@param explorer Explorer
+-----@param parent DirectoryNode    -- TODO
+---@param absolute_path string
+---@param name string
+---@param fs_stat uv.fs_stat.result|nil
+---@return LinkNode
+function LinkNode:new(explorer, parent, absolute_path, name, fs_stat)
+  local link_to = vim.loop.fs_realpath(absolute_path)
+  local open, nodes, has_children
+
+  -- TODO-INFO: sometimes fs_realpath returns nil
+  -- I expect this be a bug in glibc, because it fails to retrieve the path for some
+  -- links (for instance libr2.so in /usr/lib) and thus even with a C program realpath fails
+  -- when it has no real reason to. Maybe there is a reason, but errno is definitely wrong.
+  -- So we need to check for link_to ~= nil when adding new links to the main tree
+  local is_dir_link = (link_to ~= nil) and vim.loop.fs_stat(link_to).type == "directory"
+
+  if is_dir_link and link_to then
+    local handle = vim.loop.fs_scandir(link_to)
+    has_children = handle and vim.loop.fs_scandir_next(handle) ~= nil
+    open = false
+    nodes = {}
+  end
+
+  local o = BaseNode.new(self, {
+    type = "link",
+    explorer = explorer,
+    absolute_path = absolute_path,
+    executable = false,
+    fs_stat = fs_stat,
+    hidden = false,
+    is_dot = false,
+    name = name,
+    parent = parent,
+
+    link_to = link_to,
+
+    has_children = has_children,
+    group_next = nil, -- If node is grouped, this points to the next child dir/link node
+    nodes = nodes,
+    open = open,
+  })
+  ---@cast o LinkNode
+
+  if is_dir_link then
+    o.watcher = watch.create_watcher(o)
+  end
+
+  return o
+end
+
+return LinkNode

lua/nvim-tree/node/link.lua

@@ -578,4 +578,16 @@ function M.is_nvim_tree_buf(bufnr)
   return false
 end
 
+--- path is an executable file or directory
+---@param absolute_path string
+---@return boolean
+function M.is_executable(absolute_path)
+  if M.is_windows or M.is_wsl then
+    --- executable detection on windows is buggy and not performant hence it is disabled
+    return false
+  else
+    return vim.loop.fs_access(absolute_path, "X") or false
+  end
+end
+
 return M