Merge 9a2662d24a into 3db3947b0e

Fixes: https://github.com/neovim/neovim/issues/31612

runtime/doc/lsp.txt

@@ -1126,6 +1126,9 @@ Lua module: vim.lsp.client                                        *lsp-client*
       • {server_capabilities}   (`lsp.ServerCapabilities?`) Response from the
                                 server sent on `initialize` describing the
                                 server's capabilities.
+      • {server_info}           (`lsp.ServerInfo?`) Response from the server
+                                sent on `initialize` describing information
+                                about the server.
       • {progress}              (`vim.lsp.Client.Progress`) A ring buffer
                                 (|vim.ringbuf()|) containing progress messages
                                 sent by the server. See

runtime/doc/news.txt

@@ -115,6 +115,7 @@ LSP
 • |vim.lsp.util.make_position_params()|, |vim.lsp.util.make_range_params()|
   and |vim.lsp.util.make_given_range_params()| now require the `position_encoding`
   parameter.
+• `:checkhealth vim.lsp` displays the server version (if available).
 
 LUA
 

runtime/lua/man.lua

@@ -1,19 +1,8 @@
 local api, fn = vim.api, vim.fn
 
-local FIND_ARG = '-w'
-local localfile_arg = true -- Always use -l if possible. #6683
-
----@type table[]
-local buf_hls = {}
-
 local M = {}
 
-local function man_error(msg)
+--- Run a system command and timeout after 10 seconds.
-  M.errormsg = 'man.lua: ' .. vim.inspect(msg)
-  error(M.errormsg)
-end
-
--- Run a system command and timeout after 30 seconds.
 --- @param cmd string[]
 --- @param silent boolean?
 --- @param env? table<string,string|number>
@@ -24,7 +13,7 @@ local function system(cmd, silent, env)
   if not silent then
     if r.code ~= 0 then
       local cmd_str = table.concat(cmd, ' ')
-      man_error(string.format("command error '%s': %s", cmd_str, r.stderr))
+      error(string.format("command error '%s': %s", cmd_str, r.stderr))
     end
     assert(r.stdout ~= '')
   end
@@ -32,65 +21,64 @@ local function system(cmd, silent, env)
   return assert(r.stdout)
 end
 
+--- @enum Man.Attribute
+local Attrs = {
+  None = 0,
+  Bold = 1,
+  Underline = 2,
+  Italic = 3,
+}
+
 --- @param line string
----@param linenr integer
+--- @param row integer
-local function highlight_line(line, linenr)
+--- @param hls {attr:Man.Attribute,row:integer,start:integer,final:integer}[]
+--- @return string
+local function render_line(line, row, hls)
   --- @type string[]
   local chars = {}
   local prev_char = ''
   local overstrike, escape, osc8 = false, false, false
 
-  ---@type table<integer,{attr:integer,start:integer,final:integer}>
+  local attr = Attrs.None
-  local hls = {} -- Store highlight groups as { attr, start, final }
-
-  local NONE, BOLD, UNDERLINE, ITALIC = 0, 1, 2, 3
-  local hl_groups = { [BOLD] = 'manBold', [UNDERLINE] = 'manUnderline', [ITALIC] = 'manItalic' }
-  local attr = NONE
   local byte = 0 -- byte offset
 
-  local function end_attr_hl(attr_)
+  local hls_start = #hls + 1
-    for i, hl in ipairs(hls) do
-      if hl.attr == attr_ and hl.final == -1 then
-        hl.final = byte
-        hls[i] = hl
-      end
-    end
-  end
 
+  --- @param code integer
   local function add_attr_hl(code)
     local continue_hl = true
     if code == 0 then
-      attr = NONE
+      attr = Attrs.None
       continue_hl = false
     elseif code == 1 then
-      attr = BOLD
+      attr = Attrs.Bold
     elseif code == 22 then
-      attr = BOLD
+      attr = Attrs.Bold
       continue_hl = false
     elseif code == 3 then
-      attr = ITALIC
+      attr = Attrs.Italic
     elseif code == 23 then
-      attr = ITALIC
+      attr = Attrs.Italic
       continue_hl = false
     elseif code == 4 then
-      attr = UNDERLINE
+      attr = Attrs.Underline
     elseif code == 24 then
-      attr = UNDERLINE
+      attr = Attrs.Underline
       continue_hl = false
     else
-      attr = NONE
+      attr = Attrs.None
       return
     end
 
     if continue_hl then
