feat: multi session support

Author: igorlfs

lua/dap-view/console/init.lua

@@ -0,0 +1,23 @@
+local state = require("dap-view.state")
+local winbar = require("dap-view.options.winbar")
+
+local M = {}
+
+local api = vim.api
+
+---@param winnr integer
+M.setup_console = function(winnr)
+    api.nvim_win_call(winnr, function()
+        local term_bufnr = state.term_bufnrs[state.current_session_id]
+
+        api.nvim_set_current_buf(term_bufnr)
+
+        require("dap-view.term.options").set_options(winnr, term_bufnr)
+
+        winbar.set_winbar_action_keymaps(term_bufnr)
+
+        winbar.update_section("console")
+    end)
+end
+
+return M

lua/dap-view/events.lua

@@ -10,40 +10,40 @@ local term = require("dap-view.term.init")
 local eval = require("dap-view.watches.eval")
 local setup = require("dap-view.setup")
 local winbar = require("dap-view.options.winbar")
+local util = require("dap-view.util")
+local console = require("dap-view.console")
 
 local SUBSCRIPTION_ID = "dap-view"
 
 dap.listeners.before.initialize[SUBSCRIPTION_ID] = function(session, _)
-    local adapter = session.config.type
-    -- When initializing a new session, there might a leftover terminal buffer
-    -- Usually, this wouldn't be a problem, but it can cause inconsistencies when starting a session that
-    --
-    -- (A) Doesn't use the terminal, after a session that does
-    -- The problem here is that the terminal could be used if it was left open from the earlier session
-    --
-    -- (B) Uses the terminal, after a session that doesn't
-    -- The terminal wouldn't show up, since it's hidden
-    --
-    -- To handle these scenarios, we have to delete the terminal buffer
-    -- However, if we always close the terminal, dap-view will be shifted very quickly (if open),
-    -- causing a flickering effect.
-    --
-    -- To address that, we only delete the terminal buffer if the new session has a different adapter
-    -- (which should cover most scenarios where the flickering would occur)
-    --
-    -- However, do not try to delete the buffer on the first session,
-    -- as it conflicts with bootstrapping the terminal window.
-    -- See: https://github.com/igorlfs/nvim-dap-view/issues/18
-    if state.last_active_adapter and state.last_active_adapter ~= adapter then
-        term.force_delete_term_buf()
+    state.current_adapter = session.config.type
+    state.current_session_id = session.id
+
+    if state.fallback_term_bufnr then
+        state.term_bufnrs[state.current_session_id] = state.fallback_term_bufnr
+        state.fallback_term_bufnr = nil
     end
-    state.last_active_adapter = adapter
 
     term.setup_term_win_cmd()
 
+    dap.defaults.fallback.terminal_win_cmd = function()
+        local term_bufnr = state.term_bufnrs[state.current_session_id]
+
+        assert(term_bufnr, "Failed to get term bufnr")
+
+        return term_bufnr
+    end
+
     local separate_term_win = not vim.tbl_contains(setup.config.winbar.sections, "console")
-    if not setup.config.windows.terminal.start_hidden and separate_term_win then
-        term.open_term_buf_win()
+
+    local is_console = state.current_section == "console"
+
+    if not setup.config.windows.terminal.start_hidden then
+        if separate_term_win then
+            term.open_term_buf_win()
+        elseif util.is_win_valid(state.winnr) and is_console then
+            console.setup_console(state.winnr)
+        end
     end
 end
 
@@ -78,6 +78,24 @@ dap.listeners.after.stackTrace[SUBSCRIPTION_ID] = function()
     end
 end
 
+dap.listeners.after.event_stopped[SUBSCRIPTION_ID] = function(session)
+    state.current_session_id = session.id
+
+    local separate_term_win = not vim.tbl_contains(setup.config.winbar.sections, "console")
+    local is_console = state.current_section == "console"
+
+    local cond_main_win = not separate_term_win and util.is_win_valid(state.winnr) and is_console
+    local cond_term_win = separate_term_win and util.is_win_valid(state.term_winnr)
+
+    local winnr = separate_term_win and state.term_winnr or state.winnr
+
+    if winnr and (cond_main_win or cond_term_win) then
+        console.setup_console(winnr)
+    end
+
+    winbar.redraw_controls()
+end
+
 dap.listeners.after.setExpression[SUBSCRIPTION_ID] = function()
     eval.reeval()
 end
