Merge remote-tracking branch 'upstream/master' into mix_20240309

1 files changed, 145 insertions, 94 deletions

diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
index ec676ea97f..f98496456b 100644
--- a/runtime/lua/vim/lsp/inlay_hint.lua
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -4,13 +4,30 @@ local ms = require('vim.lsp.protocol').Methods
 local api = vim.api
 local M = {}
 
----@class (private) vim.lsp.inlay_hint.bufstate
+---@class (private) vim.lsp.inlay_hint.globalstate Global state for inlay hints
+---@field enabled boolean Whether inlay hints are enabled for this scope
+---@type vim.lsp.inlay_hint.globalstate
+local globalstate = {
+  enabled = false,
+}
+
+---@class (private) vim.lsp.inlay_hint.bufstate: vim.lsp.inlay_hint.globalstate Buffer local state for inlay hints
 ---@field version? integer
 ---@field client_hints? table<integer, table<integer, lsp.InlayHint[]>> client_id -> (lnum -> hints)
 ---@field applied table<integer, integer> Last version of hints applied to this line
----@field enabled boolean Whether inlay hints are enabled for this buffer
 ---@type table<integer, vim.lsp.inlay_hint.bufstate>
-local bufstates = {}
+local bufstates = vim.defaulttable(function(_)
+  return setmetatable({ applied = {} }, {
+    __index = globalstate,
+    __newindex = function(state, key, value)
+      if globalstate[key] == value then
+        rawset(state, key, nil)
+      else
+        rawset(state, key, value)
+      end
+    end,
+  })
+end)
 
 local namespace = api.nvim_create_namespace('vim_lsp_inlayhint')
 local augroup = api.nvim_create_augroup('vim_lsp_inlayhint', {})
@@ -34,22 +51,22 @@ function M.on_inlayhint(err, result, ctx, _)
     return
   end
   local bufstate = bufstates[bufnr]
-  if not bufstate or not bufstate.enabled then
+  if not bufstate.enabled then
     return
   end
   if not (bufstate.client_hints and bufstate.version) then
     bufstate.client_hints = vim.defaulttable()
     bufstate.version = ctx.version
   end
-  local hints_by_client = bufstate.client_hints
+  local client_hints = bufstate.client_hints
   local client = assert(vim.lsp.get_client_by_id(client_id))
 
-  local new_hints_by_lnum = vim.defaulttable()
+  local new_lnum_hints = vim.defaulttable()
   local num_unprocessed = #result
   if num_unprocessed == 0 then
-    hints_by_client[client_id] = {}
+    client_hints[client_id] = {}
     bufstate.version = ctx.version
-    api.nvim__buf_redraw_range(bufnr, 0, -1)
+    api.nvim__redraw({ buf = bufnr, valid = true })
     return
   end
 
@@ -73,15 +90,15 @@ function M.on_inlayhint(err, result, ctx, _)
   for _, hint in ipairs(result) do
     local lnum = hint.position.line
     hint.position.character = pos_to_byte(hint.position)
-    table.insert(new_hints_by_lnum[lnum], hint)
+    table.insert(new_lnum_hints[lnum], hint)
   end
 
-  hints_by_client[client_id] = new_hints_by_lnum
+  client_hints[client_id] = new_lnum_hints
   bufstate.version = ctx.version
-  api.nvim__buf_redraw_range(bufnr, 0, -1)
+  api.nvim__redraw({ buf = bufnr, valid = true })
 end
 
---- |lsp-handler| for the method `textDocument/inlayHint/refresh`
+--- |lsp-handler| for the method `workspace/inlayHint/refresh`
 ---@param ctx lsp.HandlerContext
 ---@private
 function M.on_refresh(err, _, ctx, _)
@@ -91,11 +108,7 @@ function M.on_refresh(err, _, ctx, _)
   for _, bufnr in ipairs(vim.lsp.get_buffers_by_client_id(ctx.client_id)) do
     for _, winid in ipairs(api.nvim_list_wins()) do
       if api.nvim_win_get_buf(winid) == bufnr then
-        local bufstate = bufstates[bufnr]
-        if bufstate then
-          util._refresh(ms.textDocument_inlayHint, { bufnr = bufnr })
-          break
-        end
+        util._refresh(ms.textDocument_inlayHint, { bufnr = bufnr })
       end
     end
   end
@@ -123,7 +136,8 @@ end
 --- local hint = vim.lsp.inlay_hint.get({ bufnr = 0 })[1] -- 0 for current buffer
 ---
 --- local client = vim.lsp.get_client_by_id(hint.client_id)
---- resolved_hint = client.request_sync('inlayHint/resolve', hint.inlay_hint, 100, 0).result
+--- local resp = client.request_sync('inlayHint/resolve', hint.inlay_hint, 100, 0)
+--- local resolved_hint = assert(resp and resp.result, resp.err)
 --- vim.lsp.util.apply_text_edits(resolved_hint.textEdits, 0, client.encoding)
 ---
 --- location = resolved_hint.label[1].location
@@ -154,7 +168,7 @@ function M.get(filter)
   end
 
   local bufstate = bufstates[bufnr]