-      hls[#hls + 1] = { attr = attr, start = byte, final = -1 }
+      hls[#hls + 1] = { attr = attr, row = row, start = byte, final = -1 }
     else
-      if attr == NONE then
+      for _, a in pairs(attr == Attrs.None and Attrs or { attr }) do
-        for a, _ in pairs(hl_groups) do
+        for i = hls_start, #hls do
-          end_attr_hl(a)
+          if hls[i].attr == a and hls[i].final == -1 then
+            hls[i].final = byte
+          end
         end
-      else
-        end_attr_hl(attr)
       end
     end
   end
@@ -103,11 +91,11 @@ local function highlight_line(line, linenr)
     if overstrike then
       local last_hl = hls[#hls]
       if char == prev_char then
-        if char == '_' and attr == ITALIC and last_hl and last_hl.final == byte then
+        if char == '_' and attr == Attrs.Italic and last_hl and last_hl.final == byte then
           -- This underscore is in the middle of an italic word
-          attr = ITALIC
+          attr = Attrs.Italic
         else
-          attr = BOLD
+          attr = Attrs.Bold
         end
       elseif prev_char == '_' then
         -- Even though underline is strictly what this should be. <bs>_ was used by nroff to
@@ -116,26 +104,26 @@ local function highlight_line(line, linenr)
         -- See:
         -- - https://unix.stackexchange.com/questions/274658/purpose-of-ascii-text-with-overstriking-file-format/274795#274795
         -- - https://cmd.inp.nsk.su/old/cmd2/manuals/unix/UNIX_Unleashed/ch08.htm
-        -- attr = UNDERLINE
+        -- attr = Attrs.Underline
-        attr = ITALIC
+        attr = Attrs.Italic
       elseif prev_char == '+' and char == 'o' then
         -- bullet (overstrike text '+^Ho')
-        attr = BOLD
+        attr = Attrs.Bold
         char = '·'
       elseif prev_char == '·' and char == 'o' then
         -- bullet (additional handling for '+^H+^Ho^Ho')
-        attr = BOLD
+        attr = Attrs.Bold
         char = '·'
       else
         -- use plain char
-        attr = NONE
+        attr = Attrs.None
       end
 
       -- Grow the previous highlight group if possible
       if last_hl and last_hl.attr == attr and last_hl.final == byte then
         last_hl.final = byte + #char
       else
-        hls[#hls + 1] = { attr = attr, start = byte, final = byte + #char }
+        hls[#hls + 1] = { attr = attr, row = row, start = byte, final = byte + #char }
       end
 
       overstrike = false
@@ -158,10 +146,11 @@ local function highlight_line(line, linenr)
       local sgr = prev_char:match('^%[([\032-\063]*)m$')
       -- Ignore escape sequences with : characters, as specified by ITU's T.416
       -- Open Document Architecture and interchange format.
-      if sgr and not string.find(sgr, ':') then
+      if sgr and not sgr:find(':') then
         local match --- @type string?
         while sgr and #sgr > 0 do
           -- Match against SGR parameters, which may be separated by ';'
+          --- @type string?, string?
           match, sgr = sgr:match('^(%d*);?(.*)')
           add_attr_hl(match + 0) -- coerce to number
         end
@@ -187,55 +176,40 @@ local function highlight_line(line, linenr)
     end
   end
 
-  for _, hl in ipairs(hls) do
-    if hl.attr ~= NONE then
-      buf_hls[#buf_hls + 1] = {
-        0,
-        -1,
-        hl_groups[hl.attr],
-        linenr - 1,
-        hl.start,
-        hl.final,
-      }
-    end
-  end
-
   return table.concat(chars, '')
 end
 
+local HlGroups = {
+  [Attrs.Bold] = 'manBold',
+  [Attrs.Underline] = 'manUnderline',
+  [Attrs.Italic] = 'manItalic',
+}
+
 local function highlight_man_page()
   local mod = vim.bo.modifiable
   vim.bo.modifiable = true
 
   local lines = api.nvim_buf_get_lines(0, 0, -1, false)
+
+  --- @type {attr:Man.Attribute,row:integer,start:integer,final:integer}[]
+  local hls = {}
+
   for i, line in ipairs(lines) do
-    lines[i] = highlight_line(line, i)
+    lines[i] = render_line(line, i - 1, hls)
   end
+
   api.nvim_buf_set_lines(0, 0, -1, false, lines)
 
-  for _, args in ipairs(buf_hls) do
+  for _, hl in ipairs(hls) do
-    api.nvim_buf_add_highlight(unpack(args))
+    api.nvim_buf_add_highlight(0, -1, HlGroups[hl.attr], hl.row, hl.start, hl.final)
   end
-  buf_hls = {}
 
   vim.bo.modifiable = mod
 end
 
--- replace spaces in a man page name with underscores
+--- @param name? string
--- intended for PostgreSQL, which has man pages like 'CREATE_TABLE(7)';
+--- @param sect? string
--- while editing SQL source code, it's nice to visually select 'CREATE TABLE'
+local function get_path(name, sect)
--- and hit 'K', which requires this transformation
----@param str string
----@return string
-local function spaces_to_underscores(str)
-  local res = str:gsub('%s', '_')
-  return res
-end
-
----@param sect string|nil
----@param name string|nil
----@param silent boolean
-local function get_path(sect, name, silent)
   name = name or ''
   sect = sect or ''
   -- Some man implementations (OpenBSD) return all available paths from the
@@ -258,12 +232,12 @@ local function get_path(sect, name, silent)
   -- inconsistently supported. Instead, call -w with a section and a name.
   local cmd --- @type string[]
   if sect == '' then
-    cmd = { 'man', FIND_ARG, name }
+    cmd = { 'man', '-w', name }
   else
-    cmd = { 'man', FIND_ARG, sect, name }
+    cmd = { 'man', '-w', sect, name }
   end
 
-  local lines = system(cmd, silent)
+  local lines = system(cmd, true)
   local results = vim.split(lines, '\n', { trimempty = true })
 
   if #results == 0 then
@@ -282,7 +256,7 @@ local function get_path(sect, name, silent)
   --- @param v string
   local namematches = vim.tbl_filter(function(v)
     local tail = fn.fnamemodify(v, ':t')
-    return string.find(tail, name, 1, true)
+    return tail:find(name, 1, true) ~= nil
   end, results) or {}
   local sectmatches = {}
 
@@ -293,73 +267,59 @@ local function get_path(sect, name, silent)
     end, namematches)
   end
 
-  return fn.substitute(sectmatches[1] or namematches[1] or results[1], [[\n\+$]], '', '')
+  return (sectmatches[1] or namematches[1] or results[1]):gsub('\n+$', '')
 end
 
----@param text string
+--- Attempt to extract the name and sect out of 'name(sect)'
----@param pat_or_re string
+--- otherwise just return the largest string of valid characters in ref
-local function matchstr(text, pat_or_re)
-  local re = type(pat_or_re) == 'string' and vim.regex(pat_or_re) or pat_or_re
-
-  ---@type integer, integer
-  local s, e = re:match_str(text)
-
-  if s == nil then
-    return
-  end
-
-  return text:sub(vim.str_utfindex(text, 'utf-32', s) + 1, vim.str_utfindex(text, 'utf-32', e))
-end
-
--- attempt to extract the name and sect out of 'name(sect)'
--- otherwise just return the largest string of valid characters in ref
 --- @param ref string
----@return string, string
+--- @return string? name
-local function extract_sect_and_name_ref(ref)
+--- @return string? sect
-  ref = ref or ''
+--- @return string? err
-  if ref:sub(1, 1) == '-' then -- try ':Man -pandoc' with this disabled.
+local function parse_ref(ref)
-    man_error("manpage name cannot start with '-'")
+  if ref == '' or ref:sub(1, 1) == '-' then
+    return nil, nil, ('invalid manpage reference "%s"'):format(ref)
   end
-  local ref1 = ref:match('[^()]+%([^()]+%)')
+
-  if not ref1 then
+  -- match "<name>(<sect>)"
-    local name = ref:match('[^()]+')
+  -- note: name can contain spaces
-    if not name then
+  local name, sect = ref:match('([^()]+)%(([^()]+)%)')
-      man_error('manpage reference cannot contain only parentheses: ' .. ref)
+  if name then
-    end
-    return '', name
-  end
-  local parts = vim.split(ref1, '(', { plain = true })
     -- see ':Man 3X curses' on why tolower.
     -- TODO(nhooyr) Not sure if this is portable across OSs
     -- but I have not seen a single uppercase section.
-  local sect = vim.split(parts[2] or '', ')', { plain = true })[1]:lower()
+    return name, sect:lower()
-  local name = parts[1]
-  return sect, name
   end
 
--- find_path attempts to find the path to a manpage
+  name = ref:match('[^()]+')
--- based on the passed section and name.
+  if not name then
---
+    return nil, nil, ('invalid manpage reference "%s"'):format(ref)
--- 1. If manpage could not be found with the given sect and name,
+  end
---    then try all the sections in b:man_default_sects.
+  return name
--- 2. If it still could not be found, then we try again without a section.
+end
--- 3. If still not found but $MANSECT is set, then we try again with $MANSECT
+
---    unset.
+--- Attempts to find the path to a manpage based on the passed section and name.
--- 4. If a path still wasn't found, return nil.
+---
+--- 1. If manpage could not be found with the given sect and name,
+---    then try all the sections in b:man_default_sects.
+--- 2. If it still could not be found, then we try again without a section.
+--- 3. If still not found but $MANSECT is set, then we try again with $MANSECT
+---    unset.
+--- 4. If a path still wasn't found, return nil.
+--- @param name string?
 --- @param sect string?
----@param name string
+--- @return string? path
-function M.find_path(sect, name)
+function M._find_path(name, sect)
   if sect and sect ~= '' then
-    local ret = get_path(sect, name, true)
+    local ret = get_path(name, sect)
     if ret then
       return ret
     end
   end
 
   if vim.b.man_default_sects ~= nil then
-    local sects = vim.split(vim.b.man_default_sects, ',', { plain = true, trimempty = true })
+    for sec in vim.gsplit(vim.b.man_default_sects, ',', { trimempty = true }) do
-    for _, sec in ipairs(sects) do
+      local ret = get_path(name, sec)
-      local ret = get_path(sec, name, true)
       if ret then
         return ret
       end
@@ -367,17 +327,18 @@ function M.find_path(sect, name)
   end
 
   -- if none of the above worked, we will try with no section
-  local res_empty_sect = get_path('', name, true)
+  local ret = get_path(name)
-  if res_empty_sect then
+  if ret then
-    return res_empty_sect
+    return ret
   end
 
   -- if that still didn't work, we will check for $MANSECT and try again with it
   -- unset
   if vim.env.MANSECT then
+    --- @type string
     local mansect = vim.env.MANSECT
     vim.env.MANSECT = nil
-    local res = get_path('', name, true)
+    local res = get_path(name)
     vim.env.MANSECT = mansect
     if res then
       return res
@@ -388,21 +349,24 @@ function M.find_path(sect, name)
   return nil
 end
 
-local EXT_RE = vim.regex([[\.\%([glx]z\|bz2\|lzma\|Z\)$]])
+--- Extracts the name/section from the 'path/name.sect', because sometimes the
-
+--- actual section is more specific than what we provided to `man`
--- Extracts the name/section from the 'path/name.sect', because sometimes the actual section is
+--- (try `:Man 3 App::CLI`). Also on linux, name seems to be case-insensitive.
--- more specific than what we provided to `man` (try `:Man 3 App::CLI`).
+--- So for `:Man PRIntf`, we still want the name of the buffer to be 'printf'.
--- Also on linux, name seems to be case-insensitive. So for `:Man PRIntf`, we
--- still want the name of the buffer to be 'printf'.
 --- @param path string
----@return string, string
+--- @return string name
-local function extract_sect_and_name_path(path)
+--- @return string sect
+local function parse_path(path)
   local tail = fn.fnamemodify(path, ':t')
-  if EXT_RE:match_str(path) then -- valid extensions
+  if
+    path:match('%.[glx]z$')
+    or path:match('%.bz2$')
+    or path:match('%.lzma$')
+    or path:match('%.Z$')
+  then
     tail = fn.fnamemodify(tail, ':r')
   end
-  local name, sect = tail:match('^(.+)%.([^.]+)$')
+  return tail:match('^(.+)%.([^.]+)$')
-  return sect, name
 end
 
 --- @return boolean
@@ -433,6 +397,10 @@ local function set_options()
   vim.bo.filetype = 'man'
 end
 
+--- Always use -l if possible. #6683
+--- @type boolean?
+local localfile_arg
+
 --- @param path string
 --- @param silent boolean?
 --- @return string
@@ -444,11 +412,17 @@ local function get_page(path, silent)
   if (vim.g.man_hardwrap or 1) ~= 1 then
     manwidth = 999
   elseif vim.env.MANWIDTH then
-    manwidth = vim.env.MANWIDTH
+    manwidth = vim.env.MANWIDTH --- @type string|integer
   else
     manwidth = api.nvim_win_get_width(0) - vim.o.wrapmargin
   end
 
+  if localfile_arg == nil then
+    local mpath = get_path('man')
+    -- Check for -l support.
+    localfile_arg = (mpath and system({ 'man', '-l', mpath }, true) or '') ~= ''
+  end
+
   local cmd = localfile_arg and { 'man', '-l', path } or { 'man', path }
 
   -- Force MANPAGER=cat to ensure Vim is not recursively invoked (by man-db).
@@ -461,47 +435,17 @@ local function get_page(path, silent)
   })
 end
 
----@param lnum integer
+--- @param path string
----@return string
+--- @param psect string
-local function getline(lnum)
-  ---@diagnostic disable-next-line
-  return fn.getline(lnum)
-end
-
----@param page string
-local function put_page(page)
-  vim.bo.modifiable = true
-  vim.bo.readonly = false
-  vim.bo.swapfile = false
-
-  api.nvim_buf_set_lines(0, 0, -1, false, vim.split(page, '\n'))
-
-  while getline(1):match('^%s*$') do
-    api.nvim_buf_set_lines(0, 0, 1, false, {})
-  end
-  -- XXX: nroff justifies text by filling it with whitespace.  That interacts
-  -- badly with our use of $MANWIDTH=999.  Hack around this by using a fixed
-  -- size for those whitespace regions.
-  -- Use try/catch to avoid setting v:errmsg.
-  vim.cmd([[
-    try
-      keeppatterns keepjumps %s/\s\{199,}/\=repeat(' ', 10)/g
-    catch
-    endtry
-  ]])
-  vim.cmd('1') -- Move cursor to first line
-  highlight_man_page()
-  set_options()
-end
-
 local function format_candidate(path, psect)
-  if matchstr(path, [[\.\%(pdf\|in\)$]]) then -- invalid extensions
+  if vim.endswith(path, '.pdf') or vim.endswith(path, '.in') then
+    -- invalid extensions
     return ''
   end
-  local sect, name = extract_sect_and_name_path(path)
+  local name, sect = parse_path(path)
   if sect == psect then
     return name
-  elseif sect and name and matchstr(sect, psect .. '.\\+$') then -- invalid extensions
+  elseif sect:match(psect .. '.+$') then -- invalid extensions
     -- We include the section if the user provided section is a prefix
     -- of the actual section.
     return ('%s(%s)'):format(name, sect)
@@ -509,63 +453,54 @@ local function format_candidate(path, psect)
   return ''
 end
 
----@generic T
----@param list T[]
----@param elem T
----@return T[]
-local function move_elem_to_head(list, elem)
-  ---@diagnostic disable-next-line:no-unknown
-  local list1 = vim.tbl_filter(function(v)
-    return v ~= elem
-  end, list)
-  return { elem, unpack(list1) }
-end
-
----@param sect string
 --- @param name string
----@return string[]
+--- @param sect? string
-local function get_paths(sect, name)
+--- @return string[] paths
+--- @return string? err
+local function get_paths(name, sect)
   -- Try several sources for getting the list man directories:
-  --   1. `man -w` (works on most systems)
+  --   1. `manpath -q`
-  --   2. `manpath`
+  --   2. `man -w` (works on most systems)
   --   3. $MANPATH
-  local mandirs_raw = vim.F.npcall(system, { 'man', FIND_ARG })
+  --
-    or vim.F.npcall(system, { 'manpath', '-q' })
+  -- Note we prefer `manpath -q` because `man -w`:
+  -- - does not work on MacOS 14 and later.
+  -- - only returns '/usr/bin/man' on MacOS 13 and earlier.
+  --- @type string?
+  local mandirs_raw = vim.F.npcall(system, { 'manpath', '-q' })
+    or vim.F.npcall(system, { 'man', '-w' })
     or vim.env.MANPATH
 
   if not mandirs_raw then
-    man_error("Could not determine man directories from: 'man -w', 'manpath' or $MANPATH")
+    return {}, "Could not determine man directories from: 'man -w', 'manpath' or $MANPATH"
   end
 
   local mandirs = table.concat(vim.split(mandirs_raw, '[:\n]', { trimempty = true }), ',')
+
+  sect = sect or ''
+
   --- @type string[]
   local paths = fn.globpath(mandirs, 'man[^\\/]*/' .. name .. '*.' .. sect .. '*', false, true)
 
   -- Prioritize the result from find_path as it obeys b:man_default_sects.
-  local first = M.find_path(sect, name)
+  local first = M._find_path(name, sect)
   if first then
-    paths = move_elem_to_head(paths, first)
+    --- @param v string
+    paths = vim.tbl_filter(function(v)
+      return v ~= first
+    end, paths)
+    table.insert(paths, 1, first)
   end
 
   return paths
 end
 
----@param sect string
----@param psect string
----@param name string
----@return string[]
-local function complete(sect, psect, name)
-  local pages = get_paths(sect, name)
-  -- We remove duplicates in case the same manpage in different languages was found.
-  return fn.uniq(fn.sort(vim.tbl_map(function(v)
-    return format_candidate(v, psect)
-  end, pages) or {}, 'i'))
-end
-
--- see extract_sect_and_name_ref on why tolower(sect)
 --- @param arg_lead string
 --- @param cmd_line string
-function M.man_complete(arg_lead, cmd_line, _)
+--- @return string? sect
+--- @return string? psect
+--- @return string? name
+local function parse_cmdline(arg_lead, cmd_line)
   local args = vim.split(cmd_line, '%s+', { trimempty = true })
   local cmd_offset = fn.index(args, 'Man')
   if cmd_offset > 0 then
@@ -575,13 +510,13 @@ function M.man_complete(arg_lead, cmd_line, _)
   end
 
   if #args > 3 then
-    return {}
+    return
   end
 
   if #args == 1 then
     -- returning full completion is laggy. Require some arg_lead to complete
-    -- return complete('', '', '')
+    -- return '', '', ''
-    return {}
+    return
   end
 
   if arg_lead:match('^[^()]+%([^()]*$') then
@@ -590,14 +525,15 @@ function M.man_complete(arg_lead, cmd_line, _)
     -- It will offer 'priclass.d(1m)' even though section is specified as 1.
     local tmp = vim.split(arg_lead, '(', { plain = true })
     local name = tmp[1]
+    -- See extract_sect_and_name_ref on why :lower()
     local sect = (tmp[2] or ''):lower()
-    return complete(sect, '', name)
+    return sect, '', name
   end
 
   if not args[2]:match('^[^()]+$') then
     -- cursor (|) is at ':Man 3() |' or ':Man (3|' or ':Man 3() pri|'
     -- or ':Man 3() pri |'
-    return {}
+    return
   end
 
   if #args == 2 then
@@ -617,52 +553,77 @@ function M.man_complete(arg_lead, cmd_line, _)
       name = arg_lead
       sect = ''
     end
-    return complete(sect, sect, name)
+    return sect, sect, name
   end
 
   if not arg_lead:match('[^()]+$') then
     -- cursor (|) is at ':Man 3 printf |' or ':Man 3 (pr)i|'
-    return {}
+    return
   end
 
   -- cursor (|) is at ':Man 3 pri|'
-  local name = arg_lead
+  local name, sect = arg_lead, args[2]:lower()
-  local sect = args[2]:lower()
+  return sect, sect, name
-  return complete(sect, sect, name)
+end
+
+--- @param arg_lead string
+--- @param cmd_line string
+function M.man_complete(arg_lead, cmd_line)
+  local sect, psect, name = parse_cmdline(arg_lead, cmd_line)
+  if not (sect and psect and name) then
+    return {}
+  end
+
+  local pages = get_paths(name, sect)
+
+  -- We check for duplicates in case the same manpage in different languages
+  -- was found.
+  local pages_fmt = {} --- @type string[]
+  local pages_fmt_keys = {} --- @type table<string,true>
+  for _, v in ipairs(pages) do
+    local x = format_candidate(v, psect)
+    local xl = x:lower() -- ignore case when searching avoiding duplicates
+    if not pages_fmt_keys[xl] then
+      pages_fmt[#pages_fmt + 1] = x
+      pages_fmt_keys[xl] = true
+    end
+  end
+  table.sort(pages_fmt)
+
+  return pages_fmt
 end
 
 --- @param pattern string
 --- @return {name:string,filename:string,cmd:string}[]
 function M.goto_tag(pattern, _, _)
-  local sect, name = extract_sect_and_name_ref(pattern)
+  local name, sect, err = parse_ref(pattern)
+  if err then
+    error(err)
+  end
 
-  local paths = get_paths(sect, name)
+  local paths, err2 = get_paths(assert(name), sect)
-  ---@type {name:string,title:string}[]
+  if err2 then
-  local structured = {}
+    error(err2)
+  end
+
+  --- @type table[]
+  local ret = {}
 
   for _, path in ipairs(paths) do
-    sect, name = extract_sect_and_name_path(path)
+    local pname, psect = parse_path(path)
-    if sect and name then
+    ret[#ret + 1] = {
-      structured[#structured + 1] = {
+      name = pname,
-        name = name,
+      filename = ('man://%s(%s)'):format(pname, psect),
-        title = name .. '(' .. sect .. ')',
-      }
-    end
-  end
-
-  ---@param entry {name:string,title:string}
-  return vim.tbl_map(function(entry)
-    return {
-      name = entry.name,
-      filename = 'man://' .. entry.title,
       cmd = '1',
     }
-  end, structured)
   end
 
--- Called when Nvim is invoked as $MANPAGER.
+  return ret
+end
+
+--- Called when Nvim is invoked as $MANPAGER.
 function M.init_pager()
-  if getline(1):match('^%s*$') then
+  if fn.getline(1):match('^%s*$') then
     api.nvim_buf_set_lines(0, 0, 1, false, {})
   else
     vim.cmd('keepjumps 1')
@@ -670,9 +631,10 @@ function M.init_pager()
   highlight_man_page()
   -- Guess the ref from the heading (which is usually uppercase, so we cannot
   -- know the correct casing, cf. `man glDrawArraysInstanced`).
-  local ref = fn.substitute(matchstr(getline(1), [[^[^)]\+)]]) or '', ' ', '_', 'g')
+  --- @type string
-  local ok, res = pcall(extract_sect_and_name_ref, ref)
+  local ref = (fn.getline(1):match('^[^)]+%)') or ''):gsub(' ', '_')
-  vim.b.man_sect = ok and res or ''
+  local _, sect, err = pcall(parse_ref, ref)
+  vim.b.man_sect = err ~= nil and sect or ''
 
   if not fn.bufname('%'):match('man://') then -- Avoid duplicate buffers, E95.
     vim.cmd.file({ 'man://' .. fn.fnameescape(ref):lower(), mods = { silent = true } })
@@ -681,21 +643,14 @@ function M.init_pager()
   set_options()
 end
 
----@param count integer
+--- Combine the name and sect into a manpage reference so that all
+--- verification/extraction can be kept in a single function.
 --- @param args string[]
-function M.open_page(count, smods, args)
+--- @return string? ref
-  local ref ---@type string
+local function ref_from_args(args)
-  if #args == 0 then
+  if #args <= 1 then
-    ref = vim.bo.filetype == 'man' and fn.expand('<cWORD>') or fn.expand('<cword>')
+    return args[1]
-    if ref == '' then
+  elseif args[1]:match('^%d$') or args[1]:match('^%d%a') or args[1]:match('^%a$') then
-      man_error('no identifier under cursor')
-    end
-  elseif #args == 1 then
-    ref = args[1]
-  else
-    -- Combine the name and sect into a manpage reference so that all
-    -- verification/extraction can be kept in a single function.
-    if args[1]:match('^%d$') or args[1]:match('^%d%a') or args[1]:match('^%a$') then
     -- NB: Valid sections are not only digits, but also:
     --  - <digit><word> (see POSIX mans),
     --  - and even <letter> and <word> (see, for example, by tcl/tk)
@@ -704,27 +659,48 @@ function M.open_page(count, smods, args)
     local sect = args[1]
     table.remove(args, 1)
     local name = table.concat(args, ' ')
-      ref = ('%s(%s)'):format(name, sect)
+    return ('%s(%s)'):format(name, sect)
-    else
+  end
-      ref = table.concat(args, ' ')
+
+  return table.concat(args, ' ')
+end
+
+--- @param count integer
+--- @param args string[]
+--- @return string? err
+function M.open_page(count, smods, args)
+  local ref = ref_from_args(args)
+  if not ref then
+    ref = vim.bo.filetype == 'man' and fn.expand('<cWORD>') or fn.expand('<cword>')
+    if ref == '' then
+      return 'no identifier under cursor'
     end
   end
 
-  local sect, name = extract_sect_and_name_ref(ref)
+  local name, sect, err = parse_ref(ref)
+  if err then
+    return err
+  end
+  assert(name)
+
   if count >= 0 then
     sect = tostring(count)
   end
 
   -- Try both spaces and underscores, use the first that exists.
-  local path = M.find_path(sect, name)
+  local path = M._find_path(name, sect)
-  if path == nil then
+  if not path then
-    path = M.find_path(sect, spaces_to_underscores(name))
+    --- Replace spaces in a man page name with underscores
-    if path == nil then
+    --- intended for PostgreSQL, which has man pages like 'CREATE_TABLE(7)';
-      man_error('no manual entry for ' .. name)
+    --- while editing SQL source code, it's nice to visually select 'CREATE TABLE'
+    --- and hit 'K', which requires this transformation
+    path = M._find_path(name:gsub('%s', '_'), sect)
+    if not path then
+      return 'no manual entry for ' .. name
     end
   end
 
-  sect, name = extract_sect_and_name_path(path)
+  name, sect = parse_path(path)
   local buf = api.nvim_get_current_buf()
   local save_tfu = vim.bo[buf].tagfunc
   vim.bo[buf].tagfunc = "v:lua.require'man'.goto_tag"
@@ -747,24 +723,51 @@ function M.open_page(count, smods, args)
 
   if not ok then
     error(ret)
-  else
+  end
   set_options()
-  end
 
   vim.b.man_sect = sect
 end
 
--- Called when a man:// buffer is opened.
+--- Called when a man:// buffer is opened.
+--- @return string? err
 function M.read_page(ref)
-  local sect, name = extract_sect_and_name_ref(ref)
+  local name, sect, err = parse_ref(ref)
-  local path = M.find_path(sect, name)
+  if err then
-  if path == nil then
+    return err
-    man_error('no manual entry for ' .. name)
   end
-  sect = extract_sect_and_name_path(path)
+
+  local path = M._find_path(name, sect)
+  if not path then
+    return 'no manual entry for ' .. name
+  end
+
+  local _, sect1 = parse_path(path)
   local page = get_page(path)
-  vim.b.man_sect = sect
+
-  put_page(page)
+  vim.b.man_sect = sect1
+  vim.bo.modifiable = true
+  vim.bo.readonly = false
+  vim.bo.swapfile = false
+
+  api.nvim_buf_set_lines(0, 0, -1, false, vim.split(page, '\n'))
+
+  while fn.getline(1):match('^%s*$') do
+    api.nvim_buf_set_lines(0, 0, 1, false, {})
+  end
+  -- XXX: nroff justifies text by filling it with whitespace.  That interacts
+  -- badly with our use of $MANWIDTH=999.  Hack around this by using a fixed
+  -- size for those whitespace regions.
+  -- Use try/catch to avoid setting v:errmsg.
+  vim.cmd([[
+    try
+      keeppatterns keepjumps %s/\s\{199,}/\=repeat(' ', 10)/g
+    catch
+    endtry
+  ]])
+  vim.cmd('1') -- Move cursor to first line
+  highlight_man_page()
+  set_options()
 end
 
 function M.show_toc()
@@ -781,24 +784,13 @@ function M.show_toc()
 
   local lnum = 2
   local last_line = fn.line('$') - 1
-  local section_title_re = vim.regex([[^\%( \{3\}\)\=\S.*$]])
-  local flag_title_re = vim.regex([[^\s\+\%(+\|-\)\S\+]])
   while lnum and lnum < last_line do
-    local text = getline(lnum)
+    local text = fn.getline(lnum)
-    if section_title_re:match_str(text) then
+    if text:match('^%s+[-+]%S') or text:match('^   %S') or text:match('^%S') then
-      -- if text is a section title
       toc[#toc + 1] = {
         bufnr = bufnr,
         lnum = lnum,
-        text = text,
+        text = text:gsub('^%s+', ''):gsub('%s+$', ''),
-      }
-    elseif flag_title_re:match_str(text) then
-      -- if text is a flag title. we strip whitespaces and prepend two
-      -- spaces to have a consistent format in the loclist.
-      toc[#toc + 1] = {
-        bufnr = bufnr,
-        lnum = lnum,
-        text = '  ' .. fn.substitute(text, [[^\s*\(.\{-}\)\s*$]], [[\1]], ''),
       }
     end
     lnum = fn.nextnonblank(lnum + 1)
@@ -810,19 +802,4 @@ function M.show_toc()
   vim.w.qf_toc = bufname
 end
 
-local function init()
-  local path = get_path('', 'man', true)
-  local page ---@type string?
-  if path ~= nil then
-    -- Check for -l support.
-    page = get_page(path, true)
-  end
-
-  if page == '' or page == nil then
-    localfile_arg = false
-  end
-end
-
-init()
-
 return M

runtime/lua/vim/lsp.lua

@@ -211,7 +211,7 @@ local function reuse_client_default(client, config)
 
   for _, config_folder in ipairs(config_folders) do
     local found = false
-    for _, client_folder in ipairs(client.workspace_folders) do
+    for _, client_folder in ipairs(client.workspace_folders or {}) do
       if config_folder.uri == client_folder.uri then
         found = true
         break

runtime/lua/vim/lsp/client.lua

@@ -174,6 +174,10 @@ local validate = vim.validate
 --- capabilities.
 --- @field server_capabilities lsp.ServerCapabilities?
 ---
+--- Response from the server sent on `initialize` describing information about
+--- the server.
+--- @field server_info lsp.ServerInfo?
+---
 --- A ring buffer (|vim.ringbuf()|) containing progress messages
 --- sent by the server.
 --- @field progress vim.lsp.Client.Progress
@@ -556,6 +560,8 @@ function Client:initialize()
       self.offset_encoding = self.server_capabilities.positionEncoding
     end
 
+    self.server_info = result.serverInfo
+
     if next(self.settings) then
       self:notify(ms.workspace_didChangeConfiguration, { settings = self.settings })
     end

runtime/lua/vim/lsp/health.lua

@@ -40,6 +40,8 @@ local function check_active_clients()
   local clients = vim.lsp.get_clients()
   if next(clients) then
     for _, client in pairs(clients) do
+      local server_version = vim.tbl_get(client, 'server_info', 'version')
+        or '? (no serverInfo.version response)'
       local cmd ---@type string
       local ccmd = client.config.cmd
       if type(ccmd) == 'table' then
@@ -62,6 +64,7 @@ local function check_active_clients()
       end
       report_info(table.concat({
         string.format('%s (id: %d)', client.name, client.id),
+        string.format('- Version: %s', server_version),
         dirs_info,
         string.format('- Command: %s', cmd),
         string.format('- Settings: %s', vim.inspect(client.settings, { newline = '\n  ' })),

runtime/lua/vim/snippet.lua

@@ -306,7 +306,7 @@ function Session:set_group_gravity(index, right_gravity)
   end
 end
 
-local M = { session = nil }
+local M = { _sessions = {} }
 
 --- Displays the choices for the given tabstop as completion items.
 ---
@@ -397,7 +397,7 @@ local function setup_autocmds(bufnr)
       local cursor_row, cursor_col = cursor_pos()
 
       -- The cursor left the snippet region.
-      local snippet_range = get_extmark_range(bufnr, M._session.extmark_id)
+      local snippet_range = get_extmark_range(bufnr, M._current_session.extmark_id)
       if
         cursor_row < snippet_range[1]
         or (cursor_row == snippet_range[1] and cursor_col < snippet_range[2])
@@ -408,7 +408,7 @@ local function setup_autocmds(bufnr)
         return true
       end
 
-      for tabstop_index, tabstops in pairs(M._session.tabstops) do
+      for tabstop_index, tabstops in pairs(M._current_session.tabstops) do
         for _, tabstop in ipairs(tabstops) do
           local range = tabstop:get_range()
           if
@@ -434,7 +434,7 @@ local function setup_autocmds(bufnr)
     buffer = bufnr,
     callback = function()
       -- Check that the snippet hasn't been deleted.
-      local snippet_range = get_extmark_range(M._session.bufnr, M._session.extmark_id)
+      local snippet_range = get_extmark_range(M._current_session.bufnr, M._current_session.extmark_id)
       if
         (snippet_range[1] == snippet_range[3] and snippet_range[2] == snippet_range[4])
         or snippet_range[3] + 1 > vim.fn.line('$')
@@ -447,9 +447,9 @@ local function setup_autocmds(bufnr)
       end
 
       -- Sync the tabstops in the current group.
-      local current_tabstop = M._session.current_tabstop
+      local current_tabstop = M._current_session.current_tabstop
       local current_text = current_tabstop:get_text()
-      for _, tabstop in ipairs(M._session.tabstops[current_tabstop.index]) do
+      for _, tabstop in ipairs(M._current_session.tabstops[current_tabstop.index]) do
         if tabstop.extmark_id ~= current_tabstop.extmark_id then
           tabstop:set_text(current_text)
         end
@@ -594,7 +594,8 @@ function M.expand(input)
     right_gravity = false,
     end_right_gravity = true,
   })
-  M._session = Session.new(bufnr, snippet_extmark, tabstop_data)
+  M._current_session = Session.new(bufnr, snippet_extmark, tabstop_data)
+  table.insert(M._sessions, M._current_session)
 
   -- Jump to the first tabstop.
   M.jump(1)
@@ -619,13 +620,13 @@ end
 --- @param direction (vim.snippet.Direction) Navigation direction. -1 for previous, 1 for next.
 function M.jump(direction)
   -- Get the tabstop index to jump to.
-  local dest_index = M._session and M._session:get_dest_index(direction)
+  local dest_index = M._current_session and M._current_session:get_dest_index(direction)
   if not dest_index then
     return
   end
 
   -- Find the tabstop with the lowest range.
-  local tabstops = M._session.tabstops[dest_index]
+  local tabstops = M._current_session.tabstops[dest_index]
   local dest = tabstops[1]
   for _, tabstop in ipairs(tabstops) do
     local dest_range, range = dest:get_range(), tabstop:get_range()
@@ -635,19 +636,19 @@ function M.jump(direction)
   end
 
   -- Clear the autocommands so that we can move the cursor freely while selecting the tabstop.
-  vim.api.nvim_clear_autocmds({ group = snippet_group, buffer = M._session.bufnr })
+  vim.api.nvim_clear_autocmds({ group = snippet_group, buffer = M._current_session.bufnr })
 
   -- Deactivate expansion of the current tabstop.
-  M._session:set_group_gravity(M._session.current_tabstop.index, true)
+  M._current_session:set_group_gravity(M._current_session.current_tabstop.index, true)
 
-  M._session.current_tabstop = dest
+  M._current_session.current_tabstop = dest
   select_tabstop(dest)
 
   -- Activate expansion of the destination tabstop.
-  M._session:set_group_gravity(dest.index, false)
+  M._current_session:set_group_gravity(dest.index, false)
 
   -- Restore the autocommands.
-  setup_autocmds(M._session.bufnr)
+  setup_autocmds(M._current_session.bufnr)
 end
 
 --- @class vim.snippet.ActiveFilter
@@ -673,11 +674,11 @@ end
 --- can be jumped in the given direction.
 --- @return boolean
 function M.active(filter)
-  local active = M._session ~= nil and M._session.bufnr == vim.api.nvim_get_current_buf()
+  local active = M._current_session ~= nil and M._current_session.bufnr == vim.api.nvim_get_current_buf()
 
   local in_direction = true
   if active and filter and filter.direction then
-    in_direction = M._session:get_dest_index(filter.direction) ~= nil
+    in_direction = M._current_session:get_dest_index(filter.direction) ~= nil
   end
 
   return active and in_direction
@@ -689,12 +690,15 @@ function M.stop()
     return
   end
 
-  M._session:restore_keymaps()
+  if #M._sessions == 1 then
+    M._current_session:restore_keymaps()
 
-  vim.api.nvim_clear_autocmds({ group = snippet_group, buffer = M._session.bufnr })
+    vim.api.nvim_clear_autocmds({ group = snippet_group, buffer = M._current_session.bufnr })
-  vim.api.nvim_buf_clear_namespace(M._session.bufnr, snippet_ns, 0, -1)
+    vim.api.nvim_buf_clear_namespace(M._current_session.bufnr, snippet_ns, 0, -1)
+  end
 
-  M._session = nil
+  table.remove(M._sessions)
+  M._current_session = #M._sessions > 0 and M._sessions[#M._sessions] or nil
 end
 
 return M

runtime/plugin/man.lua

@@ -8,9 +8,9 @@ vim.api.nvim_create_user_command('Man', function(params)
   if params.bang then
     man.init_pager()
   else
-    local ok, err = pcall(man.open_page, params.count, params.smods, params.fargs)
+    local err = man.open_page(params.count, params.smods, params.fargs)
-    if not ok then
+    if err then
-      vim.notify(man.errormsg or err, vim.log.levels.ERROR)
+      vim.notify('man.lua: ' .. err, vim.log.levels.ERROR)
     end
   end
 end, {
@@ -31,6 +31,9 @@ vim.api.nvim_create_autocmd('BufReadCmd', {
   pattern = 'man://*',
   nested = true,
   callback = function(params)
-    require('man').read_page(vim.fn.matchstr(params.match, 'man://\\zs.*'))
+    local err = require('man').read_page(assert(params.match:match('man://(.*)')))
+    if err then
+      vim.notify('man.lua: ' .. err, vim.log.levels.ERROR)
+    end
   end,
 })

src/nvim/api/vimscript.c

@@ -229,10 +229,9 @@ static Object _call_function(String fn, Array args, dict_T *self, Arena *arena,
   funcexe.fe_selfdict = self;
 
   TRY_WRAP(err, {
-    // call_func() retval is deceptive, ignore it.  Instead we set `msg_list`
+    // call_func() retval is deceptive, ignore it.  Instead TRY_WRAP sets `msg_list` to capture
-    // (see above) to capture abort-causing non-exception errors.
+    // abort-causing non-exception errors.
-    call_func(fn.data, (int)fn.size, &rettv, (int)args.size,
+    (void)call_func(fn.data, (int)fn.size, &rettv, (int)args.size, vim_args, &funcexe);
-              vim_args, &funcexe);
   });
 
   if (!ERROR_SET(err)) {
@@ -280,18 +279,23 @@ Object nvim_call_dict_function(Object dict, String fn, Array args, Arena *arena,
   typval_T rettv;
   bool mustfree = false;
   switch (dict.type) {
-  case kObjectTypeString:
+  case kObjectTypeString: {
+    int eval_ret;
     TRY_WRAP(err, {
-      eval0(dict.data.string.data, &rettv, NULL, &EVALARG_EVALUATE);
+        eval_ret = eval0(dict.data.string.data, &rettv, NULL, &EVALARG_EVALUATE);
         clear_evalarg(&EVALARG_EVALUATE, NULL);
       });
     if (ERROR_SET(err)) {
       return rv;
     }
+    if (eval_ret != OK) {
+      abort();  // Should not happen.
+    }
     // Evaluation of the string arg created a new dict or increased the
     // refcount of a dict. Not necessary for a RPC dict.
     mustfree = true;
     break;
+  }
   case kObjectTypeDict:
     object_to_vim(dict, &rettv, err);
     break;

src/nvim/terminal.c

@@ -641,9 +641,6 @@ bool terminal_enter(void)
   curwin->w_p_so = 0;
   curwin->w_p_siso = 0;
 
-  // Save the existing cursor entry since it may be modified by the application
-  cursorentry_T save_cursorentry = shape_table[SHAPE_IDX_TERM];
-
   // Update the cursor shape table and flush changes to the UI
   s->term->pending.cursor = true;
   refresh_cursor(s->term);
@@ -674,8 +671,8 @@ bool terminal_enter(void)
   RedrawingDisabled = s->save_rd;
   apply_autocmds(EVENT_TERMLEAVE, NULL, NULL, false, curbuf);
 
-  shape_table[SHAPE_IDX_TERM] = save_cursorentry;
+  // Restore the terminal cursor to what is set in 'guicursor'
-  ui_mode_info_set();
+  (void)parse_shape_opt(SHAPE_CURSOR);
 
   if (save_curwin == curwin->handle) {  // Else: window was closed.
     curwin->w_p_cul = save_w_p_cul;

test/functional/lua/snippet_spec.lua

@@ -309,4 +309,18 @@ describe('vim.snippet', function()
     feed('<Esc>O<cr><Tab>')
     eq({ '' }, buf_lines(0))
   end)
+
+  it('supports multiple snippet sessions', function()
+    test_expand_success({ 'func $1($3) {', '  $2', '}' }, { 'func () {', '  ', '}' })
+
+    feed('foo<Tab>')
+
+    test_expand_success({ 'var x = $1 + $2' }, { 'func foo() {', '  var x =  + ', '}' })
+
+    feed('a<Tab>b')
+
+    feed('<Tab><Tab>a, b')
+
+    eq({ 'func foo(a, b) {', '  var x = a + b', '}' }, buf_lines(0))
+  end)
 end)

test/functional/plugin/lsp_spec.lua

@@ -1854,6 +1854,20 @@ describe('LSP', function()
         end,
       }
     end)
+
+    it('vim.lsp.start when existing client has no workspace_folders', function()
+      exec_lua(create_server_definition)
+      eq(
+        { 2, 'foo', 'foo' },
+        exec_lua(function()
+          local server = _G._create_server()
+          vim.lsp.start { cmd = server.cmd, name = 'foo' }
+          vim.lsp.start { cmd = server.cmd, name = 'foo', root_dir = 'bar' }
+          local foos = vim.lsp.get_clients()
+          return { #foos, foos[1].name, foos[2].name }
+        end)
+      )
+    end)
   end)
 
   describe('parsing tests', function()

test/functional/plugin/man_spec.lua

@@ -21,13 +21,12 @@ local function get_search_history(name)
     local man = require('man')
     local res = {}
     --- @diagnostic disable-next-line:duplicate-set-field
-    man.find_path = function(sect, name0)
+    man._find_path = function(name0, sect)
       table.insert(res, { sect, name0 })
       return nil
     end
-    local ok, rv = pcall(man.open_page, -1, { tab = 0 }, args)
+    local err = man.open_page(-1, { tab = 0 }, args)
-    assert(not ok)
+    assert(err and err:match('no manual entry'))
-    assert(rv and rv:match('no manual entry'))
     return res
   end)
 end
@@ -225,7 +224,7 @@ describe(':Man', function()
     matches('^/.+', actual_file)
     local args = { nvim_prog, '--headless', '+:Man ' .. actual_file, '+q' }
     matches(
-      ('Error detected while processing command line:\r\n' .. 'man.lua: "no manual entry for %s"'):format(
+      ('Error detected while processing command line:\r\n' .. 'man.lua: no manual entry for %s'):format(
         pesc(actual_file)
       ),
       fn.system(args, { '' })
@@ -235,8 +234,8 @@ describe(':Man', function()
 
   it('tries variants with spaces, underscores #22503', function()
     eq({
-      { '', 'NAME WITH SPACES' },
+      { vim.NIL, 'NAME WITH SPACES' },
-      { '', 'NAME_WITH_SPACES' },
+      { vim.NIL, 'NAME_WITH_SPACES' },
     }, get_search_history('NAME WITH SPACES'))
     eq({
       { '3', 'some other man' },
@@ -255,8 +254,8 @@ describe(':Man', function()
       { 'n', 'some_other_man' },
     }, get_search_history('n some other man'))
     eq({
-      { '', '123some other man' },
+      { vim.NIL, '123some other man' },
-      { '', '123some_other_man' },
+      { vim.NIL, '123some_other_man' },
     }, get_search_history('123some other man'))
     eq({
       { '1', 'other_man' },
@@ -265,11 +264,10 @@ describe(':Man', function()
   end)
 
   it('can complete', function()
-    t.skip(t.is_os('mac') and t.is_arch('x86_64'), 'not supported on intel mac')
     eq(
       true,
       exec_lua(function()
-        return #require('man').man_complete('f', 'Man g') > 0
+        return #require('man').man_complete('f', 'Man f') > 0
       end)
     )
   end)

test/functional/terminal/cursor_spec.lua

@@ -15,9 +15,20 @@ local skip = t.skip
 describe(':terminal cursor', function()
   local screen
 
+  local terminal_mode_idx ---@type number
+
   before_each(function()
     clear()
     screen = tt.setup_screen()
+
+    if terminal_mode_idx == nil then
+      for i, v in ipairs(screen._mode_info) do
+        if v.name == 'terminal' then
+          terminal_mode_idx = i
+        end
+      end
+      assert(terminal_mode_idx)
+    end
   end)
 
   it('moves the screen cursor when focused', function()
@@ -143,13 +154,6 @@ describe(':terminal cursor', function()
 
   it('can be modified by application #3681', function()
     skip(is_os('win'), '#31587')
-    local idx ---@type number
-    for i, v in ipairs(screen._mode_info) do
-      if v.name == 'terminal' then
-        idx = i
-      end
-    end
-    assert(idx)
 
     local states = {
       [1] = { blink = true, shape = 'block' },
@@ -171,13 +175,13 @@ describe(':terminal cursor', function()
       ]],
         condition = function()
           if v.blink then
-            eq(500, screen._mode_info[idx].blinkon)
+            eq(500, screen._mode_info[terminal_mode_idx].blinkon)
-            eq(500, screen._mode_info[idx].blinkoff)
+            eq(500, screen._mode_info[terminal_mode_idx].blinkoff)
           else
-            eq(0, screen._mode_info[idx].blinkon)
+            eq(0, screen._mode_info[terminal_mode_idx].blinkon)
-            eq(0, screen._mode_info[idx].blinkoff)
+            eq(0, screen._mode_info[terminal_mode_idx].blinkoff)
           end
-          eq(v.shape, screen._mode_info[idx].cursor_shape)
+          eq(v.shape, screen._mode_info[terminal_mode_idx].cursor_shape)
         end,
       })
     end
@@ -191,20 +195,13 @@ describe(':terminal cursor', function()
     ]])
 
     -- Cursor returns to default on TermLeave
-    eq(500, screen._mode_info[idx].blinkon)
+    eq(500, screen._mode_info[terminal_mode_idx].blinkon)
-    eq(500, screen._mode_info[idx].blinkoff)
+    eq(500, screen._mode_info[terminal_mode_idx].blinkoff)
-    eq('block', screen._mode_info[idx].cursor_shape)
+    eq('block', screen._mode_info[terminal_mode_idx].cursor_shape)
   end)
 
   it('can be modified per terminal', function()
     skip(is_os('win'), '#31587')
-    local idx ---@type number
-    for i, v in ipairs(screen._mode_info) do
-      if v.name == 'terminal' then
-        idx = i
-      end
-    end
-    assert(idx)
 
     -- Set cursor to vertical bar with blink
     tt.feed_csi('5 q')
@@ -216,9 +213,9 @@ describe(':terminal cursor', function()
       {3:-- TERMINAL --}                                    |
     ]],
       condition = function()
-        eq(500, screen._mode_info[idx].blinkon)
+        eq(500, screen._mode_info[terminal_mode_idx].blinkon)
-        eq(500, screen._mode_info[idx].blinkoff)
+        eq(500, screen._mode_info[terminal_mode_idx].blinkoff)
-        eq('vertical', screen._mode_info[idx].cursor_shape)
+        eq('vertical', screen._mode_info[terminal_mode_idx].cursor_shape)
       end,
     })
 
@@ -231,9 +228,9 @@ describe(':terminal cursor', function()
       {3:-- TERMINAL --}                                    |
     ]],
       condition = function()
-        eq(500, screen._mode_info[idx].blinkon)
+        eq(500, screen._mode_info[terminal_mode_idx].blinkon)
-        eq(500, screen._mode_info[idx].blinkoff)
+        eq(500, screen._mode_info[terminal_mode_idx].blinkoff)
-        eq('vertical', screen._mode_info[idx].cursor_shape)
+        eq('vertical', screen._mode_info[terminal_mode_idx].cursor_shape)
       end,
     })
 
@@ -256,9 +253,9 @@ describe(':terminal cursor', function()
     ]],
       condition = function()
         -- New terminal, cursor resets to defaults
-        eq(500, screen._mode_info[idx].blinkon)
+        eq(500, screen._mode_info[terminal_mode_idx].blinkon)
-        eq(500, screen._mode_info[idx].blinkoff)
+        eq(500, screen._mode_info[terminal_mode_idx].blinkoff)
-        eq('block', screen._mode_info[idx].cursor_shape)
+        eq('block', screen._mode_info[terminal_mode_idx].cursor_shape)
       end,
     })
 
@@ -275,9 +272,9 @@ describe(':terminal cursor', function()
       {3:-- TERMINAL --}                                    |
     ]],
       condition = function()
-        eq(0, screen._mode_info[idx].blinkon)
+        eq(0, screen._mode_info[terminal_mode_idx].blinkon)
-        eq(0, screen._mode_info[idx].blinkoff)
+        eq(0, screen._mode_info[terminal_mode_idx].blinkoff)
-        eq('horizontal', screen._mode_info[idx].cursor_shape)
+        eq('horizontal', screen._mode_info[terminal_mode_idx].cursor_shape)
       end,
     })
 
@@ -294,9 +291,9 @@ describe(':terminal cursor', function()
       {3:-- TERMINAL --}                                    |
     ]],
       condition = function()
-        eq(500, screen._mode_info[idx].blinkon)
+        eq(500, screen._mode_info[terminal_mode_idx].blinkon)
-        eq(500, screen._mode_info[idx].blinkoff)
+        eq(500, screen._mode_info[terminal_mode_idx].blinkoff)
-        eq('vertical', screen._mode_info[idx].cursor_shape)
+        eq('vertical', screen._mode_info[terminal_mode_idx].cursor_shape)
       end,
     })
   end)
@@ -326,6 +323,32 @@ describe(':terminal cursor', function()
       {3:-- TERMINAL --}                                    |
     ]])
   end)
+
+  it('preserves guicursor value on TermLeave #31612', function()
+    eq(3, screen._mode_info[terminal_mode_idx].hl_id)
+
+    -- Change 'guicursor' while terminal mode is active
+    command('set guicursor+=t:Error')
+
+    local error_hl_id = call('hlID', 'Error')
+
+    screen:expect({
+      condition = function()
+        eq(error_hl_id, screen._mode_info[terminal_mode_idx].hl_id)
+      end,
+    })
+
+    -- Exit terminal mode
+    feed([[<C-\><C-N>]])
+
+    screen:expect([[
+      tty ready                                         |
+      ^                                                  |
+                                                        |*5
+    ]])
+
+    eq(error_hl_id, screen._mode_info[terminal_mode_idx].hl_id)
+  end)
 end)
 
 describe('buffer cursor position is correct in terminal without number column', function()