@@ -107,6 +125,8 @@ dap.listeners.after.initialize[SUBSCRIPTION_ID] = function(session, _)
 end
 
 dap.listeners.after.event_terminated[SUBSCRIPTION_ID] = function()
+    state.current_session_id = nil
+
     -- Refresh threads view on exit to avoid showing outdated trace
     if state.current_section == "threads" then
         threads.show()
@@ -115,12 +135,16 @@ dap.listeners.after.event_terminated[SUBSCRIPTION_ID] = function()
     winbar.redraw_controls()
 end
 
+dap.listeners.after.disconnect[SUBSCRIPTION_ID] = function()
+    state.current_session_id = nil
+
+    winbar.redraw_controls()
+end
+
 --- Refresh winbar on dap session state change events not having a dedicated event handler
 local events = {
     "continue",
-    "disconnect",
     "event_exited",
-    "event_stopped",
     "restart",
     "threads",
 }

lua/dap-view/options/winbar.lua

@@ -2,6 +2,7 @@ local state = require("dap-view.state")
 local setup = require("dap-view.setup")
 local controls = require("dap-view.options.controls")
 local statusline = require("dap-view.util.statusline")
+local util = require("dap-view.util")
 local module = ...
 
 local M = {}
@@ -69,21 +70,29 @@ local winbar_info = {
         keymap = "C",
         action = function()
             if vim.tbl_contains(setup.config.winbar.sections, "console") then
-                if not state.winnr or not api.nvim_win_is_valid(state.winnr) then
+                if not util.is_win_valid(state.winnr) then
                     return
                 end
 
-                if not state.term_bufnr then
-                    require("dap-view.term.init").setup_term_win_cmd()
+                local term_bufnr = state.term_bufnrs[state.current_session_id]
+
+                if not term_bufnr then
+                    term_bufnr = require("dap-view.term.init").setup_term_win_cmd()
+                end
+
+                if not util.is_buf_valid(term_bufnr) then
+                    vim.notify("Something went wrong when setting up the terminal buffer")
+                    return
                 end
 
                 api.nvim_win_call(state.winnr, function()
-                    api.nvim_set_current_buf(state.term_bufnr)
+                    api.nvim_set_current_buf(term_bufnr)
                 end)
 
-                require("dap-view.term.options").set_options(state.winnr, state.term_bufnr)
+                require("dap-view.term.options").set_options(state.winnr, term_bufnr)
+
+                M.set_winbar_action_keymaps(term_bufnr)
 
-                M.set_winbar_action_keymaps(state.term_bufnr)
                 M.update_section("console")
             end
         end,

lua/dap-view/state.lua

@@ -25,11 +25,13 @@
 ---@class dapview.State
 ---@field bufnr? integer
 ---@field winnr? integer
----@field term_bufnr? integer
+---@field term_bufnrs {[number]: number}
+---@field fallback_term_bufnr? integer
 ---@field term_winnr? integer
----@field last_active_adapter? string
+---@field current_adapter? string
 ---@field subtle_frames boolean
 ---@field current_section? dapview.SectionType
+---@field current_session_id? number
 ---@field exceptions_options dapview.ExceptionsOption[]
 ---@field threads dapview.ThreadWithErr[]
 ---@field threads_err? string
@@ -38,6 +40,7 @@
 ---@field variables_by_line table<integer, {response: dap.Variable, reference: number}>
 ---@field watched_expressions table<string, dapview.ExpressionPack>
 local M = {
+    term_bufnrs = {},
     exceptions_options = {},
     threads = {},
     frames_by_line = {},

lua/dap-view/term/init.lua

@@ -1,38 +1,37 @@
 local dap = require("dap")
 
 local state = require("dap-view.state")
-local autocmd = require("dap-view.options.autocmd")
 local setup = require("dap-view.setup")
+local util = require("dap-view.util")
 
 local M = {}
 
 local api = vim.api
 
 ---Hide the term win, does not affect the term buffer
 M.hide_term_buf_win = function()
-    if state.term_winnr and api.nvim_win_is_valid(state.term_winnr) then
+    if util.is_win_valid(state.term_winnr) then
         api.nvim_win_hide(state.term_winnr)
     end
 end
 
-M.force_delete_term_buf = function()
-    if state.term_bufnr then
-        api.nvim_buf_delete(state.term_bufnr, { force = true })
-    end
-end
-
 ---Open the term buf in a new window if
 ---I. A session is active
----II. The term buf exists
+---II. There's term term buf
 ---III. The adapter isn't configured to be hidden
 ---IV. There's no term win or it is invalid
 ---@return integer?
 M.open_term_buf_win = function()
     local windows_config = setup.config.windows
-    local term_config = windows_config.terminal
-    local should_term_be_hidden = vim.tbl_contains(term_config.hide, state.last_active_adapter)
+    local term_config = setup.config.windows.terminal
+    local should_term_be_hidden = vim.tbl_contains(term_config.hide, state.current_adapter)
 
-    if dap.session() and state.term_bufnr and not should_term_be_hidden then
+    if not state.current_session_id then
+        return nil
+    end
+    local term_bufnr = state.term_bufnrs[state.current_session_id]
+
+    if term_bufnr and not should_term_be_hidden then
         if not state.term_winnr or state.term_winnr and not api.nvim_win_is_valid(state.term_winnr) then
             local is_win_valid = state.winnr ~= nil and api.nvim_win_is_valid(state.winnr)
 
@@ -45,36 +44,41 @@ M.open_term_buf_win = function()
                     or term_config.width,
             })
 
