WIP, about to add a BaseSource

cseickel · cseickel · commit 4c741266ef70 · 2022-01-17T02:09:31.000Z
diff --git a/lua/neo-tree.lua b/lua/neo-tree.lua
@@ -64,6 +64,7 @@ local define_events = function()
   events.define_autocmd_event(events.VIM_BUFFER_ENTER, { "BufEnter", "BufWinEnter" }, 0)
   events.define_autocmd_event(events.VIM_WIN_ENTER, { "WinEnter" }, 0)
   events.define_autocmd_event(events.VIM_DIR_CHANGED, { "DirChanged" }, 200)
+  events.define_autocmd_event(events.VIM_TAB_CLOSED, { "TabClosed" })
   events_setup = true
 end
 
diff --git a/lua/neo-tree/events/init.lua b/lua/neo-tree/events/init.lua
@@ -19,13 +19,14 @@ local M = {
   VIM_BUFFER_ENTER = "vim_buffer_enter",
   VIM_DIAGNOSTIC_CHANGED = "vim_diagnostic_changed",
   VIM_DIR_CHANGED = "vim_dir_changed",
+  VIM_TAB_CLOSED = "vim_tab_closed",
   VIM_WIN_ENTER = "vim_win_enter",
 }
 
 M.define_autocmd_event = function(event_name, autocmds, debounce_frequency, seed_fn)
   local opts = {
     setup = function()
-      local tpl = ":lua require('neo-tree.events').fire_event('%s')"
+      local tpl = ":lua require('neo-tree.events').fire_event('%s', '<afile>')"
       local callback = string.format(tpl, event_name)
       local cmds = {
         "augroup NeoTreeEvent_" .. event_name,
diff --git a/lua/neo-tree/sources/common/base_source.lua b/lua/neo-tree/sources/common/base_source.lua
@@ -0,0 +1,173 @@
+--This file should have all functions that are in the public api and either set
+--or read the state of this source.
+
+local vim = vim
+local utils = require("neo-tree.utils")
+local fs_scan = require("neo-tree.sources.filesystem.lib.fs_scan")
+local renderer = require("neo-tree.ui.renderer")
+local events = require("neo-tree.events")
+local log = require("neo-tree.log")
+
+local BaseSource = {}
+function BaseSource:new()
+  local props = {}
+  setmetatable(props, self)
+  self.__index = self
+  return props
+end
+
+local default_config = nil
+local state_by_tab = {}
+
+local get_state = function(tabnr)
+  tabnr = tabnr or vim.api.nvim_get_current_tabpage()
+  local state = state_by_tab[tabnr]
+  if not state then
+    state = utils.table_copy(default_config)
+    state.tabnr = tabnr
+    state_by_tab[tabnr] = state
+  end
+  return state
+end
+
+local get_path_to_reveal = function()
+  if vim.bo.filetype == "neo-tree" then
+    return nil
+  end
+  local path = vim.fn.expand("%:p")
+  if not path or path == "" or path:match("term://") then
+    return nil
+  end
+  return path
+end
+
+BaseSource.subscribe = function(event)
+  local state = get_state()
+  if not state.subscriptions then
+    state.subscriptions = {}
+  end
+  state.subscriptions[event] = true
+  events.subscribe(event)
+end
+
+BaseSource.unsubscribe = function(event, state)
+  state = state or get_state()
+  if state.subscriptions then
+    state.subscriptions[event] = false
+  end
+  events.unsubscribe(event)
+end
+
+BaseSource.close = function()
+  local state = get_state()
+  return renderer.close(state)
+end
+
+---Redraws the tree with updated diagnostics without scanning the filesystem again.
+BaseSource.diagnostics_changed = function(args)
+  local state = get_state()
+  args = args or {}
+  state.diagnostics_lookup = args.diagnostics_lookup
+  if renderer.window_exists(state) then
+    state.tree:render()
+  end
+end
+
+---Called by autocmds when the cwd dir is changed. This will change the root.
+BaseSource.dir_changed = function()
+  local state = get_state()
+  local cwd = vim.fn.getcwd()
+  if state.path and cwd == state.path then
+    return
+  end
+  if state.path and renderer.window_exists(state) then
+    BaseSource.navigate(cwd)
+  end
+end
+
+BaseSource.dispose = function(tabnr)
+  local state = get_state(tabnr)
+  fs_scan.stop_watchers(state)
+  renderer.close(state)
+  for event, subscribed in pairs(state.subscriptions) do
+    if subscribed then
+      unsubscribe(event, state)
+    end
+  end
+  state_by_tab[state.tabnr] = nil
+end
+
+BaseSource.float = function()
+  local state = get_state()
+  state.force_float = true
+  local path_to_reveal = get_path_to_reveal()
+  BaseSource.navigate(state.path, path_to_reveal)
+end
+
+---Focus the window, opening it if it is not already open.
+---@param path_to_reveal string Node to focus after the items are loaded.
+---@param callback function Callback to call after the items are loaded.
+BaseSource.focus = function(path_to_reveal, callback)
+  local state = get_state()
+  if path_to_reveal then
+    BaseSource.navigate(state.path, path_to_reveal, callback)
+  else
+    if renderer.window_exists(state) then
+      vim.api.nvim_set_current_win(state.winid)
+    else
+      BaseSource.navigate(state.path, nil, callback)
+    end
+  end
+end
+
+---Navigate to the given path.
+---@param path string Path to navigate to. If empty, will navigate to the cwd.
+---@param path_to_reveal string Node to focus after the items are loaded.
+---@param callback function Callback to call after the items are loaded.
+BaseSource.navigate = function(path, path_to_reveal, callback)
+  local state = get_state()
+  log.error(state.name .. ".navigate() must be overwritten!")
+end
+
+BaseSource.reveal_current_file = function(toggle_if_open)
+  local state = get_state()
+  log.error(state.name .. ".reveal_current_file() must be overwritten!")
+end
+
+---Redraws the tree without loading items again. Use this after
+-- making changes to the nodes that would affect how their components are
+-- rendered.
+BaseSource.redraw = function()
+  local state = get_state()
+  if renderer.window_exists(state) then
+    state.tree:render()
+  end
+end
+
+---Refreshes the tree by loading the items again.
+BaseSource.refresh = function(callback)
+  local state = get_state()
+  if state.path and renderer.window_exists(state) then
+    if type(callback) ~= "function" then
+      callback = nil
+    end
+    BaseSource.navigate(state.path, nil, callback)
+  end
+end
+
+---Configures the plugin, should be called before the plugin is used.
+---@param config table Configuration table containing any keys that the user
+--wants to change from the defaults. May be empty to accept default values.
+BaseSource.setup = function(config, global_config)
+  default_config = config
+  log.error(state.name .. ".setup() must be overwritten!")
+end
+
+---Opens the tree and displays the current path or cwd.
+---@param callback function Callback to call after the items are loaded.
+BaseSource.show = function(callback)
+  local state = get_state()
+  BaseSource.navigate(state.path, nil, callback)
+end
+
+return BaseSource
diff --git a/lua/neo-tree/sources/filesystem/init.lua b/lua/neo-tree/sources/filesystem/init.lua
@@ -13,8 +13,8 @@ local M = {}
 local default_config = nil
 local state_by_tab = {}
 
-local get_state = function()
-  local tabnr = vim.api.nvim_get_current_tabpage()
+local get_state = function(tabnr)
+  tabnr = tabnr or vim.api.nvim_get_current_tabpage()
   local state = state_by_tab[tabnr]
   if not state then
     state = utils.table_copy(default_config)
@@ -48,6 +48,23 @@ local get_path_to_reveal = function()
   return path
 end
 
+local subscribe = function(event)
+  local state = get_state()
+  if not state.subscriptions then
+    state.subscriptions = {}
+  end
+  state.subscriptions[event] = true
+  events.subscribe(event)
+end
+
+local unsubscribe = function(event, state)
+  state = state or get_state()
+  if state.subscriptions then
+    state.subscriptions[event] = false
+  end
+  events.unsubscribe(event)
+end
+
 M.close = function()
   local state = get_state()
   return renderer.close(state)
@@ -75,6 +92,18 @@ M.dir_changed = function()
   end
 end
 
+M.dispose = function(tabnr)
+  local state = get_state(tabnr)
+  fs_scan.stop_watchers(state)
+  renderer.close(state)
+  for event, subscribed in pairs(state.subscriptions) do
+    if subscribed then
+      unsubscribe(event, state)
+    end
+  end
+  state_by_tab[state.tabnr] = nil
+end
+
 M.float = function()
   local state = get_state()
   state.force_float = true
@@ -280,13 +309,13 @@ M.setup = function(config, global_config)
 
   --Configure events for before_render
   local before_render_id = config.name .. ".before_render"
-  events.unsubscribe({
+  unsubscribe({
     event = events.BEFORE_RENDER,
     id = before_render_id,
   })
   if config.before_render then
     --convert to new event system
-    events.subscribe({
+    subscribe({
       event = events.BEFORE_RENDER,
       handler = function(state)
         local this_state = get_state()
@@ -297,7 +326,7 @@ M.setup = function(config, global_config)
       id = before_render_id,
     })
   elseif global_config.enable_git_status then
-    events.subscribe({
+    subscribe({
       event = events.BEFORE_RENDER,
       handler = function(state)
         local this_state = get_state()
@@ -321,37 +350,37 @@ M.setup = function(config, global_config)
     id = "filesystem." .. events.FS_EVENT,
   }
   if config.use_libuv_file_watcher then
-    events.unsubscribe(buf_watcher)
-    events.subscribe(fs_watcher)
+    unsubscribe(buf_watcher)
+    subscribe(fs_watcher)
   else
-    events.unsubscribe(fs_watcher)
+    unsubscribe(fs_watcher)
     require("neo-tree.sources.filesystem.lib.fs_watch").unwatch_all()
-    events.subscribe(buf_watcher)
+    subscribe(buf_watcher)
   end
 
   --Configure event handlers for cwd changes
   if default_config.bind_to_cwd then
-    events.subscribe({
+    subscribe({
       event = events.VIM_DIR_CHANGED,
       handler = M.dir_changed,
       id = "filesystem." .. events.VIM_DIR_CHANGED,
     })
   else
-    events.unsubscribe({
+    unsubscribe({
       event = events.VIM_DIR_CHANGED,
       id = "filesystem." .. events.VIM_DIR_CHANGED,
     })
   end
 
   --Configure event handlers for lsp diagnostic updates
   if global_config.enable_diagnostics then
-    events.subscribe({
+    subscribe({
       event = events.VIM_DIAGNOSTIC_CHANGED,
       handler = M.diagnostics_changed,
       id = "filesystem." .. events.VIM_DIAGNOSTIC_CHANGED,
     })
   else
-    events.unsubscribe({
+    unsubscribe({
       event = events.VIM_DIAGNOSTIC_CHANGED,
       id = "filesystem." .. events.VIM_DIAGNOSTIC_CHANGED,
     })
diff --git a/lua/neo-tree/sources/filesystem/lib/fs_scan.lua b/lua/neo-tree/sources/filesystem/lib/fs_scan.lua
@@ -66,14 +66,8 @@ local function do_scan(context, path_to_scan)
 end
 
 M.get_items_async = function(state, parent_id, path_to_reveal, callback)
-  if state.use_libuv_file_watcher and state.tree then
-    -- unwatch any folders that were previously being watched
-    local loaded_folders = renderer.select_nodes(state.tree, function(node)
-      return node.type == "directory" and node.loaded
-    end)
-    for _, folder in ipairs(loaded_folders) do
-      fs_watch.unwatch_folder(folder.link_to or folder:get_id())
-    end
+  if not parent_id then
+    M.stop_watchers(state)
   end
   local context = file_items.create_context(state)
 
@@ -149,4 +143,17 @@ M.get_items_async = function(state, parent_id, path_to_reveal, callback)
   end
 end
 
+M.stop_watchers = function(state)
+  if state.use_libuv_file_watcher and state.tree then
+    -- We are loaded a new root or refreshing, unwatch any folders that were
+    -- previously being watched.
+    local loaded_folders = renderer.select_nodes(state.tree, function(node)
+      return node.type == "directory" and node.loaded
+    end)
+    for _, folder in ipairs(loaded_folders) do
+      fs_watch.unwatch_folder(folder.link_to or folder:get_id())
+    end
+  end
+end
+
 return M
diff --git a/lua/neo-tree/sources/filesystem/lib/fs_watch.lua b/lua/neo-tree/sources/filesystem/lib/fs_watch.lua
