feat: allow switchbuf to be a function

Author: igorlfs

docs/sidebar.ts

@@ -53,6 +53,10 @@ export const sidebar = {
             title: 'Recipes',
             collapsible: true,
             items: [
+                {
+                    title: "Advanced 'switchbuf'",
+                    to: '/advanced-switchbuf'
+                },
                 {
                     title: 'Hide Terminal',
                     to: '/hide-terminal'

docs/src/routes/advanced-switchbuf/+page.md

@@ -0,0 +1,17 @@
+---
+title: Advanced 'switchbuf'
+category: Recipes
+---
+
+You can tune the behavior of nvim-dap-view's jump to breakpoint and frame features, by using nvim-dap-view's own `switchbuf` config option. Similarly to the built-in option, you can combine different behaviors with a comma separated list. Available options include:
+
+- `newtab`: always creates a new tab
+- `useopen`: tries to find the buffer to jump to _only_ in the current tab
+- `usetab`: like `useopen`, but searches _every_ tab (**default**)
+- `uselast`: jump to the previously used window, if eligible
+
+For instance, with `useopen,newtab`, if the buffer is not found in the current tab, a new tab is created.
+
+For more advanced use cases, you can write your own `switchbuf` function. It receives 2 arguments: the _current_ window number and the buffer number _to jump to_. It should (optionally) return a window number for the jump's destination window.
+
+If a combination of options does not yield a valid window number for the destination (e.g., `useopen` but the buffer is hidden), there's a fallback to create a top-level split.

docs/src/routes/configuration/+page.md

@@ -138,6 +138,10 @@ return {
         border = nil,
     },
     -- Controls how to jump when selecting a breakpoint or navigating the stack
+    -- Comma separated list, like the built-in 'switchbuf'. See :help 'switchbuf'
+    -- Only a subset of the options is available: newtab, useopen, usetab and uselast
+    -- Can also be a function that takes the current winnr and the bufnr that will jumped to
+    -- If a function, should return the winnr of the destination window
     switchbuf = "usetab",
     -- Auto open when a session is started and auto close when all sessions finish
     auto_toggle = false,

lua/dap-view/config.lua

@@ -75,7 +75,7 @@ local M = {}
 ---@field windows dapview.WindowsConfig
 ---@field help dapview.HelpConfig
 ---@field icons dapview.IconsConfig Icons for each button
----@field switchbuf string Control how to jump when selecting a breakpoint or a call in the stack
+---@field switchbuf string|dapview.SwitchBufFun Control how to jump when selecting a breakpoint or a call in the stack
 ---@field auto_toggle boolean|"keep_terminal"
 ---@field follow_tab boolean Reopen dapview when switching tabs
 

lua/dap-view/setup/validate/init.lua

@@ -6,7 +6,7 @@ function M.validate(config)
         windows = { config.windows, "table" },
         winbar = { config.winbar, "table" },
         help = { config.help, "table" },
-        switchbuf = { config.switchbuf, "string" },
+        switchbuf = { config.switchbuf, { "string", "function" } },
         icons = { config.icons, "table" },
         auto_toggle = { config.auto_toggle, { "boolean", "string" } },
         follow_tab = { config.follow_tab, "boolean" },

lua/dap-view/util/exprs.lua

@@ -29,7 +29,7 @@ M.get_trimmed_selection = function()
     end
 
     -- EmmyLuaLs is not smart enough to infer that #lines > 1
-    -- It alsoe does not care about assertting that #lines > 1
+    -- It also does not care about asserting that #lines > 1
     lines[1] = string.sub(lines[1], start_col)
     lines[#lines] = string.sub(lines[#lines], 1, finish_col)
 

lua/dap-view/views/util.lua

@@ -51,15 +51,16 @@ M.jump_to_location = function(pattern, column)
 
     local config = setup.config
 
-    local switchbufopt = config.switchbuf
-    local win = window.get_win_respecting_switchbuf(switchbufopt, bufnr)
+    local win = window.get_win_respecting_switchbuf(config.switchbuf, bufnr)
 
     if not win then
+        local windows = config.windows
+
         win = api.nvim_open_win(0, true, {
-            split = util.inverted_directions[config.windows.position],
+            split = util.inverted_directions[windows.position],
             win = -1,
-            height = config.windows.height < 1 and math.floor(vim.go.lines * (1 - config.windows.height))
-                or math.floor(vim.go.lines - config.windows.height),
+            height = windows.height < 1 and math.floor(vim.go.lines * (1 - windows.height))
+                or math.floor(vim.go.lines - windows.height),
         })
     end
 

lua/dap-view/views/windows/init.lua

@@ -4,13 +4,17 @@ local M = {}
 
 local api = vim.api
 
----@param switchbufopt string
+---@param switchbufopt string|dapview.SwitchBufFun
 ---@param bufnr integer
 M.get_win_respecting_switchbuf = function(switchbufopt, bufnr)
     local winnr = api.nvim_get_current_win()
 
     local switchbuf_winfn = switchbuf.switchbuf_winfn
 
+    if type(switchbufopt) == "function" then
+        return switchbufopt(bufnr, winnr)
+    end
+
     if switchbufopt:find("usetab") then
         switchbuf_winfn.useopen = switchbuf_winfn.usetab
     end

lua/dap-view/views/windows/switchbuf.lua

@@ -2,7 +2,9 @@ local M = {}
 
 local api = vim.api
 
----@type table<string, fun(bufnr: integer, winnr: integer): integer?>
+---@alias dapview.SwitchBufFun fun(bufnr: integer, winnr: integer): (integer?)
+
+---@type table<string, dapview.SwitchBufFun>
 M.switchbuf_winfn = {}
 
 M.switchbuf_winfn.newtab = function(bufnr)