-  if not (bufstate and bufstate.client_hints) then
+  if not bufstate.client_hints then
     return {}
   end
 
@@ -175,19 +189,19 @@ function M.get(filter)
   end
 
   --- @type vim.lsp.inlay_hint.get.ret[]
-  local hints = {}
+  local result = {}
   for _, client in pairs(clients) do
-    local hints_by_lnum = bufstate.client_hints[client.id]
-    if hints_by_lnum then
+    local lnum_hints = bufstate.client_hints[client.id]
+    if lnum_hints then
       for lnum = range.start.line, range['end'].line do
-        local line_hints = hints_by_lnum[lnum] or {}
-        for _, hint in pairs(line_hints) do
+        local hints = lnum_hints[lnum] or {}
+        for _, hint in pairs(hints) do
           local line, char = hint.position.line, hint.position.character
           if
             (line > range.start.line or char >= range.start.character)
             and (line < range['end'].line or char <= range['end'].character)
           then
-            table.insert(hints, {
+            table.insert(result, {
               bufnr = bufnr,
               client_id = client.id,
               inlay_hint = hint,
@@ -197,18 +211,15 @@ function M.get(filter)
       end
     end
   end
-  return hints
+  return result
 end
 
 --- Clear inlay hints
 ---@param bufnr (integer) Buffer handle, or 0 for current
 local function clear(bufnr)
-  if bufnr == nil or bufnr == 0 then
+  if bufnr == 0 then
     bufnr = api.nvim_get_current_buf()
   end
-  if not bufstates[bufnr] then
-    return
-  end
   local bufstate = bufstates[bufnr]
   local client_lens = (bufstate or {}).client_hints or {}
   local client_ids = vim.tbl_keys(client_lens) --- @type integer[]
@@ -218,19 +229,18 @@ local function clear(bufnr)
     end
   end
   api.nvim_buf_clear_namespace(bufnr, namespace, 0, -1)
-  api.nvim__buf_redraw_range(bufnr, 0, -1)
+  api.nvim__redraw({ buf = bufnr, valid = true })
 end
 
 --- Disable inlay hints for a buffer
----@param bufnr (integer|nil) Buffer handle, or 0 or nil for current
+---@param bufnr (integer) Buffer handle, or 0 for current
 local function _disable(bufnr)
-  if bufnr == nil or bufnr == 0 then
+  if bufnr == 0 then
     bufnr = api.nvim_get_current_buf()
   end
   clear(bufnr)
-  if bufstates[bufnr] then
-    bufstates[bufnr] = { enabled = false, applied = {} }
-  end
+  bufstates[bufnr] = nil
+  bufstates[bufnr].enabled = false
 end
 
 --- Refresh inlay hints, only if we have attached clients that support it
@@ -244,30 +254,38 @@ local function _refresh(bufnr, opts)
 end
 
 --- Enable inlay hints for a buffer
----@param bufnr (integer|nil) Buffer handle, or 0 or nil for current
+---@param bufnr (integer) Buffer handle, or 0 for current
 local function _enable(bufnr)
-  if bufnr == nil or bufnr == 0 then
+  if bufnr == 0 then
     bufnr = api.nvim_get_current_buf()
   end
-  local bufstate = bufstates[bufnr]
-  if not bufstate then
-    bufstates[bufnr] = { applied = {}, enabled = true }
-    api.nvim_create_autocmd('LspNotify', {
-      buffer = bufnr,
-      callback = function(opts)
-        if
-          opts.data.method ~= ms.textDocument_didChange
-          and opts.data.method ~= ms.textDocument_didOpen
-        then
-          return
-        end
-        if bufstates[bufnr] and bufstates[bufnr].enabled then
-          _refresh(bufnr, { client_id = opts.data.client_id })
-        end
-      end,
-      group = augroup,
-    })
-    _refresh(bufnr)
+  bufstates[bufnr] = nil
+  bufstates[bufnr].enabled = true
+  _refresh(bufnr)
+end
+
+api.nvim_create_autocmd('LspNotify', {
+  callback = function(args)
+    ---@type integer
+    local bufnr = args.buf
+
+    if
+      args.data.method ~= ms.textDocument_didChange
+      and args.data.method ~= ms.textDocument_didOpen
+    then
+      return
+    end
+    if bufstates[bufnr].enabled then
+      _refresh(bufnr, { client_id = args.data.client_id })
+    end
+  end,
+  group = augroup,
+})
+api.nvim_create_autocmd('LspAttach', {
+  callback = function(args)
+    ---@type integer
+    local bufnr = args.buf
+
     api.nvim_buf_attach(bufnr, false, {
       on_reload = function(_, cb_bufnr)
         clear(cb_bufnr)
@@ -278,32 +296,30 @@ local function _enable(bufnr)
       end,
       on_detach = function(_, cb_bufnr)
         _disable(cb_bufnr)
+        bufstates[cb_bufnr] = nil
       end,
     })
-    api.nvim_create_autocmd('LspDetach', {
-      buffer = bufnr,
-      callback = function(args)
-        local clients = vim.lsp.get_clients({ bufnr = bufnr, method = ms.textDocument_inlayHint })
-
-        if
-          not vim.iter(clients):any(function(c)
-            return c.id ~= args.data.client_id
-          end)
-        then
-          _disable(bufnr)
-        end
-      end,
-      group = augroup,
-    })
-  else
-    bufstate.enabled = true
-    _refresh(bufnr)
-  end
-end
+  end,
+  group = augroup,
+})
+api.nvim_create_autocmd('LspDetach', {
+  callback = function(args)
+    ---@type integer
+    local bufnr = args.buf
+    local clients = vim.lsp.get_clients({ bufnr = bufnr, method = ms.textDocument_inlayHint })
 
+    if not vim.iter(clients):any(function(c)
+      return c.id ~= args.data.client_id
+    end) then
+      _disable(bufnr)
+    end
+  end,
+  group = augroup,
+})
 api.nvim_set_decoration_provider(namespace, {
   on_win = function(_, _, bufnr, topline, botline)
-    local bufstate = bufstates[bufnr]
+    ---@type vim.lsp.inlay_hint.bufstate
+    local bufstate = rawget(bufstates, bufnr)
     if not bufstate then
       return
     end
@@ -311,14 +327,18 @@ api.nvim_set_decoration_provider(namespace, {
     if bufstate.version ~= util.buf_versions[bufnr] then
       return
     end
-    local hints_by_client = assert(bufstate.client_hints)
+
+    if not bufstate.client_hints then
+      return
+    end
+    local client_hints = assert(bufstate.client_hints)
 
     for lnum = topline, botline do
       if bufstate.applied[lnum] ~= bufstate.version then
         api.nvim_buf_clear_namespace(bufnr, namespace, lnum, lnum + 1)
-        for _, hints_by_lnum in pairs(hints_by_client) do
-          local line_hints = hints_by_lnum[lnum] or {}
-          for _, hint in pairs(line_hints) do
+        for _, lnum_hints in pairs(client_hints) do
+          local hints = lnum_hints[lnum] or {}
+          for _, hint in pairs(hints) do
             local text = ''
             local label = hint.label
             if type(label) == 'string' then
@@ -349,34 +369,65 @@ api.nvim_set_decoration_provider(namespace, {
   end,
 })
 
---- @param bufnr (integer|nil) Buffer handle, or 0 or nil for current
+--- Query whether inlay hint is enabled in the {filter}ed scope
+--- @param filter vim.lsp.inlay_hint.enable.Filter
 --- @return boolean
 --- @since 12
-function M.is_enabled(bufnr)
+function M.is_enabled(filter)
+  vim.validate({ filter = { filter, 'table', true } })
+  filter = filter or {}
+  local bufnr = filter.bufnr
+
   vim.validate({ bufnr = { bufnr, 'number', true } })
-  if bufnr == nil or bufnr == 0 then
+  if bufnr == nil then
+    return globalstate.enabled
+  elseif bufnr == 0 then
     bufnr = api.nvim_get_current_buf()
   end
-  return bufstates[bufnr] and bufstates[bufnr].enabled or false
+  return bufstates[bufnr].enabled
 end
 
---- Enables or disables inlay hints for a buffer.
+--- Optional filters |kwargs|, or `nil` for all.
+--- @class vim.lsp.inlay_hint.enable.Filter
+--- @inlinedoc
+--- Buffer number, or 0 for current buffer, or nil for all.
+--- @field bufnr integer?
+
+--- Enables or disables inlay hints for the {filter}ed scope.
 ---
 --- To "toggle", pass the inverse of `is_enabled()`:
 ---
 --- ```lua
---- vim.lsp.inlay_hint.enable(0, not vim.lsp.inlay_hint.is_enabled())
+--- vim.lsp.inlay_hint.enable(not vim.lsp.inlay_hint.is_enabled())
 --- ```
 ---
---- @param bufnr (integer|nil) Buffer handle, or 0 or nil for current
 --- @param enable (boolean|nil) true/nil to enable, false to disable
+--- @param filter vim.lsp.inlay_hint.enable.Filter?
 --- @since 12
-function M.enable(bufnr, enable)
-  vim.validate({ enable = { enable, 'boolean', true }, bufnr = { bufnr, 'number', true } })
-  if enable == false then
-    _disable(bufnr)
+function M.enable(enable, filter)
+  vim.validate({ enable = { enable, 'boolean', true }, filter = { filter, 'table', true } })
+  enable = enable == nil or enable
+  filter = filter or {}
+
+  if filter.bufnr == nil then
+    globalstate.enabled = enable
+    for _, bufnr in ipairs(api.nvim_list_bufs()) do
+      if api.nvim_buf_is_loaded(bufnr) then
+        if enable == false then
+          _disable(bufnr)
+        else
+          _enable(bufnr)
+        end
+      else
+        bufstates[bufnr] = nil
+      end
+    end
   else
-    _enable(bufnr)
+    if enable == false then
+      _disable(filter.bufnr)
+    else
+      _enable(filter.bufnr)
+    end
   end
 end