WIP, start work on creating BaseSource to use class inheritence

Author: cseickel

lua/neo-tree.lua

@@ -268,7 +268,11 @@ M.setup = function(config)
 
   -- setup the sources with the combined config
   for _, source_name in ipairs(sources) do
-    src(source_name).setup(M.config[source_name], M.config)
+    if source_name == "filesystem" then
+      src(source_name):setup(M.config[source_name], M.config)
+    else
+      src(source_name).setup(M.config[source_name], M.config)
+    end
   end
 
   local event_handler = {

lua/neo-tree/sources/common/base_source.lua

@@ -7,30 +7,38 @@ 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 inputs = require("neo-tree.ui.inputs")
 
+local state_by_tab = {}
 local BaseSource = {}
+
 function BaseSource:new()
-  local props = {}
+  local props = { default_config = {} }
   setmetatable(props, self)
   self.__index = self
   return props
 end
 
-local default_config = nil
-local state_by_tab = {}
+function BaseSource:get_default_config()
+  return self.default_config
+end
 
-local get_state = function(tabnr)
+function BaseSource:set_default_config(config)
+  self.default_config = config
+end
+
+function BaseSource:get_state(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 = utils.table_copy(BaseSource:get_default_config())
     state.tabnr = tabnr
     state_by_tab[tabnr] = state
   end
   return state
 end
 
-local get_path_to_reveal = function()
+function BaseSource:get_path_to_reveal()
   if vim.bo.filetype == "neo-tree" then
     return nil
   end
@@ -41,31 +49,31 @@ local get_path_to_reveal = function()
   return path
 end
 
-BaseSource.subscribe = function(event)
-  local state = get_state()
+function BaseSource:subscribe(event)
+  local state = BaseSource: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()
+function BaseSource:unsubscribe(event, state)
+  state = state or BaseSource:get_state()
   if state.subscriptions then
     state.subscriptions[event] = false
   end
   events.unsubscribe(event)
 end
 
-BaseSource.close = function()
-  local state = get_state()
+function BaseSource:close()
+  local state = BaseSource: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()
+function BaseSource:diagnostics_changed(args)
+  local state = BaseSource:get_state()
   args = args or {}
   state.diagnostics_lookup = args.diagnostics_lookup
   if renderer.window_exists(state) then
@@ -74,48 +82,48 @@ BaseSource.diagnostics_changed = function(args)
 end
 
 ---Called by autocmds when the cwd dir is changed. This will change the root.
-BaseSource.dir_changed = function()
-  local state = get_state()
+function BaseSource:dir_changed()
+  local state = BaseSource: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)
+    BaseSource:navigate(cwd)
   end
 end
 
-BaseSource.dispose = function(tabnr)
-  local state = get_state(tabnr)
+function BaseSource:dispose(tabnr)
+  local state = BaseSource: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)
+      BaseSource:unsubscribe(event, state)
     end
   end
   state_by_tab[state.tabnr] = nil
 end
 
-BaseSource.float = function()
-  local state = get_state()
+function BaseSource:float()
+  local state = BaseSource:get_state()
   state.force_float = true
-  local path_to_reveal = get_path_to_reveal()
-  BaseSource.navigate(state.path, path_to_reveal)
+  local path_to_reveal = BaseSource: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()
+function BaseSource:focus(path_to_reveal, callback)
+  local state = BaseSource:get_state()
   if path_to_reveal then
-    BaseSource.navigate(state.path, path_to_reveal, callback)
+    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)
+      BaseSource:navigate(state.path, nil, callback)
     end
   end
 end
@@ -124,50 +132,82 @@ end
 ---@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()
+function BaseSource:navigate(path, path_to_reveal, callback)
+  local state = BaseSource: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!")
+function BaseSource:reveal_current_file(toggle_if_open)
+  log.trace("Revealing current file")
+  if toggle_if_open then
+    if BaseSource:close() then
+      -- It was open, and now it's not.
+      return
+    end
+  end
+  local state = BaseSource:get_state()
+  require("neo-tree").close_all_except(state.name)
+  local path = BaseSource:get_path_to_reveal()
+  if not path then
+    BaseSource:focus()
+    return
+  end
+  local cwd = state.path
+  if cwd == nil then
+    cwd = vim.fn.getcwd()
+  end
+  if string.sub(path, 1, string.len(cwd)) ~= cwd then
+    cwd, _ = utils.split_path(path)
+    inputs.confirm("File not in cwd. Change cwd to " .. cwd .. "?", function(response)
+      if response == true then
+        state.path = cwd
+        BaseSource:focus(path)
+      end
+    end)
+    return
+  end
+  if path then
+    if not renderer.focus_node(state, path) then
+      BaseSource:focus(path)
+    end
+  end
 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()
+function BaseSource:redraw()
+  local state = BaseSource: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()
+function BaseSource:refresh(callback)
+  local state = BaseSource: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)
+    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
+--wants to change from the defaults. BaseSource:y be empty to accept default values.
+function BaseSource:setup(config, global_config)
+  BaseSource:set_default_config(config)
+  local state = BaseSource:get_state()
   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)
+function BaseSource:show(callback)
+  local state = BaseSource:get_state()
+  BaseSource:navigate(state.path, nil, callback)
 end
 
 return BaseSource