Adapt REPL/line rendering for multi-line promptbuf changes

Author: mfussenegger

lua/dap/repl.lua

@@ -20,6 +20,19 @@ end
 local execute  -- required for forward reference
 
 
+---@param buf integer
+local function line_count(buf)
+  assert(vim.bo[buf].buftype == "prompt", "buf must have buftype=prompt")
+  if vim.fn.has("nvim-0.12") == 1 then
+    local ok, mark = pcall(api.nvim_buf_get_mark, buf, ":")
+    if ok then
+      return mark[1] - 1
+    end
+  end
+  return api.nvim_buf_line_count(buf) - 1
+end
+
+
 local function new_buf()
   local prev_buf = api.nvim_get_current_buf()
   local buf = api.nvim_create_buf(true, true)
@@ -79,7 +92,7 @@ local function new_buf()
         local active_buf = api.nvim_win_get_buf(0)
         if active_buf == buf then
           local lnum = api.nvim_win_get_cursor(0)[1]
-          autoscroll = lnum == api.nvim_buf_line_count(buf)
+          autoscroll = lnum >= line_count(buf)
         end
       end
     })
@@ -189,7 +202,7 @@ end
 
 local function evaluate_handler(err, resp)
   if err then
-    M.append(tostring(err), nil, { newline = false })
+    M.append(tostring(err), nil, { newline = true })
     return
   end
   local layer = ui.layer(repl.buf)
@@ -201,16 +214,15 @@ local function evaluate_handler(err, resp)
     -- Appending twice would result in a intermediate "dap> " prompt
     -- To avoid that this eagerly fetches the children; pre-renders the region
     -- and lets tree.render override it
-    local lnum = api.nvim_buf_line_count(repl.buf) - 1
     if spec.has_children(resp) then
       spec.fetch_children(resp, function()
-        tree.render(layer, resp, nil, lnum, -1)
+        tree.render(layer, resp, nil)
       end)
     else
-      tree.render(layer, resp, nil, lnum, -1)
+      tree.render(layer, resp, nil)
     end
   else
-    M.append(resp.result, nil, { newline = false })
+    M.append(resp.result, nil, { newline = true })
   end
 end
 
@@ -383,8 +395,8 @@ end
 ---@param text string
 ---@param opts? dap.repl.execute.Opts
 function M.execute(text, opts)