-            require("dap-view.term.options").set_options(state.term_winnr, state.term_bufnr)
+            require("dap-view.term.options").set_options(state.term_winnr, term_bufnr)
         end
     end
 
     return state.term_winnr
 end
 
-local quit_term_buf = function()
-    if state.term_bufnr then
-        state.term_bufnr = nil
+---Create the term buf and setup nvim-dap's
+M.setup_term_win_cmd = function()
+    -- Can't use an unlisted term buffers
+    -- See https://github.com/igorlfs/nvim-dap-view/pull/37#issuecomment-2785076872
+    --
+
+    local session = dap.session()
+    if session then
+        state.current_session_id = session.id
     end
-end
 
----Create the term buf and setup nvim-dap's `terminal_win_cmd` to use it
-M.setup_term_win_cmd = function()
-    if not state.term_bufnr then
-        -- Can't use an unlisted buffer here
-        -- See https://github.com/igorlfs/nvim-dap-view/pull/37#issuecomment-2785076872
-        state.term_bufnr = api.nvim_create_buf(true, false)
+    if not state.current_session_id and not state.fallback_term_bufnr then
+        state.fallback_term_bufnr = api.nvim_create_buf(true, false)
+
+        return state.fallback_term_bufnr
+    end
 
-        assert(state.term_bufnr ~= 0, "Failed to create nvim-dap-view buffer")
+    local term_bufnr = state.term_bufnrs[state.current_session_id]
 
-        autocmd.quit_buf_autocmd(state.term_bufnr, quit_term_buf)
+    vim.print(term_bufnr)
 
-        dap.defaults.fallback.terminal_win_cmd = function()
-            assert(state.term_bufnr, "Failed to get term bufnr")
+    if not term_bufnr then
+        term_bufnr = api.nvim_create_buf(true, false)
 
-            return state.term_bufnr
-        end
+        state.term_bufnrs[state.current_session_id] = term_bufnr
     end
+
+    return term_bufnr
 end
 
 return M

lua/dap-view/util/init.lua

@@ -1,10 +1,22 @@
 local M = {}
 
+local api = vim.api
+
 M.inverted_directions = {
     ["above"] = "below",
     ["below"] = "above",
     ["right"] = "left",
     ["left"] = "right",
 }
 
+---@param bufnr integer
+M.is_buf_valid = function(bufnr)
+    return bufnr and api.nvim_buf_is_valid(bufnr)
+end
+
+---@param winnr integer
+M.is_win_valid = function(winnr)
+    return winnr and api.nvim_win_is_valid(winnr)
+end
+
 return M