feat: allow overriding switchbuf for a single jump

Author: igorlfs

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

@@ -15,3 +15,7 @@ For instance, with `useopen,newtab`, if the buffer is not found in the current t
 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.
+
+## Force Behavior
+
+Sometimes, having a custom `switchbuf` is not enough. In these scenarios, you can override your own setting by using `<C-w><CR>` to bring a list with all available options, affecting only the current jump.

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

@@ -44,6 +44,8 @@ The help window itself has only 1 mapping: it can be closed with `q`.
 | **Help**                                              |
 |    `q` | Close                                        |
 
+Additionally, when jumping to a frame or breakpoint you can use `<C-w><CR>` to pick a specific [jump behavior](advanced-switchbuf#).
+
 `nvim-dap-view` doesn't define any keybindings outside its own buffers: you have to create your own bindings to call `open`, `close` or `toggle` and other API [functions](api) (or [commands](commands)).
 
 [^1]: Read `:help lua-pattern` to learn more. You can also read the full documentation [here](https://www.lua.org/pil/20.2.html).

lua/dap-view/threads/actions.lua

@@ -8,11 +8,12 @@ local M = {}
 local log = vim.log.levels
 
 ---@param lnum number
-M.jump_or_noop = function(lnum)
+---@param switchbuffun? dapview.SwitchBufFun
+M.jump_and_set_frame = function(lnum, switchbuffun)
     local line = vim.fn.getline(".")
 
     if string.find(line, "\t") then
-        util.jump_to_location("^\t(.-)|(%d+)|")
+        util.jump_to_location("^\t(.-)|(%d+)|", nil, switchbuffun)
 
         local frame = state.frames_by_line[lnum]
         if frame then

lua/dap-view/views/keymaps/help.lua

@@ -34,12 +34,12 @@ M.show_help = function()
         "   `o`  Trigger actions",
         "   `s`  Set the value of an expression",
         "### Threads",
-        "`<CR>`  Jump to a frame",
+        "`<CR>`  Jump to a frame. Use `<C-w><CR>` to force a specific behavior.",
         "   `t`  Toggle subtle frames",
         "   `f`  Filter frames (via Lua patterns)",
         "   `o`  Omit results matching filter (invert filter)",
         "### Breakpoints",
-        "`<CR>`  Jump to a breakpoint",
+        "`<CR>`  Jump to a breakpoint. Use `<C-w><CR>` to force a specific behavior.",
         "   `d`  Delete a breakpoint",
         "### Watches",
         "`<CR>`  Expand or collapse a variable",

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

@@ -22,7 +22,7 @@ M.set_keymaps = function(buf)
     end, buf)
 
     if not buf then
-        require("dap-view.views.keymaps.views").views_keysmps()
+        require("dap-view.views.keymaps.views").views_keymaps()
     end
 
     keymap("g?", function()

lua/dap-view/views/keymaps/views.lua

@@ -1,19 +1,21 @@
 local state = require("dap-view.state")
 local watches_actions = require("dap-view.watches.actions")
+local setup = require("dap-view.setup")
 local keymap = require("dap-view.views.keymaps.util").keymap
+local switchbuf = require("dap-view.views.windows.switchbuf")
 
 local M = {}
 
 local api = vim.api
 
-M.views_keysmps = function()
+M.views_keymaps = function()
     keymap("<CR>", function()
         local cursor_line = api.nvim_win_get_cursor(state.winnr)[1]
 
         if state.current_section == "breakpoints" then
             require("dap-view.views.util").jump_to_location("^(.-)|(%d+)|")
         elseif state.current_section == "threads" then
-            require("dap-view.threads.actions").jump_or_noop(cursor_line)
+            require("dap-view.threads.actions").jump_and_set_frame(cursor_line)
         elseif state.current_section == "exceptions" then
             require("dap-view.exceptions.actions").toggle_exception_filter()
         elseif state.current_section == "scopes" or state.current_section == "sessions" then
@@ -29,6 +31,42 @@ M.views_keysmps = function()
         end
     end)
 
+    keymap("<C-w><CR>", function()
+        if state.current_section == "breakpoints" or state.current_section == "threads" then
+            local options = vim.iter(switchbuf.switchbuf_winfn):fold({}, function(acc, k, v)
+                acc[#acc + 1] = { label = k, cb = v }
+                return acc
+            end)
+
+            if type(setup.config.switchbuf) == "function" then
+                options[#options + 1] = { label = "custom", cb = setup.config.switchbuf }
+            end
+
+            local cursor_line = api.nvim_win_get_cursor(state.winnr)[1]
+
+            vim.ui.select(
+                options,
+                {
+                    prompt = "Specify jump behavior: ",
+                    ---@param item {label: string}
+                    format_item = function(item)
+                        return item.label
+                    end,
+                },
+                ---@param choice {label: string, cb: dapview.SwitchBufFun}?
+                function(choice)
+                    if choice ~= nil then
+                        if state.current_section == "breakpoints" then
+                            require("dap-view.views.util").jump_to_location("^(.-)|(%d+)|", nil, choice.cb)
+                        elseif state.current_section == "threads" then
+                            require("dap-view.threads.actions").jump_and_set_frame(cursor_line, choice.cb)
+                        end
+                    end
+                end
+            )
+        end
+    end)
+
     keymap("o", function()
         if state.current_section == "scopes" then
             require("dap.ui").trigger_actions()

lua/dap-view/views/util.lua

@@ -42,7 +42,8 @@ end
 
 ---@param pattern string
 ---@param column? integer
-M.jump_to_location = function(pattern, column)
+---@param switchbuffun? dapview.SwitchBufFun
+M.jump_to_location = function(pattern, column, switchbuffun)
     local bufnr, line_num = unpack(M.get_bufnr(pattern) or {})
 
     if bufnr == nil then
@@ -51,9 +52,16 @@ M.jump_to_location = function(pattern, column)
 
     local config = setup.config
 
-    local win = window.get_win_respecting_switchbuf(config.switchbuf, bufnr)
+    ---@type integer?
+    local win
 
-    if not win then
+    if switchbuffun then
+        win = window.get_win_respecting_switchbuf(switchbuffun, bufnr)
+    else
+        win = window.get_win_respecting_switchbuf(config.switchbuf, bufnr)
+    end
+
+    if win == nil then
         local windows = config.windows
 
         win = api.nvim_open_win(0, true, {