-  M.append(prompt .. text .. "\n", "$", { newline = true })
-  local numlines = api.nvim_buf_line_count(repl.buf)
+  M.append(prompt .. text, "$", { newline = true })
+  local numlines = line_count(repl.buf)
   if repl.win and api.nvim_win_is_valid(repl.win) then
     pcall(api.nvim_win_set_cursor, repl.win, { numlines, 0 })
     api.nvim_win_call(repl.win, function()
@@ -449,6 +461,7 @@ function M.on_down()
 end
 
 
+
 ---@param line string
 ---@param lnum (integer|string)?
 ---@param opts? {newline: boolean}
@@ -460,22 +473,22 @@ function M.append(line, lnum, opts)
   end
   local lines = vim.split(line, '\n')
   if lnum == '$' or not lnum then
-    lnum = api.nvim_buf_line_count(buf) - 1
+    lnum = line_count(buf)
     if opts.newline == false then
-      local last_line = api.nvim_buf_get_lines(buf, -2, -1, true)[1]
-      local insert_pos = #last_line
+      local last_line = api.nvim_buf_get_lines(buf, lnum, lnum + 1, true)[1]
+      local insert_pos = last_line ~= nil and #last_line or 0
       if last_line == prompt then
         -- insert right in front of the empty prompt
         insert_pos = 0
         if lines[#lines] ~= '' then
           table.insert(lines, #lines + 1, '')
         end
-      elseif vim.startswith(last_line, prompt) then
+      elseif vim.startswith(last_line or "", prompt) then
         table.insert(lines, 1, '')
       end
       api.nvim_buf_set_text(buf, lnum, insert_pos, lnum, insert_pos, lines)
     else
-      api.nvim_buf_set_lines(buf, -1, -1, true, lines)
+      api.nvim_buf_set_lines(buf, lnum, lnum, true, lines)
     end
   elseif type(lnum) == "number" then
     api.nvim_buf_set_lines(buf, lnum, lnum, true, lines)

lua/dap/ui.lua

@@ -216,7 +216,7 @@ function M.new_tree(opts)
     }
     context = vim.tbl_deep_extend('keep', context, extra_context)
     for _, child in pairs(opts.get_children(value)) do
-      layer.render({child}, with_indent(indent, opts.render_child), context, -1)
+      layer.render({child}, with_indent(indent, opts.render_child), context)
       if is_expanded(child) then
         render_all_expanded(layer, child, indent + 2)
       end
@@ -426,6 +426,21 @@ end
 ---@field item any
 ---@field context table|nil
 
+
+---@param buf integer
+local function line_count(buf)
+  if vim.bo[buf].buftype ~= "prompt" then
+    return api.nvim_buf_line_count(buf)
+  end
+  if vim.fn.has("nvim-0.12") == 1 then
+    local ok, mark = pcall(api.nvim_buf_get_mark, buf, ":")
+    if ok then
+      return mark[1] - 1
+    end
+  end
+  return api.nvim_buf_line_count(buf) - 1
+end
+
 --- Returns a layer, creating it if it's missing.
 ---@param buf integer
 ---@return dap.ui.Layer
@@ -473,7 +488,7 @@ function M.layer(buf)
       local modifiable = vim.bo[buf].modifiable
       vim.bo[buf].modifiable = true
       if not start and not end_ then
-        start = api.nvim_buf_line_count(buf)
+        start = line_count(buf)
         -- Avoid inserting a new line at the end of the buffer
         -- The case of no lines and one empty line are ambiguous;
         -- set_lines(buf, 0, 0) would "preserve" the "empty buffer line" while set_lines(buf, 0, -1) replaces it
@@ -485,7 +500,7 @@ function M.layer(buf)
           end_ = start
         end
       else
-        start = start or (api.nvim_buf_line_count(buf) - 1)
+        start = start or (line_count(buf) - 1)
         end_ = end_ or start
       end
       render_fn = render_fn or tostring
@@ -499,7 +514,7 @@ function M.layer(buf)
       local lines = vim.tbl_map(function() return '' end, xs)
       api.nvim_buf_set_lines(buf, start, end_, true, lines)
       if start == -1 then
-        start = api.nvim_buf_line_count(buf) - #lines
+        start = line_count(buf) - #lines
       end
 
       for i = start, start + #lines - 1 do

spec/repl_spec.lua

@@ -50,6 +50,16 @@ local function getcompletion_results(server)
 end
 
 
+---@param buf integer
+---@param lnum integer
+local function assert_prompt_mark(buf, lnum)
+  if vim.fn.has("nvim-0.12") == 1 then
+    local prompt_mark = api.nvim_buf_get_mark(buf, ":")
+    assert.are.same(lnum, prompt_mark[1], "prompt mark expected to be in line " .. tostring(lnum))
+  end
+end
+
+
 describe('dap.repl', function()
   local server
   before_each(function()
@@ -68,20 +78,26 @@ describe('dap.repl', function()
     local buf = repl.open()
     repl.append('foo', nil, { newline = false })
     repl.append('bar', nil, { newline = false })
+    assert_prompt_mark(buf, 1)
     repl.append('\nbaz\n', nil, { newline = false })
 
     local lines = api.nvim_buf_get_lines(buf, 0, -1, true)
     assert.are.same({'foobar', 'baz', ''}, lines)
+    assert_prompt_mark(buf, 3)
   end)
 
   it("adds newline with newline = true", function()
     local buf = repl.open()
+    assert_prompt_mark(buf, 1)
     repl.append("foo", nil, { newline = true })
+    assert_prompt_mark(buf, 2)
     repl.append("bar", nil, { newline = true })
+    assert_prompt_mark(buf, 3)
     repl.append("\nbaz\n", nil, { newline = true })
+    assert_prompt_mark(buf, 6)
 
     local lines = api.nvim_buf_get_lines(buf, 0, -1, true)
-    assert.are.same({"", "foo", "bar", "", "baz", ""}, lines)
+    assert.are.same({"foo", "bar", "", "baz", "", ""}, lines)
   end)
 
   it("repl.execute inserts text and executes it, shows result", function()
@@ -98,12 +114,18 @@ describe('dap.repl', function()
     repl.execute("1 + 1")
     local commands = helpers.wait_for_response(server, "evaluate")
     assert.are.same({"initialize", "launch", "evaluate"}, commands)
-    helpers.wait(function()
-      local lines = api.nvim_buf_get_lines(buf, 0, -1, true)
-      return lines[3] == "2"
-    end)
+    helpers.wait(
+      function()
+        local lines = api.nvim_buf_get_lines(buf, 0, -1, true)
+        return lines[2] == "2"
+      end,
+      function()
+        return api.nvim_buf_get_lines(buf, 0, -1, true)
+      end
+    )
     local lines = api.nvim_buf_get_lines(buf, 0, -1, true)
-    assert.are.same({"", "dap> 1 + 1", "2"}, lines)
+    assert.are.same({"dap> 1 + 1", "2", ""}, lines)
+    assert_prompt_mark(buf, 3)
   end)
   it("repl.execute shows structured results", function()
     server = require("spec.server").spawn()
@@ -138,21 +160,47 @@ describe('dap.repl', function()
     helpers.wait(
       function()
         local lines = api.nvim_buf_get_lines(buf, 0, -1, true)
-        return lines[3] == "table xy"
+        return lines[2] == "table xy"
       end,
       function()
         return api.nvim_buf_get_lines(buf, 0, -1, true)
       end
     )
-    local lines = api.nvim_buf_get_lines(buf, 0, -1, true)
     local expected = {
+      "dap> tbl",
+      "table xy",
+      "  x: 1",
+      "  y: 2",
       "",
+    }
+    assert.are.same(expected, api.nvim_buf_get_lines(buf, 0, -1, true))
+    assert_prompt_mark(buf, 5)
+
+    server.spy.clear()
+    repl.execute("tbl")
+    commands = helpers.wait_for_response(server, "evaluate")
+    assert.are.same({"evaluate"}, commands)
+    helpers.wait(
+      function()
+        local lines = api.nvim_buf_get_lines(buf, 0, -1, true)
+        return lines[6] == "table xy"
+      end,
+      function()
+        return api.nvim_buf_get_lines(buf, 0, -1, true)
+      end
+    )
+    expected = {
       "dap> tbl",
       "table xy",
       "  x: 1",
-      "  y: 2"
+      "  y: 2",
+      "dap> tbl",
+      "table xy",
+      "  x: 1",
+      "  y: 2",
+      "",
     }
-    assert.are.same(expected, lines)
+    assert.are.same(expected, api.nvim_buf_get_lines(buf, 0, -1, true))
   end)
 end)