feat: restore cursor position per view

igorlfs · igorlfs · commit e2adb2ac37e2 · 2025-06-07T12:31:28.000-03:00
diff --git a/docs/src/posts/highlight-groups.md b/docs/src/posts/highlight-groups.md
@@ -2,7 +2,7 @@
 title: Highlight Groups
 ---
 
-`nvim-dap-view` defines 28 highlight groups linked to (somewhat) reasonable defaults, but they may look odd with your colorscheme. If the links aren't defined, no highlighting will be applied. To fix that, you have to manually define the highlight groups (see `:h nvim_set_hl()`). Consider contributing to your colorscheme by sending a PR to add support to `nvim-dap-view`!
+`nvim-dap-view` defines 29 highlight groups linked to (somewhat) reasonable defaults, but they may look odd with your colorscheme. If the links aren't defined, no highlighting will be applied. To fix that, you have to manually define the highlight groups (see `:h nvim_set_hl()`). Consider contributing to your colorscheme by sending a PR to add support to `nvim-dap-view`!
 
 | Highlight Group                      | Default Link              |
 | ------------------------------------ | ------------------------- |
@@ -29,6 +29,7 @@ title: Highlight Groups
 | `NvimDapViewString`                  | String                    |
 | `NvimDapViewTabSelected`             | TabLineSel                |
 | `NvimDapViewTab`                     | TabLine                   |
+| `NvimDapViewThreadError`             | DiagnosticError           |
 | `NvimDapViewThreadStopped`           | Conditional               |
 | `NvimDapViewThread`                  | Tag                       |
 | `NvimDapViewWatchError`              | DiagnosticError           |
diff --git a/lua/dap-view/actions.lua b/lua/dap-view/actions.lua
@@ -87,7 +87,7 @@ end
 M.add_expr = function(expr)
     local final_expr = expr or require("dap-view.util.exprs").get_current_expr()
     if require("dap-view.watches.actions").add_watch_expr(final_expr) then
-        require("dap-view.views").switch_to_view(require("dap-view.watches.view").show)
+        require("dap-view.views").switch_to_view("watches")
     end
 end
 
diff --git a/lua/dap-view/autocmds.lua b/lua/dap-view/autocmds.lua
@@ -1,4 +1,5 @@
 local state = require("dap-view.state")
+local globals = require("dap-view.globals")
 local winbar = require("dap-view.options.winbar")
 
 local api = vim.api
@@ -69,3 +70,10 @@ api.nvim_create_autocmd("BufEnter", {
         end
     end,
 })
+
+api.nvim_create_autocmd("CursorMoved", {
+    pattern = globals.MAIN_BUF_NAME,
+    callback = function()
+        state.cur_pos[state.current_section] = api.nvim_win_get_cursor(state.winnr)[1]
+    end,
+})
diff --git a/lua/dap-view/breakpoints/view.lua b/lua/dap-view/breakpoints/view.lua
@@ -1,4 +1,3 @@
-local winbar = require("dap-view.options.winbar")
 local state = require("dap-view.state")
 local vendor = require("dap-view.breakpoints.vendor")
 local extmarks = require("dap-view.breakpoints.util.extmarks")
@@ -11,8 +10,6 @@ local M = {}
 local api = vim.api
 
 M.show = function()
-    winbar.update_section("breakpoints")
-
     if state.bufnr and state.winnr then
         local breakpoints = vendor.get()
 
@@ -22,8 +19,6 @@ M.show = function()
             return
         end
 
-        local cursor_line = api.nvim_win_get_cursor(state.winnr)[1]
-
         for buf, buf_entries in pairs(breakpoints) do
             local filename = api.nvim_buf_get_name(buf)
             local relative_path = vim.fn.fnamemodify(filename, ":.")
@@ -47,10 +42,6 @@ M.show = function()
             end
         end
 
-        if line > 0 then
-            api.nvim_win_set_cursor(state.winnr, { math.min(cursor_line, line), 1 })
-        end
-
         -- Clear previous content
         api.nvim_buf_set_lines(state.bufnr, line, -1, true, {})
     end
diff --git a/lua/dap-view/exceptions/view.lua b/lua/dap-view/exceptions/view.lua
@@ -1,6 +1,5 @@
 local dap = require("dap")
 
-local winbar = require("dap-view.options.winbar")
 local state = require("dap-view.state")
 local views = require("dap-view.views")
 local hl = require("dap-view.util.hl")
@@ -10,11 +9,7 @@ local M = {}
 local api = vim.api
 
 M.show = function()
-    winbar.update_section("exceptions")
-
     if state.bufnr and state.winnr then
-        local cursor_line = api.nvim_win_get_cursor(state.winnr)[1]
-
         if views.cleanup_view(not dap.session(), "No active session") then
             return
         end
@@ -38,8 +33,6 @@ M.show = function()
             local hl_type = opt.enabled and "Enabled" or "Disabled"
             hl.hl_range("ExceptionFilter" .. hl_type, { i - 1, 0 }, { i - 1, 4 })
         end
-
-        api.nvim_win_set_cursor(state.winnr, { math.min(cursor_line, #content), 1 })
     end
 end
 
diff --git a/lua/dap-view/highlight.lua b/lua/dap-view/highlight.lua
@@ -13,8 +13,10 @@ local define_base_links = function()
     hl_create("FileName", "qfFileName")
     hl_create("LineNumber", "qfLineNr")
     hl_create("Separator", "Comment")
+
     hl_create("Thread", "Tag")
     hl_create("ThreadStopped", "Conditional")
+    hl_create("ThreadError", "DiagnosticError")
 
     hl_create("ExceptionFilterEnabled", "DiagnosticOk")
     hl_create("ExceptionFilterDisabled", "DiagnosticError")
diff --git a/lua/dap-view/options/winbar.lua b/lua/dap-view/options/winbar.lua
@@ -13,39 +13,39 @@ local winbar_info = {
         keymap = "B",
         action = function()
             if vim.tbl_contains(setup.config.winbar.sections, "breakpoints") then
-                require("dap-view.views").switch_to_view(require("dap-view.breakpoints.view").show)
+                require("dap-view.views").switch_to_view("breakpoints")
             end
         end,
     },
     scopes = {
         keymap = "S",
         action = function()
             if vim.tbl_contains(setup.config.winbar.sections, "scopes") then
-                require("dap-view.views").switch_to_view(require("dap-view.scopes.view").show)
+                require("dap-view.views").switch_to_view("scopes")
             end
         end,
     },
     exceptions = {
         keymap = "E",
         action = function()
             if vim.tbl_contains(setup.config.winbar.sections, "exceptions") then
-                require("dap-view.views").switch_to_view(require("dap-view.exceptions.view").show)
+                require("dap-view.views").switch_to_view("exceptions")
             end
         end,
     },
     watches = {
         keymap = "W",
         action = function()
             if vim.tbl_contains(setup.config.winbar.sections, "watches") then
-                require("dap-view.views").switch_to_view(require("dap-view.watches.view").show)
+                require("dap-view.views").switch_to_view("watches")
             end
         end,
     },
     threads = {
         keymap = "T",
         action = function()
             if vim.tbl_contains(setup.config.winbar.sections, "threads") then
-                require("dap-view.views").switch_to_view(require("dap-view.threads.view").show)
+                require("dap-view.views").switch_to_view("threads")
             end
         end,
     },
diff --git a/lua/dap-view/state.lua b/lua/dap-view/state.lua
@@ -37,6 +37,7 @@
 ---@field expressions_by_line table<integer, {name: string, expression: dapview.ExpressionPack}>
 ---@field variables_by_line table<integer, {response: dap.Variable, reference: number}>
 ---@field watched_expressions table<string, dapview.ExpressionPack>
+---@field cur_pos table<dapview.SectionType,integer?>
 local M = {
     exceptions_options = {},
     threads = {},
@@ -45,6 +46,7 @@ local M = {
     variables_by_line = {},
     subtle_frames = false,
     watched_expressions = {},
+    cur_pos = {},
 }
 
 return M
diff --git a/lua/dap-view/threads/view.lua b/lua/dap-view/threads/view.lua
@@ -1,6 +1,5 @@
 local dap = require("dap")
 
-local winbar = require("dap-view.options.winbar")
 local views = require("dap-view.views")
 local state = require("dap-view.state")
 local hl = require("dap-view.util.hl")
@@ -10,8 +9,6 @@ local M = {}
 local api = vim.api
 
 M.show = function()
-    winbar.update_section("threads")
-
     if state.bufnr and state.winnr then
         local session = dap.session()
         -- Redundant check to appease the type checker
@@ -31,15 +28,17 @@ M.show = function()
             state.frames_by_line[k] = nil
         end
 
-        local cursor_line = api.nvim_win_get_cursor(state.winnr)[1]
-
         local line = 0
-        for _, thread in pairs(state.threads) do
-            api.nvim_buf_set_lines(state.bufnr, line, line, true, { thread.name })
 
+        for _, thread in pairs(state.threads) do
             local is_stopped_thread = session.stopped_thread_id == thread.id
+            local thread_name = is_stopped_thread and thread.name .. " " or thread.name
+            api.nvim_buf_set_lines(state.bufnr, line, line, true, { thread_name })
+
             hl.hl_range(is_stopped_thread and "ThreadStopped" or "Thread", { line, 0 }, { line, -1 })
 
+            line = line + 1
+
             local valid_frames = vim.iter(thread.frames or {})
                 :filter(
                     ---@param f dap.StackFrame
@@ -54,9 +53,9 @@ M.show = function()
             if vim.tbl_isempty(valid_frames) then
                 if thread.err then
                     api.nvim_buf_set_lines(state.bufnr, line, line, true, { thread.err })
+                    hl.hl_range("ThreadError", { line, 0 }, { line, -1 })
                     line = line + 1
                 end
-                line = line + 1
             else
                 local content = vim.iter(valid_frames):fold(
                     {},
@@ -75,7 +74,6 @@ M.show = function()
                         return acc
                     end
                 )
-                line = line + 1
 
                 api.nvim_buf_set_lines(state.bufnr, line, line + #content, false, content)
 
@@ -92,10 +90,6 @@ M.show = function()
             end
         end
 
-        if line > 0 then
-            api.nvim_win_set_cursor(state.winnr, { math.min(cursor_line, line), 1 })
-        end
-
         -- Clear previous content
         api.nvim_buf_set_lines(state.bufnr, line, -1, true, {})
     end
diff --git a/lua/dap-view/views/init.lua b/lua/dap-view/views/init.lua
@@ -1,39 +1,51 @@
 local state = require("dap-view.state")
+local winbar = require("dap-view.options.winbar")
 local hl = require("dap-view.util.hl")
 
 local M = {}
 
 local api = vim.api
 
----@param cond boolean
+---@param condition boolean
 ---@param message string
-M.cleanup_view = function(cond, message)
-    if cond and state.winnr then
+M.cleanup_view = function(condition, message)
+    assert(state.winnr ~= nil, "has nvim-dap-view window")
+
+    if condition then
         vim.wo[state.winnr][0].cursorline = false
 
         api.nvim_buf_set_lines(state.bufnr, 0, -1, false, { message })
 
         hl.hl_range("MissingData", { 0, 0 }, { 0, #message })
-    elseif state.winnr then
+    else
         vim.wo[state.winnr][0].cursorline = true
     end
 
-    return cond
+    return condition
 end
 
----@param callback fun(): nil
-M.switch_to_view = function(callback)
+---@param view dapview.SectionType
+M.switch_to_view = function(view)
     if not state.bufnr or not state.winnr or not api.nvim_win_is_valid(state.winnr) then
         return
     end
 
+    local cursor_line = state.cur_pos[view] or 1
+
     if vim.tbl_contains({ "repl", "console" }, state.current_section) then
         api.nvim_win_call(state.winnr, function()
             api.nvim_set_current_buf(state.bufnr)
         end)
     end
 
-    callback()
+    winbar.update_section(view)
+
+    require("dap-view." .. view .. ".view").show()
+
+    local buf_len = api.nvim_buf_line_count(state.bufnr)
+    state.cur_pos[view] = math.min(cursor_line, buf_len)
+
+    api.nvim_win_set_cursor(state.winnr, { state.cur_pos[view], 1 })
 end
 
 return M
diff --git a/lua/dap-view/watches/view.lua b/lua/dap-view/watches/view.lua
@@ -1,5 +1,4 @@
 local state = require("dap-view.state")
-local winbar = require("dap-view.options.winbar")
 local views = require("dap-view.views")
 local hl = require("dap-view.util.hl")
 
@@ -37,7 +36,7 @@ local function show_variables(children, reference, line, depth)
         local trimmed_content = content:gsub("%s+", " ")
 
         local indent = string.rep("\t", depth)
-        api.nvim_buf_set_lines(state.bufnr, line, line + 1, false, { indent .. trimmed_content })
+        api.nvim_buf_set_lines(state.bufnr, line, line, true, { indent .. trimmed_content })
 
         hl.hl_range("WatchExpr", { line, depth }, { line, depth + #variable.name })
 
@@ -55,7 +54,7 @@ local function show_variables(children, reference, line, depth)
         if var.expanded and var.children then
             if type(var.children) == "string" then
                 local err_content = string.rep("\t", depth + 1) .. var.children
-                api.nvim_buf_set_lines(state.bufnr, line, line + 1, false, { err_content })
+                api.nvim_buf_set_lines(state.bufnr, line, line, true, { err_content })
 
                 hl.hl_range("WatchError", { line, 0 }, { line, #err_content })
 
@@ -76,7 +75,7 @@ local show_variables_or_err = function(line, variables)
     local children = variables.children
     if type(children) == "string" then
         local var_content = "\t" .. variables
-        api.nvim_buf_set_lines(state.bufnr, line, line + 1, false, { var_content })
+        api.nvim_buf_set_lines(state.bufnr, line, line, true, { var_content })
 
         hl.hl_range("WatchError", { line, 0 }, { line, #var_content })
 
@@ -88,15 +87,16 @@ local show_variables_or_err = function(line, variables)
 end
 
 M.show = function()
-    winbar.update_section("watches")
-
     if not state.winnr or not api.nvim_win_is_valid(state.winnr) then
         return
     end
 
     if state.bufnr then
         local cursor_line = api.nvim_win_get_cursor(state.winnr)[1]
 
+        -- TODO this SHOULD NOT be necessary
+        -- Refactor the `eval` code so I can have a callback with this function
+        -- that triggers only when I'm done evaluating the whole tree
         views.cleanup_view(#state.watched_expressions == 0, "No expressions")
 
         -- Since variables aren't ordered, lines may change unexpectedly
@@ -110,6 +110,7 @@ M.show = function()
         end
 
         local line = 0
+
         for expr_name, expr in pairs(state.watched_expressions) do
             local response = expr.response
 
@@ -122,7 +123,7 @@ M.show = function()
             -- Can't have linebreaks with nvim_buf_set_lines
             local trimmed_content = content:gsub("%s+", " ")
 
-            api.nvim_buf_set_lines(state.bufnr, line, line + 1, false, { trimmed_content })
+            api.nvim_buf_set_lines(state.bufnr, line, line, true, { trimmed_content })
 
             hl.hl_range("WatchExpr", { line, 0 }, { line, #expr_name })
 
@@ -151,7 +152,7 @@ M.show = function()
             end
             api.nvim_buf_set_lines(state.bufnr, line, -1, true, content)
 
-            api.nvim_win_set_cursor(state.winnr, { cursor_line, 1 })
+            state.cur_pos["watches"] = api.nvim_win_set_cursor(state.winnr, { cursor_line, 1 })
         end
     end
 end
